Azure.ResourceManager.RecoveryServicesBackup.Models Namespace

Classes

ArmRecoveryServicesBackupModelFactory

Model factory for models.

BackupCommonSettings

Common settings field for backup management.

BackupContent

Base class for backup request. Workload-specific backup requests are derived from this class. Please note BackupContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include FileShareBackupContent, WorkloadBackupContent and IaasVmBackupContent.

BackupDay

Day of the week.

BackupEngineExtendedInfo

Additional information on backup engine.

BackupErrorDetail

Error Detail class which encapsulates Code, Message and Recommendations.

BackupGenericEngine

The base backup engine class. All workload specific backup engines derive from this class. Please note BackupGenericEngine is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BackupServerEngine and DpmBackupEngine.

BackupGenericJob

Defines workload agnostic properties for a job. Please note BackupGenericJob is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include IaasVmBackupJob, IaasVmBackupJobV2, StorageBackupJob, WorkloadBackupJob, DpmBackupJob, MabBackupJob and VaultBackupJob.

BackupGenericProtectedItem

Base class for backup items. Please note BackupGenericProtectedItem is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include FileshareProtectedItem, IaasVmProtectedItem, VmWorkloadProtectedItem, VmWorkloadSapAseDatabaseProtectedItem, VmWorkloadSapHanaDBInstanceProtectedItem, VmWorkloadSapHanaDatabaseProtectedItem, VmWorkloadSqlDatabaseProtectedItem, DpmProtectedItem, GenericProtectedItem, MabFileFolderProtectedItem, IaasClassicComputeVmProtectedItem, IaasComputeVmProtectedItem and SqlProtectedItem.

BackupGenericProtectionContainer

Base class for container with backup items. Containers with specific workloads are derived from this class. Please note BackupGenericProtectionContainer is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BackupServerContainer, SqlContainer, WorkloadContainer, DpmContainer, GenericContainer, IaasVmContainer, IaasClassicComputeVmContainer, IaasComputeVmContainer, SqlAvailabilityGroupWorkloadProtectionContainer, StorageContainer, VmAppContainerProtectionContainer and MabContainer.

BackupGenericProtectionIntent

Base class for backup ProtectionIntent. Please note BackupGenericProtectionIntent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ResourceProtectionIntent, WorkloadAutoProtectionIntent, WorkloadContainerAutoProtectionIntent, WorkloadSqlAutoProtectionIntent and RecoveryServiceVaultProtectionIntent.

BackupGenericProtectionPolicy

Base class for backup policy. Workload-specific backup policies are derived from this class. Please note BackupGenericProtectionPolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include IaasVmProtectionPolicy, SqlProtectionPolicy, FileShareProtectionPolicy, VmWorkloadProtectionPolicy, GenericProtectionPolicy and MabProtectionPolicy.

BackupGenericRecoveryPoint

Base class for backup copies. Workload-specific backup copies are derived from this class. Please note BackupGenericRecoveryPoint is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include FileShareRecoveryPoint, WorkloadPointInTimeRecoveryPoint, WorkloadRecoveryPoint, WorkloadSapHanaPointInTimeRecoveryPoint, WorkloadSapHanaRecoveryPoint, WorkloadSqlPointInTimeRecoveryPoint, WorkloadSqlRecoveryPoint, GenericRecoveryPoint and IaasVmRecoveryPoint.

BackupGoalFeatureSupportContent

Azure backup goal feature specific request.

BackupHourlySchedule

The BackupHourlySchedule.

BackupIdentityInfo

Encapsulates Managed Identity related information.

BackupManagementUsage

Backup management usages of a vault.

BackupNameInfo

The name of usage.

BackupPrivateEndpointConnectionProperties

Private Endpoint Connection Response Properties.

BackupResourceConfigProperties

The resource storage details.

BackupResourceEncryptionConfig

The BackupResourceEncryptionConfig.

BackupResourceEncryptionConfigExtendedCreateOrUpdateContent

The BackupResourceEncryptionConfigExtendedCreateOrUpdateContent.

BackupResourceEncryptionConfigExtendedProperties

The BackupResourceEncryptionConfigExtendedProperties.

BackupResourceVaultConfigProperties

Backup resource vault config details.

BackupRetentionPolicy

Base class for retention policy. Please note BackupRetentionPolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include LongTermRetentionPolicy and SimpleRetentionPolicy.

BackupSchedulePolicy

Base class for backup schedule. Please note BackupSchedulePolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include LogSchedulePolicy, LongTermSchedulePolicy, SimpleSchedulePolicy and SimpleSchedulePolicyV2.

BackupServerContainer

AzureBackupServer (DPMVenus) workload-specific protection container.

BackupServerEngine

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

BackupStatusContent

BackupStatus request.

BackupStatusResult

BackupStatus response.

BackupTargetDiskNetworkAccessSettings

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

BackupTieringPolicy

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

BackupWeeklySchedule

The BackupWeeklySchedule.

BekDetails

BEK is bitlocker encryption key.

ContainerIdentityInfo

Container identity information.

DailyRetentionSchedule

Daily retention schedule.

DiskExclusionProperties

The DiskExclusionProperties.

DiskInformation

Disk information.

DistributedNodesInfo

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

DpmBackupEngine

Data Protection Manager (DPM) specific backup engine.

DpmBackupJob

DPM workload-specific job object.

DpmBackupJobExtendedInfo

Additional information on the DPM workload-specific job.

DpmBackupJobTaskDetails

DPM workload-specific job task details.

DpmContainer

DPM workload-specific protection container. Please note DpmContainer is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BackupServerContainer.

DpmErrorInfo

DPM workload-specific error information.

DpmProtectedItem

Additional information on Backup engine specific backup item.

DpmProtectedItemExtendedInfo

Additional information of DPM Protected item.

FeatureSupportContent

Base class for feature request Please note FeatureSupportContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BackupGoalFeatureSupportContent and VmResourceFeatureSupportContent.

FetchTieringCostInfoContent

Base class for tiering cost request. Specific cost request types are derived from this class. Please note FetchTieringCostInfoContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include FetchTieringCostInfoForRehydrationContent, FetchTieringCostSavingsInfoForPolicyContent, FetchTieringCostSavingsInfoForProtectedItemContent and FetchTieringCostSavingsInfoForVaultContent.

FetchTieringCostInfoForRehydrationContent

Request parameters for fetching cost info of rehydration.

FetchTieringCostSavingsInfoForPolicyContent

Request parameters for tiering cost info for policy.

FetchTieringCostSavingsInfoForProtectedItemContent

Request parameters for tiering cost info for protected item.

FetchTieringCostSavingsInfoForVaultContent

Request parameters for tiering cost info for vault.

FileShareBackupContent

AzureFileShare workload-specific backup request.

FileShareProtectableItem

Protectable item for Azure Fileshare workloads.

FileshareProtectedItem

Azure File Share workload-specific backup item.

FileshareProtectedItemExtendedInfo

Additional information about Azure File Share backup item.

FileShareProtectionPolicy

AzureStorage backup policy.

FileShareProvisionIlrContent

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

FileShareRecoveryPoint

Azure File Share workload specific backup copy.

FileShareRestoreContent

AzureFileShare Restore Request.

GenericContainer

Base class for generic container of backup items.

GenericContainerExtendedInfo

Container extended information.

GenericProtectedItem

Base class for backup items.

GenericProtectionPolicy

Azure VM (Mercury) workload-specific backup policy.

GenericRecoveryPoint

Generic backup copy.

IaasClassicComputeVmContainer

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

IaasClassicComputeVmProtectableItem

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

IaasClassicComputeVmProtectedItem

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

IaasComputeVmContainer

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

IaasComputeVmProtectableItem

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

IaasComputeVmProtectedItem

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

IaasVmBackupContent

IaaS VM workload-specific backup request.

IaasVmBackupExtendedProperties

Extended Properties for Azure IaasVM Backup.

IaasVmBackupJob

Azure IaaS VM workload-specific job object.

IaasVmBackupJobExtendedInfo

Azure IaaS VM workload-specific additional information for job.

IaasVmBackupJobTaskDetails

Azure IaaS VM workload-specific job task details.

IaasVmBackupJobV2

Azure IaaS VM workload-specific job object.

IaasVmContainer

IaaS VM workload-specific container. Please note IaasVmContainer is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include IaasClassicComputeVmContainer and IaasComputeVmContainer.

IaasVmErrorInfo

Azure IaaS VM workload-specific error information.

IaasVmHealthDetails

Azure IaaS VM workload-specific Health Details.

IaasVmIlrRegistrationContent

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

IaasVmProtectableItem

IaaS VM workload-specific backup item. Please note IaasVmProtectableItem is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include IaasClassicComputeVmProtectableItem and IaasComputeVmProtectableItem.

IaasVmProtectedItem

IaaS VM workload-specific backup item. Please note IaasVmProtectedItem is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include IaasClassicComputeVmProtectedItem and IaasComputeVmProtectedItem.

IaasVmProtectedItemExtendedInfo

Additional information on Azure IaaS VM specific backup item.

IaasVmProtectionPolicy

IaaS VM workload-specific backup policy.

IaasVmRecoveryPoint

IaaS VM workload specific backup copy.

IaasVmRestoreContent

IaaS VM workload-specific restore. Please note IaasVmRestoreContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include IaasVmRestoreWithRehydrationContent.

IaasVmRestoreWithRehydrationContent

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

IdentityBasedRestoreDetails

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

IlrContent

Parameters to Provision ILR API. Please note IlrContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include FileShareProvisionIlrContent and IaasVmIlrRegistrationContent.

InquiryValidation

Validation for inquired protectable items under a given container.

InstantRPAdditionalDetails

The InstantRPAdditionalDetails.

KekDetails

KEK is encryption key for BEK.

KeyAndSecretDetails

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 BEK and KEK can potentially have different vault ids.
KpiResourceHealthDetails

KPI Resource Health Details.

LogSchedulePolicy

Log policy schedule.

LongTermRetentionPolicy

Long term retention policy.

LongTermSchedulePolicy

Long term policy schedule.

MabBackupJob

MAB workload-specific job.

MabBackupJobExtendedInfo

Additional information for the MAB workload-specific job.

MabBackupJobTaskDetails

MAB workload-specific job task details.

MabContainer

Container with items backed up using MAB backup engine.

MabContainerExtendedInfo

Additional information of the container.

MabContainerHealthDetails

MAB workload-specific Health Details.

MabErrorInfo

MAB workload-specific error information.

MabFileFolderProtectedItem

MAB workload-specific backup item.

MabFileFolderProtectedItemExtendedInfo

Additional information on the backed up item.

MabProtectionPolicy

Mab container-specific backup policy.

MonthlyRetentionSchedule

Monthly retention schedule.

MoveRPAcrossTiersContent

The MoveRPAcrossTiersContent.

PointInTimeRange

Provides details for log ranges.

PreBackupValidation

Pre-backup validation for Azure VM Workload provider.

PrepareDataMoveContent

Prepare DataMove Request.

PreValidateEnableBackupContent

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.
PreValidateEnableBackupResult

Response contract for enable backup validation request.

ProtectableContainer

Protectable Container Class. Please note ProtectableContainer is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include StorageProtectableContainer and VmAppContainerProtectableContainer.

ProtectableContainerResource

Protectable Container Class.

ProvisionIlrConnectionContent

Parameters to Provision ILR API.

RecoveryPointDiskConfiguration

Disk configuration.

RecoveryPointMoveReadinessInfo

The RecoveryPointMoveReadinessInfo.

RecoveryPointProperties

Properties of Recovery Point.

RecoveryPointRehydrationInfo

RP Rehydration Info.

RecoveryPointsRecommendedForMoveContent

ListRecoveryPointsRecommendedForMoveRequest Request.

RecoveryPointTierInformation

Recovery point tier information.

RecoveryPointTierInformationV2

RecoveryPoint Tier Information V2.

RecoveryServicesBackupPrivateLinkServiceConnectionState

Private Link Service Connection State.

RecoveryServiceVaultProtectionIntent

Azure Recovery Services Vault specific protection intent item. Please note RecoveryServiceVaultProtectionIntent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WorkloadAutoProtectionIntent and WorkloadSqlAutoProtectionIntent.

ResourceGuardOperationDetail

The ResourceGuardOperationDetail.

ResourceGuardProxyProperties

The ResourceGuardProxyProperties.

ResourceHealthDetails

Health Details for backup items.

ResourceProtectionIntent

IaaS VM specific backup protection intent item.

RestoreContent

Base class for restore request. Workload-specific restore requests are derived from this class. Please note RestoreContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include FileShareRestoreContent, WorkloadPointInTimeRestoreContent, WorkloadRestoreContent, WorkloadSapHanaPointInTimeRestoreContent, WorkloadSapHanaPointInTimeRestoreWithRehydrateContent, WorkloadSapHanaRestoreContent, WorkloadSapHanaRestoreWithRehydrateContent, WorkloadSqlPointInTimeRestoreContent, WorkloadSqlPointInTimeRestoreWithRehydrateContent, WorkloadSqlRestoreContent, WorkloadSqlRestoreWithRehydrateContent, IaasVmRestoreContent and IaasVmRestoreWithRehydrationContent.

RestoreFileSpecs

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

RetentionDuration

Retention duration.

SecurityPinContent

Base class for get security pin request body.

SimpleRetentionPolicy

Simple policy retention.

SimpleSchedulePolicy

Simple policy schedule.

SimpleSchedulePolicyV2

The V2 policy schedule for IaaS that supports hourly backups.

SnapshotBackupAdditionalDetails

Snapshot Backup related fields for WorkloadType SaPHanaSystem.

SnapshotRestoreContent

Encapsulates information regarding snapshot recovery for SAP Hana.

SqlAvailabilityGroupWorkloadProtectionContainer

Container for SQL workloads under SQL Availability Group.

SqlContainer

Azure Sql workload-specific container.

SqlDataDirectory

SQLDataDirectory info.

SqlDataDirectoryMapping

Encapsulates information regarding data directory.

SqlProtectedItem

Azure SQL workload-specific backup item.

SqlProtectedItemExtendedInfo

Additional information on Azure Sql specific protected item.

SqlProtectionPolicy

Azure SQL workload-specific backup policy.

StorageBackupJob

Azure storage specific job.

StorageBackupJobExtendedInfo

Azure Storage workload-specific additional information for job.

StorageBackupJobTaskDetails

Azure storage workload specific job task details.

StorageContainer

Azure Storage Account workload-specific container.

StorageErrorInfo

Azure storage specific error information.

StorageProtectableContainer

Azure Storage-specific protectable containers.

SubProtectionPolicy

Sub-protection policy which includes schedule and retention.

TargetAfsRestoreInfo

Target Azure File Share Info.

TargetRestoreInfo

Details about target workload during restore operation.

TieringCostInfo

Base class for tiering cost response Please note TieringCostInfo is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include TieringCostRehydrationInfo and TieringCostSavingInfo.

TieringCostRehydrationInfo

Response parameters for tiering cost info for rehydration.

TieringCostSavingInfo

Response parameters for tiering cost info for savings.

TokenInformation

The token information details.

TriggerBackupContent

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

TriggerDataMoveContent

Trigger DataMove Request.

TriggerRestoreContent

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

UnlockDeleteContent

Request body of unlock delete API.

UnlockDeleteResult

Response of Unlock Delete API.

UserAssignedManagedIdentityDetails

The UserAssignedManagedIdentityDetails.

VaultBackupJob

Vault level Job.

VaultBackupJobErrorInfo

Vault Job specific error information.

VaultRetentionPolicy

Vault retention policy for AzureFileShare.

VmAppContainerProtectableContainer

Azure workload-specific container.

VmAppContainerProtectionContainer

Container for SQL workloads under Azure Virtual Machines.

VmEncryptionDetails

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

VmResourceFeatureSupportContent

AzureResource(IaaS VM) Specific feature support request.

VmResourceFeatureSupportResult

Response for feature support requests for Azure IaasVm.

VmWorkloadItem

Azure VM workload-specific workload item. Please note VmWorkloadItem is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include VmWorkloadSapAseDatabaseWorkloadItem, VmWorkloadSapAseSystemWorkloadItem, VmWorkloadSapHanaDatabaseWorkloadItem, VmWorkloadSapHanaSystemWorkloadItem, VmWorkloadSqlDatabaseWorkloadItem and VmWorkloadSqlInstanceWorkloadItem.

VmWorkloadProtectableItem

Azure VM workload-specific protectable item. Please note VmWorkloadProtectableItem is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include VmWorkloadSapHanaHsrProtectableItem, VmWorkloadSapAseSystemProtectableItem, VmWorkloadSapHanaDBInstance, VmWorkloadSapHanaDatabaseProtectableItem, VmWorkloadSapHanaSystemProtectableItem, VmWorkloadSqlAvailabilityGroupProtectableItem, VmWorkloadSqlDatabaseProtectableItem and VmWorkloadSqlInstanceProtectableItem.

VmWorkloadProtectedItem

Azure VM workload-specific protected item. Please note VmWorkloadProtectedItem is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include VmWorkloadSapAseDatabaseProtectedItem, VmWorkloadSapHanaDBInstanceProtectedItem, VmWorkloadSapHanaDatabaseProtectedItem and VmWorkloadSqlDatabaseProtectedItem.

VmWorkloadProtectedItemExtendedInfo

Additional information on Azure Workload for SQL specific backup item.

VmWorkloadProtectionPolicy

Azure VM (Mercury) workload-specific backup policy.

VmWorkloadSapAseDatabaseProtectedItem

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

VmWorkloadSapAseDatabaseWorkloadItem

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

VmWorkloadSapAseSystemProtectableItem

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

VmWorkloadSapAseSystemWorkloadItem

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

VmWorkloadSapHanaDatabaseProtectableItem

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

VmWorkloadSapHanaDatabaseProtectedItem

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

VmWorkloadSapHanaDatabaseWorkloadItem

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

VmWorkloadSapHanaDBInstance

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

VmWorkloadSapHanaDBInstanceProtectedItem

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

VmWorkloadSapHanaHsrProtectableItem

Azure VM workload-specific protectable item representing HANA HSR.

VmWorkloadSapHanaSystemProtectableItem

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

VmWorkloadSapHanaSystemWorkloadItem

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

VmWorkloadSqlAvailabilityGroupProtectableItem

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

VmWorkloadSqlDatabaseProtectableItem

Azure VM workload-specific protectable item representing SQL Database.

VmWorkloadSqlDatabaseProtectedItem

Azure VM workload-specific protected item representing SQL Database.

VmWorkloadSqlDatabaseWorkloadItem

Azure VM workload-specific workload item representing SQL Database.

VmWorkloadSqlInstanceProtectableItem

Azure VM workload-specific protectable item representing SQL Instance.

VmWorkloadSqlInstanceWorkloadItem

Azure VM workload-specific workload item representing SQL Instance.

WeeklyRetentionFormat

Weekly retention format.

WeeklyRetentionSchedule

Weekly retention schedule.

WorkloadAutoProtectionIntent

Azure Recovery Services Vault specific protection intent item. Please note WorkloadAutoProtectionIntent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WorkloadSqlAutoProtectionIntent.

WorkloadBackupContent

AzureWorkload workload-specific backup request.

WorkloadBackupJob

Azure storage specific job.

WorkloadBackupJobExtendedInfo

Azure VM workload-specific additional information for job.

WorkloadBackupJobTaskDetails

Azure VM workload specific job task details.

WorkloadContainer

Container for the workloads running inside Azure Compute or Classic Compute. Please note WorkloadContainer is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SqlAvailabilityGroupWorkloadProtectionContainer and VmAppContainerProtectionContainer.

WorkloadContainerAutoProtectionIntent

Azure workload specific protection intent item.

WorkloadContainerExtendedInfo

Extended information of the container.

WorkloadContainerInquiryInfo

Details about inquired protectable items under a given container.

WorkloadErrorInfo

Azure storage specific error information.

WorkloadInquiryDetails

Details of an inquired protectable item.

WorkloadItem

Base class for backup item. Workload-specific backup items are derived from this class. Please note WorkloadItem is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include VmWorkloadItem, VmWorkloadSapAseDatabaseWorkloadItem, VmWorkloadSapAseSystemWorkloadItem, VmWorkloadSapHanaDatabaseWorkloadItem, VmWorkloadSapHanaSystemWorkloadItem, VmWorkloadSqlDatabaseWorkloadItem and VmWorkloadSqlInstanceWorkloadItem.

WorkloadItemResource

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

WorkloadPointInTimeRecoveryPoint

Recovery point specific to PointInTime Please note WorkloadPointInTimeRecoveryPoint is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WorkloadSapHanaPointInTimeRecoveryPoint.

WorkloadPointInTimeRestoreContent

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

WorkloadProtectableItem

Base class for backup item. Workload-specific backup items are derived from this class. Please note WorkloadProtectableItem is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include FileShareProtectableItem, VmWorkloadProtectableItem, VmWorkloadSapHanaHsrProtectableItem, IaasVmProtectableItem, IaasClassicComputeVmProtectableItem, IaasComputeVmProtectableItem, VmWorkloadSapAseSystemProtectableItem, VmWorkloadSapHanaDBInstance, VmWorkloadSapHanaDatabaseProtectableItem, VmWorkloadSapHanaSystemProtectableItem, VmWorkloadSqlAvailabilityGroupProtectableItem, VmWorkloadSqlDatabaseProtectableItem and VmWorkloadSqlInstanceProtectableItem.

WorkloadProtectableItemResource

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

WorkloadRecoveryPoint

Workload specific recovery point, specifically encapsulates full/diff recovery point Please note WorkloadRecoveryPoint is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WorkloadPointInTimeRecoveryPoint, WorkloadSapHanaPointInTimeRecoveryPoint, WorkloadSapHanaRecoveryPoint, WorkloadSqlPointInTimeRecoveryPoint and WorkloadSqlRecoveryPoint.

WorkloadRestoreContent

AzureWorkload-specific restore. Please note WorkloadRestoreContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WorkloadPointInTimeRestoreContent, WorkloadSapHanaPointInTimeRestoreContent, WorkloadSapHanaPointInTimeRestoreWithRehydrateContent, WorkloadSapHanaRestoreContent, WorkloadSapHanaRestoreWithRehydrateContent, WorkloadSqlPointInTimeRestoreContent, WorkloadSqlPointInTimeRestoreWithRehydrateContent, WorkloadSqlRestoreContent and WorkloadSqlRestoreWithRehydrateContent.

WorkloadSapHanaPointInTimeRecoveryPoint

Recovery point specific to PointInTime in SAPHana.

WorkloadSapHanaPointInTimeRestoreContent

AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore Please note WorkloadSapHanaPointInTimeRestoreContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WorkloadSapHanaPointInTimeRestoreWithRehydrateContent.

WorkloadSapHanaPointInTimeRestoreWithRehydrateContent

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

WorkloadSapHanaRecoveryPoint

SAPHana specific recoverypoint, specifically encapsulates full/diff recoverypoints.

WorkloadSapHanaRestoreContent

AzureWorkload SAP Hana-specific restore. Please note WorkloadSapHanaRestoreContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WorkloadSapHanaPointInTimeRestoreContent, WorkloadSapHanaPointInTimeRestoreWithRehydrateContent and WorkloadSapHanaRestoreWithRehydrateContent.

WorkloadSapHanaRestoreWithRehydrateContent

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

WorkloadSqlAutoProtectionIntent

Azure Workload SQL Auto Protection intent item.

WorkloadSqlPointInTimeRecoveryPoint

Recovery point specific to PointInTime.

WorkloadSqlPointInTimeRestoreContent

AzureWorkload SQL -specific restore. Specifically for PointInTime/Log restore Please note WorkloadSqlPointInTimeRestoreContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WorkloadSqlPointInTimeRestoreWithRehydrateContent.

WorkloadSqlPointInTimeRestoreWithRehydrateContent

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

WorkloadSqlRecoveryPoint

SQL specific recoverypoint, specifically encapsulates full/diff recoverypoint along with extended info Please note WorkloadSqlRecoveryPoint is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WorkloadSqlPointInTimeRecoveryPoint.

WorkloadSqlRecoveryPointExtendedInfo

Extended info class details.

WorkloadSqlRestoreContent

AzureWorkload SQL -specific restore. Specifically for full/diff restore Please note WorkloadSqlRestoreContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WorkloadSqlPointInTimeRestoreContent, WorkloadSqlPointInTimeRestoreWithRehydrateContent and WorkloadSqlRestoreWithRehydrateContent.

WorkloadSqlRestoreWithRehydrateContent

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

YearlyRetentionSchedule

Yearly retention schedule.

Structs

AcquireStorageAccountLock

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

BackupCreateMode

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

BackupDataSourceType

Type of workload this item represents.

BackupEncryptionAtRestType

Encryption At Rest Type.

BackupFabricName

Specifies the fabric name - Azure or AD.

BackupFileShareType

File Share type XSync or XSMB.

BackupItemType

Type of backup items associated with this container.

BackupManagementType

Backup management type to execute the current job.

BackupPrivateEndpointConnectionProvisioningState

Gets or sets provisioning state of the private endpoint connection.

BackupProtectionState

Backup state of this backup item.

BackupProtectionStatus

Specifies whether the container is registered or not.

BackupStorageType

Storage type.

BackupStorageTypeState

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

BackupType

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

BackupUsagesUnit

Unit of the usage.

BackupValidationStatus

Validation Status.

BackupWorkloadType

Type of workload for the backup management.

DataMoveLevel

DataMove Level.

EnhancedSecurityState

Enabled or Disabled.

FileShareCopyOption

Options to resolve copy conflicts.

FileShareRecoveryType

Type of this recovery.

FileShareRestoreType

Restore Type (FullShareRestore or ItemLevelRestore).

IaasVmPolicyType

The IaasVmPolicyType.

IaasVmProtectedItemHealthStatus

Health status of protected item.

InfrastructureEncryptionState

The InfrastructureEncryptionState.

InquiryStatus

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

LastBackupStatus

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

LastUpdateStatus

The LastUpdateStatus.

MabServerType

Server type of MAB container.

PrivateEndpointConnectionStatus

Gets or sets the status.

ProtectedItemState

Backup state of the backed up item.

RecoveryMode

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

RehydrationPriority

Rehydration Priority.

ResourceHealthStatus

Resource Health Status.

RestoreOverwriteOption

Can Overwrite if Target DataBase already exists.

RestorePointType

Type of restore point.

RetentionDurationType

Retention duration type of retention policy.

RetentionScheduleFormat

Retention schedule format type for monthly retention policy.

ScheduleRunType

Frequency of the schedule operation of this policy.

SoftDeleteFeatureState

Soft Delete feature state.

SqlDataDirectoryType

Type of data directory mapping.

SubProtectionPolicyType

Type of backup policy type.

TieringMode

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
VaultDedupState

Vault Dedup state.

VaultSubResourceType

GroupId for the PrivateEndpointConnection - AzureBackup, AzureBackup_secondary or AzureSiteRecovery.

VaultXcoolState

Vault x-cool state.

VmResourceFeatureSupportStatus

Support status of feature.

VmWorkloadProtectedItemHealthStatus

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

WorkloadItemType

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

WorkloadOperationType

Re-Do Operation.

Enums

BackupDayOfWeek

The BackupDayOfWeek.

BackupMonthOfYear

The BackupMonthOfYear.

BackupTargetDiskNetworkAccessOption

Network access settings to be used for restored disks.

BackupWeekOfMonth

The BackupWeekOfMonth.

JobSupportedAction

The JobSupportedAction.

RecoveryPointTierStatus

Recovery point tier status.

RecoveryPointTierType

Recovery point tier type.