@azure/arm-recoveryservicesbackup 11.0.1-alpha.20231113.1 → 12.0.0

package/dist-esm/src/models/index.d.ts

@@ -17,6 +17,8 @@ export type WorkloadItemUnion = WorkloadItem | AzureVmWorkloadItemUnion;
 export type BackupRequestUnion = BackupRequest | AzureFileShareBackupRequest | AzureWorkloadBackupRequest | IaasVMBackupRequest;
 export type ILRRequestUnion = ILRRequest | AzureFileShareProvisionILRRequest | IaasVmilrRegistrationRequest;
 export type WorkloadProtectableItemUnion = WorkloadProtectableItem | AzureFileShareProtectableItem | IaaSVMProtectableItemUnion | AzureVmWorkloadProtectableItemUnion;
+export type FetchTieringCostInfoRequestUnion = FetchTieringCostInfoRequest | FetchTieringCostInfoForRehydrationRequest | FetchTieringCostSavingsInfoForPolicyRequest | FetchTieringCostSavingsInfoForProtectedItemRequest | FetchTieringCostSavingsInfoForVaultRequest;
+export type TieringCostInfoUnion = TieringCostInfo | TieringCostRehydrationInfo | TieringCostSavingInfo;
 export type SchedulePolicyUnion = SchedulePolicy | LogSchedulePolicy | LongTermSchedulePolicy | SimpleSchedulePolicy | SimpleSchedulePolicyV2;
 export type RetentionPolicyUnion = RetentionPolicy | LongTermRetentionPolicy | SimpleRetentionPolicy;
 export type AzureRecoveryServiceVaultProtectionIntentUnion = AzureRecoveryServiceVaultProtectionIntent | AzureWorkloadAutoProtectionIntentUnion;
@@ -190,6 +192,10 @@ export interface BackupStatusResponse {
     policyName?: string;
     /** Container registration status */
     registrationStatus?: string;
+    /** Number of protected items */
+    protectedItemsCount?: number;
+    /** Specifies whether the storage account lock has been acquired or not */
+    acquireStorageAccountLock?: AcquireStorageAccountLock;
 }
 /** Base class for feature request */
 export interface FeatureSupportRequest {
@@ -492,6 +498,11 @@ export interface ProtectedItem {
     policyName?: string;
     /** Soft delete retention period in days */
     softDeleteRetentionPeriodInDays?: number;
+    /**
+     * ID of the vault which protects this item
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly vaultId?: string;
 }
 /** Base class for backup copies. Workload-specific backup copies are derived from this class. */
 export interface RecoveryPoint {
@@ -546,6 +557,13 @@ export interface OperationWorkerResponse {
     };
 }
 /** Base class for validate operation request. */
+export interface ValidateOperationRequestResource {
+    /** Recovery point ID. */
+    id: string;
+    /** ValidateOperationRequestResource properties */
+    properties: ValidateOperationRequestUnion;
+}
+/** Base class for validate operation request. */
 export interface ValidateOperationRequest {
     /** Polymorphic discriminator, which specifies the different types this object can be */
     objectType: "ValidateRestoreOperationRequest" | "ValidateIaasVMRestoreOperationRequest";
@@ -719,7 +737,7 @@ export interface ListRecoveryPointsRecommendedForMoveRequest {
     excludedRPList?: string[];
 }
 export interface ResourceGuardProxyBase {
-    resourceGuardResourceId?: string;
+    resourceGuardResourceId: string;
     resourceGuardOperationDetails?: ResourceGuardOperationDetail[];
     lastUpdatedTime?: string;
     description?: string;
@@ -738,6 +756,23 @@ export interface UnlockDeleteResponse {
     /** This is the time when unlock delete privileges will get expired. */
     unlockDeleteExpiryTime?: string;
 }
+/**
+ * Base class for tiering cost request.
+ * Specific cost request types are derived from this class.
+ */
+export interface FetchTieringCostInfoRequest {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    objectType: "FetchTieringCostInfoForRehydrationRequest" | "FetchTieringCostSavingsInfoForPolicyRequest" | "FetchTieringCostSavingsInfoForProtectedItemRequest" | "FetchTieringCostSavingsInfoForVaultRequest";
+    /** Source tier for the request */
+    sourceTierType: RecoveryPointTierType;
+    /** target tier for the request */
+    targetTierType: RecoveryPointTierType;
+}
+/** Base class for tiering cost response */
+export interface TieringCostInfo {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    objectType: "TieringCostRehydrationInfo" | "TieringCostSavingInfo";
+}
 /** KPI Resource Health Details */
 export interface KPIResourceHealthDetails {
     /** Resource Health Status */
@@ -840,6 +875,8 @@ export interface SubProtectionPolicy {
     tieringPolicy?: {
         [propertyName: string]: TieringPolicy;
     };
+    /** Snapshot Backup related fields for WorkloadType SaPHanaSystem */
+    snapshotBackupAdditionalDetails?: SnapshotBackupAdditionalDetails;
 }
 /** Base class for backup schedule. */
 export interface SchedulePolicy {
@@ -874,6 +911,37 @@ export interface TieringPolicy {
      */
     durationType?: RetentionDurationType;
 }
+/** Snapshot Backup related fields for WorkloadType SaPHanaSystem */
+export interface SnapshotBackupAdditionalDetails {
+    instantRpRetentionRangeInDays?: number;
+    instantRPDetails?: string;
+    userAssignedManagedIdentityDetails?: UserAssignedManagedIdentityDetails;
+}
+export interface UserAssignedManagedIdentityDetails {
+    identityArmId?: string;
+    identityName?: string;
+    /** User assigned identity properties */
+    userAssignedIdentityProperties?: UserAssignedIdentity;
+}
+/** User assigned identity properties */
+export interface UserAssignedIdentity {
+    /**
+     * The principal ID of the assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The client ID of the assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly clientId?: string;
+}
+/** Vault retention policy for AzureFileShare */
+export interface VaultRetentionPolicy {
+    /** Base class for retention policy. */
+    vaultRetention: RetentionPolicyUnion;
+    snapshotRetentionInDays: number;
+}
 /** Additional information on Azure IaaS VM specific backup item. */
 export interface AzureIaaSVMProtectedItemExtendedInfo {
     /** The oldest backup copy available for this backup item across all tiers. */
@@ -1101,6 +1169,11 @@ export interface TargetRestoreInfo {
     /** Target directory location for restore as files. */
     targetDirectoryForFileRestore?: string;
 }
+/** Encapsulates information regarding snapshot recovery for SAP Hana */
+export interface SnapshotRestoreParameters {
+    skipAttachAndMount?: boolean;
+    logPointInTimeForDBRecovery?: string;
+}
 /** Extended info class details */
 export interface AzureWorkloadSQLRecoveryPointExtendedInfo {
     /** UTC time at which data directory info was captured */
@@ -2220,6 +2293,11 @@ export interface IaasVMRecoveryPoint extends RecoveryPoint {
     recoveryPointProperties?: RecoveryPointProperties;
     /** This flag denotes if any of the disks in the VM are using Private access network setting */
     isPrivateAccessEnabledOnAnyDisk?: boolean;
+    /**
+     * Extended location of the VM recovery point,
+     * should be null if VM is in public cloud
+     */
+    extendedLocation?: ExtendedLocation;
 }
 /** AzureFileShare Restore Request */
 export interface AzureFileShareRestoreRequest extends RestoreRequest {
@@ -2254,6 +2332,18 @@ export interface AzureWorkloadRestoreRequest extends RestoreRequest {
     targetInfo?: TargetRestoreInfo;
     /** Defines whether the current recovery mode is file restore or database restore */
     recoveryMode?: RecoveryMode;
+    /** Defines the Resource group of the Target VM */
+    targetResourceGroupName?: string;
+    /**
+     * User Assigned managed identity details
+     * Currently used for snapshot.
+     */
+    userAssignedManagedIdentityDetails?: UserAssignedManagedIdentityDetails;
+    /**
+     * Additional details for snapshot recovery
+     * Currently used for snapshot for SAP Hana.
+     */
+    snapshotRestoreParameters?: SnapshotRestoreParameters;
     /**
      * This is the complete ARM Id of the target VM
      * For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
@@ -2356,6 +2446,8 @@ export interface AzureFileShareProtectionPolicy extends ProtectionPolicy {
     schedulePolicy?: SchedulePolicyUnion;
     /** Retention policy with the details on backup copy retention ranges. */
     retentionPolicy?: RetentionPolicyUnion;
+    /** Retention policy with the details on hardened backup copy retention ranges. */
+    vaultRetentionPolicy?: VaultRetentionPolicy;
     /** TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time". */
     timeZone?: string;
 }
@@ -2789,6 +2881,62 @@ export interface AzureVmWorkloadProtectableItem extends WorkloadProtectableItem
     /** Indicates if item is protectable */
     isProtectable?: boolean;
 }
+/** Request parameters for fetching cost info of rehydration */
+export interface FetchTieringCostInfoForRehydrationRequest extends FetchTieringCostInfoRequest {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    objectType: "FetchTieringCostInfoForRehydrationRequest";
+    /** Name of the protected item container */
+    containerName: string;
+    /** Name of the protectedItemName */
+    protectedItemName: string;
+    /** ID of the backup copy for rehydration cost info needs to be fetched. */
+    recoveryPointId: string;
+    /** Rehydration Priority */
+    rehydrationPriority: RehydrationPriority;
+}
+/** Request parameters for tiering cost info for policy */
+export interface FetchTieringCostSavingsInfoForPolicyRequest extends FetchTieringCostInfoRequest {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    objectType: "FetchTieringCostSavingsInfoForPolicyRequest";
+    /** Name of the backup policy for which the cost savings information is requested */
+    policyName: string;
+}
+/** Request parameters for tiering cost info for protected item */
+export interface FetchTieringCostSavingsInfoForProtectedItemRequest extends FetchTieringCostInfoRequest {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    objectType: "FetchTieringCostSavingsInfoForProtectedItemRequest";
+    /** Name of the protected item container */
+    containerName: string;
+    /** Name of the protectedItemName */
+    protectedItemName: string;
+}
+/** Request parameters for tiering cost info for vault */
+export interface FetchTieringCostSavingsInfoForVaultRequest extends FetchTieringCostInfoRequest {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    objectType: "FetchTieringCostSavingsInfoForVaultRequest";
+}
+/** Response parameters for tiering cost info for rehydration */
+export interface TieringCostRehydrationInfo extends TieringCostInfo {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    objectType: "TieringCostRehydrationInfo";
+    /** Rehydration size in bytes */
+    rehydrationSizeInBytes: number;
+    /** Source tier to target tier rehydration cost per GB per month */
+    retailRehydrationCostPerGBPerMonth: number;
+}
+/** Response parameters for tiering cost info for savings */
+export interface TieringCostSavingInfo extends TieringCostInfo {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    objectType: "TieringCostSavingInfo";
+    /** Source tier size reduction in bytes after moving all the recommended backup points to target tier */
+    sourceTierSizeReductionInBytes: number;
+    /** Target tier size increase in bytes after moving all the recommended backup points to target tier */
+    targetTierSizeIncreaseInBytes: number;
+    /** Source tier retail cost per GB per month */
+    retailSourceTierCostPerGBPerMonth: number;
+    /** Target tier retail cost per GB per month */
+    retailTargetTierCostPerGBPerMonth: number;
+}
 /** Azure IaaS VM workload-specific Health Details. */
 export interface AzureIaaSVMHealthDetails extends ResourceHealthDetails {
 }
@@ -3118,6 +3266,10 @@ export interface AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest extends
     /** RP Rehydration Info */
     recoveryPointRehydrationInfo?: RecoveryPointRehydrationInfo;
 }
+/** Defines headers for FetchTieringCost_post operation. */
+export interface FetchTieringCostPostHeaders {
+    location?: string;
+}
 /** Known values of {@link StorageType} that the service accepts. */
 export declare enum KnownStorageType {
     /** Invalid */
@@ -3318,6 +3470,22 @@ export declare enum KnownFabricName {
  * **Azure**
  */
 export type FabricName = string;
+/** Known values of {@link AcquireStorageAccountLock} that the service accepts. */
+export declare enum KnownAcquireStorageAccountLock {
+    /** Acquire */
+    Acquire = "Acquire",
+    /** NotAcquire */
+    NotAcquire = "NotAcquire"
+}
+/**
+ * Defines values for AcquireStorageAccountLock. \
+ * {@link KnownAcquireStorageAccountLock} can be used interchangeably with AcquireStorageAccountLock,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Acquire** \
+ * **NotAcquire**
+ */
+export type AcquireStorageAccountLock = string;
 /** Known values of {@link SupportStatus} that the service accepts. */
 export declare enum KnownSupportStatus {
     /** Invalid */
@@ -4137,7 +4305,13 @@ export declare enum KnownRecoveryMode {
     /** FileRecovery */
     FileRecovery = "FileRecovery",
     /** WorkloadRecovery */
-    WorkloadRecovery = "WorkloadRecovery"
+    WorkloadRecovery = "WorkloadRecovery",
+    /** SnapshotAttach */
+    SnapshotAttach = "SnapshotAttach",
+    /** RecoveryUsingSnapshot */
+    RecoveryUsingSnapshot = "RecoveryUsingSnapshot",
+    /** SnapshotAttachAndRecover */
+    SnapshotAttachAndRecover = "SnapshotAttachAndRecover"
 }
 /**
  * Defines values for RecoveryMode. \
@@ -4146,7 +4320,10 @@ export declare enum KnownRecoveryMode {
  * ### Known values supported by the service
  * **Invalid** \
  * **FileRecovery** \
- * **WorkloadRecovery**
+ * **WorkloadRecovery** \
+ * **SnapshotAttach** \
+ * **RecoveryUsingSnapshot** \
+ * **SnapshotAttachAndRecover**
  */
 export type RecoveryMode = string;
 /** Known values of {@link SQLDataDirectoryType} that the service accepts. */
@@ -4435,22 +4612,6 @@ export declare enum KnownOperationType {
  * **Reregister**
  */
 export type OperationType = string;
-/** Known values of {@link AcquireStorageAccountLock} that the service accepts. */
-export declare enum KnownAcquireStorageAccountLock {
-    /** Acquire */
-    Acquire = "Acquire",
-    /** NotAcquire */
-    NotAcquire = "NotAcquire"
-}
-/**
- * Defines values for AcquireStorageAccountLock. \
- * {@link KnownAcquireStorageAccountLock} can be used interchangeably with AcquireStorageAccountLock,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **Acquire** \
- * **NotAcquire**
- */
-export type AcquireStorageAccountLock = string;
 /** Known values of {@link InquiryStatus} that the service accepts. */
 export declare enum KnownInquiryStatus {
     /** Invalid */
@@ -5074,6 +5235,10 @@ export interface ProtectionContainersGetOptionalParams extends coreClient.Operat
 export type ProtectionContainersGetResponse = ProtectionContainerResource;
 /** Optional parameters. */
 export interface ProtectionContainersRegisterOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
 }
 /** Contains response data for the register operation. */
 export type ProtectionContainersRegisterResponse = ProtectionContainerResource;
@@ -5220,6 +5385,25 @@ export interface ResourceGuardProxyUnlockDeleteOptionalParams extends coreClient
 /** Contains response data for the unlockDelete operation. */
 export type ResourceGuardProxyUnlockDeleteResponse = UnlockDeleteResponse;
 /** Optional parameters. */
+export interface FetchTieringCostPostOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+/** Contains response data for the post operation. */
+export type FetchTieringCostPostResponse = TieringCostInfoUnion;
+/** Optional parameters. */
+export interface GetTieringCostOperationResultGetOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the get operation. */
+export type GetTieringCostOperationResultGetResponse = TieringCostInfoUnion;
+/** Optional parameters. */
+export interface TieringCostOperationStatusGetOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the get operation. */
+export type TieringCostOperationStatusGetResponse = OperationStatus;
+/** Optional parameters. */
 export interface RecoveryServicesBackupClientOptionalParams extends coreClient.ServiceClientOptions {
     /** server parameter */
     $host?: string;