Azure.ResourceManager.RecoveryServicesBackup.Models Namespace

A factory class for creating instances of the models for mocking.

Common settings field for backup management.

Base class for backup request. Workload-specific backup requests are derived from this class. Please note this is the abstract base class. The derived classes available for instantiation are: FileShareBackupContent, WorkloadBackupContent, and IaasVmBackupContent.

Database included in RP.

Day of the week.

Additional information on backup engine.

Error Detail class which encapsulates Code, Message and Recommendations.

The base backup engine class. All workload specific backup engines derive from this class. Please note this is the abstract base class. The derived classes available for instantiation are: BackupServerEngine and DpmBackupEngine.

Defines workload agnostic properties for a job. Please note this is the abstract base class. The derived classes available for instantiation are: IaasVmBackupJob, IaasVmBackupJobV2, StorageBackupJob, WorkloadBackupJob, DpmBackupJob, MabBackupJob, and VaultBackupJob.

Base class for backup items. Please note this is the abstract base class. The derived classes available for instantiation are: FileshareProtectedItem, IaasClassicComputeVmProtectedItem, IaasVmProtectedItem, IaasComputeVmProtectedItem, SqlProtectedItem, VmWorkloadProtectedItem, VmWorkloadSapAseDatabaseProtectedItem, VmWorkloadSapHanaDatabaseProtectedItem, VmWorkloadSapHanaDBInstanceProtectedItem, VmWorkloadSqlDatabaseProtectedItem, VmWorkloadSqlInstanceProtectedItem, DpmProtectedItem, GenericProtectedItem, and MabFileFolderProtectedItem.

Base class for container with backup items. Containers with specific workloads are derived from this class. Please note this is the abstract base class. The derived classes available for instantiation are: BackupServerContainer, DpmContainer, IaasClassicComputeVmContainer, IaasVmContainer, IaasComputeVmContainer, SqlAvailabilityGroupWorkloadProtectionContainer, WorkloadContainer, SqlContainer, StorageContainer, VmAppContainerProtectionContainer, GenericContainer, and MabContainer.

Base class for backup ProtectionIntent. Please note this is the abstract base class. The derived classes available for instantiation are: RecoveryServiceVaultProtectionIntent, ResourceProtectionIntent, WorkloadContainerAutoProtectionIntent, WorkloadAutoProtectionIntent, and WorkloadSqlAutoProtectionIntent.

Base class for backup policy. Workload-specific backup policies are derived from this class. Please note this is the abstract base class. The derived classes available for instantiation are: VmWorkloadProtectionPolicy, FileShareProtectionPolicy, IaasVmProtectionPolicy, SqlProtectionPolicy, GenericProtectionPolicy, and MabProtectionPolicy.

Base class for backup copies. Workload-specific backup copies are derived from this class. Please note this is the abstract base class. The derived classes available for instantiation are: FileShareRecoveryPoint, WorkloadPointInTimeRecoveryPoint, WorkloadRecoveryPoint, WorkloadSapHanaPointInTimeRecoveryPoint, WorkloadSapHanaRecoveryPoint, WorkloadSapAsePointInTimeRecoveryPoint, WorkloadSapAseRecoveryPoint, WorkloadSqlPointInTimeRecoveryPoint, WorkloadSqlRecoveryPoint, GenericRecoveryPoint, and IaasVmRecoveryPoint.

Azure backup goal feature specific request.

The BackupHourlySchedule.

Encapsulates Managed Identity related information.

Backup management usages of a vault.

The name of usage.

Private Endpoint Connection Response Properties.

Patch Request content to update recovery point for given RecoveryPointId.

The resource storage details.

The BackupResourceEncryptionConfig.

The BackupResourceEncryptionConfigExtendedCreateOrUpdateContent.

The BackupResourceEncryptionConfigExtendedProperties.

Backup resource vault config details.

Base class for retention policy. Please note this is the abstract base class. The derived classes available for instantiation are: LongTermRetentionPolicy and SimpleRetentionPolicy.

Base class for backup schedule. Please note this is the abstract base class. The derived classes available for instantiation are: LogSchedulePolicy, LongTermSchedulePolicy, SimpleSchedulePolicy, and SimpleSchedulePolicyV2.

AzureBackupServer (DPMVenus) workload-specific protection container.

Backup engine type when Azure Backup Server is used to manage the backups.

Source side threat information.

BackupStatus request.

BackupStatus response.

Specifies target network access settings for disks of VM to be restored.

Recovery Point Threat information.

Tiering Policy for a target tier. If the policy is not specified for a given target tier, service retains the existing configured tiering policy for that tier

The BackupWeeklySchedule.

BEK is bitlocker encryption key.

Container identity information.

Daily retention schedule.

The DiskExclusionProperties.

Disk information.

This is used to represent the various nodes of the distributed container.

Data Protection Manager (DPM) specific backup engine.

DPM workload-specific job object.

Additional information on the DPM workload-specific job.

DPM workload-specific job task details.

DPM workload-specific protection container.

DPM workload-specific error information.

Additional information on Backup engine specific backup item.

Additional information of DPM Protected item.

Base class for feature request Please note this is the abstract base class. The derived classes available for instantiation are: BackupGoalFeatureSupportContent and VmResourceFeatureSupportContent.

Base class for tiering cost request. Specific cost request types are derived from this class. Please note this is the abstract base class. The derived classes available for instantiation are: FetchTieringCostInfoForRehydrationContent, FetchTieringCostSavingsInfoForPolicyContent, FetchTieringCostSavingsInfoForProtectedItemContent, and FetchTieringCostSavingsInfoForVaultContent.

Request parameters for fetching cost info of rehydration.

Request parameters for tiering cost info for policy.

Request parameters for tiering cost info for protected item.

Request parameters for tiering cost info for vault.

AzureFileShare workload-specific backup request.

Protectable item for Azure Fileshare workloads.

Azure File Share workload-specific backup item.

Additional information about Azure File Share backup item.

AzureStorage backup policy.

Update snapshot Uri with the correct friendly Name of the source Azure file share.

Azure File Share workload specific backup copy.

AzureFileShare Restore Request.

Base class for generic container of backup items.

Container extended information.

Base class for backup items.

Azure VM (Mercury) workload-specific backup policy.

Generic backup copy.

IaaS VM workload-specific backup item representing a classic virtual machine.

IaaS VM workload-specific backup item representing the Classic Compute VM.

IaaS VM workload-specific backup item representing the Classic Compute VM.

IaaS VM workload-specific backup item representing an Azure Resource Manager virtual machine.

IaaS VM workload-specific backup item representing the Azure Resource Manager VM.

IaaS VM workload-specific backup item representing the Azure Resource Manager VM.

IaaS VM workload-specific backup request.

Extended Properties for Azure IaasVM Backup.

Azure IaaS VM workload-specific job object.

Azure IaaS VM workload-specific additional information for job.

Azure IaaS VM workload-specific job task details.

Azure IaaS VM workload-specific job object.

IaaS VM workload-specific container.

Azure IaaS VM workload-specific error information.

Azure IaaS VM workload-specific Health Details.

Restore files/folders from a backup copy of IaaS VM.

IaaS VM workload-specific backup item.

IaaS VM workload-specific backup item.

Additional information on Azure IaaS VM specific backup item.

IaaS VM workload-specific backup policy.

IaaS VM workload specific backup copy.

IaaS VM workload-specific restore.

IaaS VM workload-specific restore with integrated rehydration of recovery point.

IaaS VM workload specific restore details for restores using managed identity.

Parameters to Provision ILR API. Please note this is the abstract base class. The derived classes available for instantiation are: FileShareProvisionIlrContent and IaasVmIlrRegistrationContent.

Validation for inquired protectable items under a given container.

The InstantRPAdditionalDetails.

KEK is encryption key for BEK.

BEK is bitlocker key. KEK is encryption key for BEK If the VM was encrypted then we will store following details :

1. Secret(BEK) - Url + Backup Data + vaultId.
2. Key(KEK) - Url + Backup Data + vaultId.
3. EncryptionMechanism

KPI Resource Health Details.

Log policy schedule.

Long term retention policy.

Long term policy schedule.

MAB workload-specific job.

Additional information for the MAB workload-specific job.

MAB workload-specific job task details.

Container with items backed up using MAB backup engine.

Additional information of the container.

MAB workload-specific Health Details.

MAB workload-specific error information.

MAB workload-specific backup item.

Additional information on the backed up item.

Mab container-specific backup policy.

Monthly retention schedule.

The MoveRPAcrossTiersContent.

Provides details for log ranges.

Pre-backup validation for Azure VM Workload provider.

Prepare DataMove Request.

Contract to validate if backup can be enabled on the given resource in a given vault and given configuration. It will validate followings

1. Vault capacity
2. VM is already protected
3. Any VM related configuration passed in properties.

Response contract for enable backup validation request.

Protectable Container Class. Please note this is the abstract base class. The derived classes available for instantiation are: StorageProtectableContainer and VmAppContainerProtectableContainer.

Protectable Container Class.

Parameters to Provision ILR API.

Disk configuration.

The RecoveryPointMoveReadinessInfo.

Properties of Recovery Point.

RP Rehydration Info.

ListRecoveryPointsRecommendedForMoveRequest Request.

Recovery point tier information.

RecoveryPoint Tier Information V2.

Private Link Service Connection State.

Azure Recovery Services Vault specific protection intent item.

The ResourceGuardOperationDetail.

The ResourceGuardProxyProperties.

Health Details for backup items.

IaaS VM specific backup protection intent item.

Base class for restore request. Workload-specific restore requests are derived from this class. Please note this is the abstract base class. The derived classes available for instantiation are: FileShareRestoreContent, WorkloadPointInTimeRestoreContent, WorkloadRestoreContent, WorkloadSapHanaPointInTimeRestoreContent, WorkloadSapHanaRestoreContent, WorkloadSapAsePointInTimeRestoreContent, WorkloadSapAseRestoreContent, WorkloadSqlPointInTimeRestoreContent, WorkloadSqlRestoreContent, IaasVmRestoreContent, WorkloadSapHanaPointInTimeRestoreWithRehydrateContent, WorkloadSapHanaRestoreWithRehydrateContent, WorkloadSqlPointInTimeRestoreWithRehydrateContent, WorkloadSqlRestoreWithRehydrateContent, and IaasVmRestoreWithRehydrationContent.

Restore file specs like file path, type and target folder path info.

Retention duration.

Base class for get security pin request body.

Simple policy retention.

Simple policy schedule.

The V2 policy schedule for IaaS that supports hourly backups.

Snapshot Backup related fields for WorkloadType SaPHanaSystem.

Encapsulates information regarding snapshot recovery for SAP Hana.

Container for SQL workloads under SQL Availability Group.

Azure Sql workload-specific container.

SQLDataDirectory info.

Encapsulates information regarding data directory.

Azure SQL workload-specific backup item.

Additional information on Azure Sql specific protected item.

Azure SQL workload-specific backup policy.

Azure storage specific job.

Azure Storage workload-specific additional information for job.

Azure storage workload specific job task details.

Azure Storage Account workload-specific container.

Azure storage specific error information.

Azure Storage-specific protectable containers.

Sub-protection policy which includes schedule and retention.

Target Azure File Share Info.

Details about target workload during restore operation.

Base class for tiering cost response Please note this is the abstract base class. The derived classes available for instantiation are: TieringCostRehydrationInfo and TieringCostSavingInfo.

Response parameters for tiering cost info for rehydration.

Response parameters for tiering cost info for savings.

The token information details.

Base class for backup request. Workload-specific backup requests are derived from this class.

Trigger DataMove Request.

Base class for restore request. Workload-specific restore requests are derived from this class.

Request body of unlock delete API.

Response of Unlock Delete API.

User assigned managed identity details.

Vault level Job.

Vault Job specific error information.

Vault retention policy for AzureFileShare.

Azure workload-specific container.

Container for SQL workloads under Azure Virtual Machines.

Details needed if the VM was encrypted at the time of backup.

AzureResource(IaaS VM) Specific feature support request.

Response for feature support requests for Azure IaasVm.

Azure VM workload-specific workload item.

Azure VM workload-specific protectable item.

Azure VM workload-specific protected item.

Additional information on Azure Workload for SQL specific backup item.

Azure VM (Mercury) workload-specific backup policy.

Azure VM workload-specific protectable item representing SAP ASE Database.

Azure VM workload-specific protected item representing SAP ASE Database.

Azure VM workload-specific workload item representing SAP ASE Database.

Azure VM workload-specific protectable item representing SAP ASE System.

Azure VM workload-specific workload item representing SAP ASE System.

Azure VM workload-specific protectable item representing SAP HANA Database.

Azure VM workload-specific protected item representing SAP HANA Database.

Azure VM workload-specific workload item representing SAP HANA Database.

Azure VM workload-specific protectable item representing SAP HANA Dbinstance.

Azure VM workload-specific protected item representing SAP HANA DBInstance.

Azure VM workload-specific protectable item representing HANA HSR.

Azure VM workload-specific protectable item representing HANA scale out.

Azure VM workload-specific protectable item representing SAP HANA System.

Azure VM workload-specific workload item representing SAP HANA System.

Azure VM workload-specific protectable item representing SQL Availability Group.

Azure VM workload-specific protectable item representing SQL Database.

Azure VM workload-specific protected item representing SQL Database.

Azure VM workload-specific workload item representing SQL Database.

Azure VM workload-specific protectable item representing SQL Instance.

Azure VM workload-specific protected item representing SQL Instance.

Azure VM workload-specific workload item representing SQL Instance.

Weekly retention format.

Weekly retention schedule.

Azure Recovery Services Vault specific protection intent item.

AzureWorkload workload-specific backup request.

Azure storage specific job.

Azure VM workload-specific additional information for job.

Azure VM workload specific job task details.

Container for the workloads running inside Azure Compute or Classic Compute.

Azure workload specific protection intent item.

Extended information of the container.

Details about inquired protectable items under a given container.

Azure storage specific error information.

Details of an inquired protectable item.

Base class for backup item. Workload-specific backup items are derived from this class. Please note this is the abstract base class. The derived classes available for instantiation are: VmWorkloadItem, VmWorkloadSapAseDatabaseWorkloadItem, VmWorkloadSapAseSystemWorkloadItem, VmWorkloadSapHanaDatabaseWorkloadItem, VmWorkloadSapHanaSystemWorkloadItem, VmWorkloadSqlDatabaseWorkloadItem, and VmWorkloadSqlInstanceWorkloadItem.

Base class for backup item. Workload-specific backup items are derived from this class.

Recovery point specific to PointInTime.

AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore.

Base class for backup item. Workload-specific backup items are derived from this class. Please note this is the abstract base class. The derived classes available for instantiation are: FileShareProtectableItem, IaasClassicComputeVmProtectableItem, IaasVmProtectableItem, IaasComputeVmProtectableItem, VmWorkloadProtectableItem, VmWorkloadSapAseDatabaseProtectableItem, VmWorkloadSapAseSystemProtectableItem, VmWorkloadSapHanaDatabaseProtectableItem, VmWorkloadSapHanaSystemProtectableItem, VmWorkloadSapHanaDBInstance, VmWorkloadSapHanaHsrProtectableItem, VmWorkloadSapHanaScaleoutProtectableItem, VmWorkloadSqlAvailabilityGroupProtectableItem, VmWorkloadSqlDatabaseProtectableItem, and VmWorkloadSqlInstanceProtectableItem.

Base class for backup item. Workload-specific backup items are derived from this class.

Workload specific recovery point, specifically encapsulates full/diff recovery point.

AzureWorkload-specific restore.

Recovery point specific to PointInTime in SAPAse.

AzureWorkload SAP Ase-specific restore. Specifically for PointInTime/Log restore.

SAPAse specific recoverypoint, specifically encapsulates full/diff recoverypoints.

AzureWorkload SAP Ase-specific restore.

Recovery point specific to PointInTime in SAPHana.

AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore.

AzureWorkload SAP Hana-specific restore with integrated rehydration of recovery point.

SAPHana specific recoverypoint, specifically encapsulates full/diff recoverypoints.

AzureWorkload SAP Hana-specific restore.

AzureWorkload SAP Hana-specific restore with integrated rehydration of recovery point.

Azure Workload SQL Auto Protection intent item.

Recovery point specific to PointInTime.

AzureWorkload SQL -specific restore. Specifically for PointInTime/Log restore.

AzureWorkload SQL-specific restore with integrated rehydration of recovery point.

SQL specific recoverypoint, specifically encapsulates full/diff recoverypoint along with extended info.

Extended info class details.

AzureWorkload SQL -specific restore. Specifically for full/diff restore.

AzureWorkload SQL-specific restore with integrated rehydration of recovery point.

Yearly retention schedule.

Whether storage account lock is to be acquired for this container or not.

Create mode to indicate recovery of existing soft deleted data source or creation of new data source.

Type of workload this item represents.

Encryption At Rest Type.

Specifies the fabric name - Azure or AD.

File Share type XSync or XSMB.

The state of instance protection.

Type of backup items associated with this container.

Backup management type to execute the current job.

Gets or sets provisioning state of the private endpoint connection.

Protection type in case protected as part of a parent.

Backup state of this backup item.

Specifies whether the container is registered or not.

Threat status of the container.

Threat summary for the container.

Storage type.

Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked.

Threat Severity Types.

Threat Status Types.

Threat status of the recovery point.

Type of backup, viz. Full, Differential, Log or CopyOnlyFull.

Unit of the usage.

Validation Status.

Type of workload for the backup management.

DataMove Level.

Enabled or Disabled.

Options to resolve copy conflicts.

Type of this recovery.

Restore Type (FullShareRestore or ItemLevelRestore).

Health status of protected item.

Status of protectable item, i.e. InProgress,Succeeded,Failed.

Last backup operation status. Possible values: Healthy, Unhealthy.

Server type of MAB container.

Gets or sets the status.

Backup state of the backed up item.

Defines whether the current recovery mode is file restore or database restore.

Rehydration Priority.

Resource Health Status.

Can Overwrite if Target DataBase already exists.

Type of restore point.

Retention duration type of retention policy.

Retention schedule format type for monthly retention policy.

Frequency of the schedule operation of this policy.

Soft Delete feature state.

Type of data directory mapping.

Type of backup policy type.

Tiering Mode to control automatic tiering of recovery points. Supported values are:

1. TierRecommended: Tier all recovery points recommended to be tiered
2. TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below.
3. DoNotTier: Do not tier any recovery points

Vault Dedup state.

GroupId for the PrivateEndpointConnection - AzureBackup, AzureBackup_secondary or AzureSiteRecovery.

Vault x-cool state.

Support status of feature.

Type of the protection policy.

Health status of the backup item, evaluated based on last heartbeat received.

Workload item type of the item for which intent is to be set.

Re-Do Operation.

Network access settings to be used for restored disks.

Recovery point tier status.

Recovery point tier type.