azure.mgmt.recoveryservicesbackup.models module¶

class azure.mgmt.recoveryservicesbackup.models.AzureBackupGoalFeatureSupportRequest(**kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.FeatureSupportRequest

Azure backup goal feature specific request.

All required parameters must be populated in order to send to Azure.

Parameters: feature_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.AzureBackupServerContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, can_re_register: bool = None, container_id: str = None, protected_item_count: int = None, dpm_agent_version: str = None, dpm_servers=None, upgrade_available: bool = None, protection_status: str = None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.DpmContainer

AzureBackupServer (DPMVenus) workload-specific protection container.

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
can_re_register (bool) – Specifies whether the container is re-registrable.
container_id (str) – ID of container.
protected_item_count (long) – Number of protected items in the BackupEngine
dpm_agent_version (str) – Backup engine Agent version
dpm_servers (list[str]) – List of BackupEngines protecting the container
upgrade_available (bool) – To check if upgrade available
protection_status (str) – Protection status of the container.
extended_info (DPMContainerExtendedInfo) – Extended Info of the container.

class azure.mgmt.recoveryservicesbackup.models.AzureBackupServerEngine(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, backup_engine_state: str = None, health_status: str = None, can_re_register: bool = None, backup_engine_id: str = None, dpm_version: str = None, azure_backup_agent_version: str = None, is_azure_backup_agent_upgrade_available: bool = None, is_dpm_upgrade_available: bool = None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.BackupEngineBase

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

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the backup engine.
backup_management_type (str or BackupManagementType) – Type of backup management for the backup engine. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Registration status of the backup engine with the Recovery Services Vault.
backup_engine_state (str) – Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}
health_status (str) – Backup status of the backup engine.
can_re_register (bool) – Flag indicating if the backup engine be registered, once already registered.
backup_engine_id (str) – ID of the backup engine.
dpm_version (str) – Backup engine version
azure_backup_agent_version (str) – Backup agent version
is_azure_backup_agent_upgrade_available (bool) – To check if backup agent upgrade available
is_dpm_upgrade_available (bool) – To check if backup engine upgrade available
extended_info (BackupEngineExtendedInfo) – Extended info of the backupengine
backup_engine_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.AzureFileShareBackupRequest(*, recovery_point_expiry_time_in_utc=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.BackupRequest

AzureFileShare workload-specific backup request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_point_expiry_time_in_utc (datetime) – Backup copy will expire after the time specified (UTC).

class azure.mgmt.recoveryservicesbackup.models.AzureFileShareProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_container_fabric_id: str = None, parent_container_friendly_name: str = None, azure_file_share_type=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.WorkloadProtectableItem

Protectable item for Azure Fileshare workloads.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
parent_container_fabric_id (str) – Full Fabric ID of container to which this protectable item belongs. For example, ARM ID.
parent_container_friendly_name (str) – Friendly name of container to which this protectable item belongs.
azure_file_share_type (str or AzureFileShareType) – File Share type XSync or XSMB. Possible values include: ‘Invalid’, ‘XSMB’, ‘XSync’

class azure.mgmt.recoveryservicesbackup.models.AzureFileshareProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, protection_status: str = None, protection_state=None, health_status=None, last_backup_status: str = None, last_backup_time=None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectedItem

Azure File Share workload-specific backup item.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the fileshare represented by this backup item.
protection_status (str) – Backup status of this backup item.
protection_state (str or ProtectionState) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
health_status (str or HealthStatus) – backups running status for this backup item. Possible values include: ‘Passed’, ‘ActionRequired’, ‘ActionSuggested’, ‘Invalid’
last_backup_status (str) – Last backup operation status. Possible values: Healthy, Unhealthy.
last_backup_time (datetime) – Timestamp of the last backup operation on this backup item.
extended_info (AzureFileshareProtectedItemExtendedInfo) – Additional information with this backup item.

class azure.mgmt.recoveryservicesbackup.models.AzureFileshareProtectedItemExtendedInfo(*, oldest_recovery_point=None, recovery_point_count: int = None, policy_state: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information about Azure File Share backup item.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

oldest_recovery_point (datetime) – The oldest backup copy available for this item in the service.
recovery_point_count (int) – Number of available backup copies associated with this backup item.
policy_state (str) – Indicates consistency of policy object and policy applied to this backup item.

Variables

resource_state (str) – Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted}
resource_state_sync_time (datetime) – The resource state sync time for this backup item.

class azure.mgmt.recoveryservicesbackup.models.AzureFileShareProtectionPolicy(*, protected_items_count: int = None, work_load_type=None, schedule_policy=None, retention_policy=None, time_zone: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionPolicy

AzureStorage backup policy.

All required parameters must be populated in order to send to Azure.

Parameters

protected_items_count (int) – Number of items associated with this policy.
backup_management_type (str) – Required. Constant filled by server.
work_load_type (str or WorkloadType) – Type of workload for the backup management. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
schedule_policy (SchedulePolicy) – Backup schedule specified as part of backup policy.
retention_policy (RetentionPolicy) – Retention policy with the details on backup copy retention ranges.
time_zone (str) – TimeZone optional input as string. For example: TimeZone = “Pacific Standard Time”.

class azure.mgmt.recoveryservicesbackup.models.AzureFileShareProvisionILRRequest(*, recovery_point_id: str = None, source_resource_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ILRRequest

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

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_point_id (str) – Recovery point ID.
source_resource_id (str) – Source Storage account ARM Id

class azure.mgmt.recoveryservicesbackup.models.AzureFileShareRecoveryPoint(**kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.RecoveryPoint

Azure File Share workload specific backup copy.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.

Variables

recovery_point_type (str) – Type of the backup copy. Specifies whether it is a crash consistent backup or app consistent.
recovery_point_time (datetime) – Time at which this backup copy was created.
file_share_snapshot_uri (str) – Contains Url to the snapshot of fileshare, if applicable
recovery_point_size_in_gb (int) – Contains recovery point size

class azure.mgmt.recoveryservicesbackup.models.AzureFileShareRestoreRequest(*, recovery_type=None, source_resource_id: str = None, copy_options=None, restore_request_type=None, restore_file_specs=None, target_details=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.RestoreRequest

AzureFileShare Restore Request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_type (str or RecoveryType) – Type of this recovery. Possible values include: ‘Invalid’, ‘OriginalLocation’, ‘AlternateLocation’, ‘RestoreDisks’, ‘Offline’
source_resource_id (str) – Source storage account ARM Id
copy_options (str or CopyOptions) – Options to resolve copy conflicts. Possible values include: ‘Invalid’, ‘CreateCopy’, ‘Skip’, ‘Overwrite’, ‘FailOnConflict’
restore_request_type (str or RestoreRequestType) – Restore Type (FullShareRestore or ItemLevelRestore). Possible values include: ‘Invalid’, ‘FullShareRestore’, ‘ItemLevelRestore’
restore_file_specs (list[RestoreFileSpecs]) – List of Source Files/Folders(which need to recover) and TargetFolderPath details
target_details (TargetAFSRestoreInfo) – Target File Share Details

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSClassicComputeVMContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, virtual_machine_id: str = None, virtual_machine_version: str = None, resource_group: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.IaaSVMContainer

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

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
virtual_machine_id (str) – Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.
virtual_machine_version (str) – Specifies whether the container represents a Classic or an Azure Resource Manager VM.
resource_group (str) – Resource group name of Recovery Services Vault.

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSClassicComputeVMProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, virtual_machine_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.IaaSVMProtectableItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
virtual_machine_id (str) – Fully qualified ARM ID of the virtual machine.

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSClassicComputeVMProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, virtual_machine_id: str = None, protection_status: str = None, protection_state=None, health_status=None, health_details=None, last_backup_status: str = None, last_backup_time=None, protected_item_data_id: str = None, extended_info=None, extended_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureIaaSVMProtectedItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the VM represented by this backup item.
virtual_machine_id (str) – Fully qualified ARM ID of the virtual machine represented by this item.
protection_status (str) – Backup status of this backup item.
protection_state (str or ProtectionState) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
health_status (str or HealthStatus) – Health status of protected item. Possible values include: ‘Passed’, ‘ActionRequired’, ‘ActionSuggested’, ‘Invalid’
health_details (list[AzureIaaSVMHealthDetails]) – Health details on this backup item.
last_backup_status (str) – Last backup operation status.
last_backup_time (datetime) – Timestamp of the last backup operation on this backup item.
protected_item_data_id (str) – Data ID of the protected item.
extended_info (AzureIaaSVMProtectedItemExtendedInfo) – Additional information for this backup item.
extended_properties (ExtendedProperties) –

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSComputeVMContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, virtual_machine_id: str = None, virtual_machine_version: str = None, resource_group: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.IaaSVMContainer

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

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
virtual_machine_id (str) – Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.
virtual_machine_version (str) – Specifies whether the container represents a Classic or an Azure Resource Manager VM.
resource_group (str) – Resource group name of Recovery Services Vault.

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSComputeVMProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, virtual_machine_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.IaaSVMProtectableItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
virtual_machine_id (str) – Fully qualified ARM ID of the virtual machine.

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSComputeVMProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, virtual_machine_id: str = None, protection_status: str = None, protection_state=None, health_status=None, health_details=None, last_backup_status: str = None, last_backup_time=None, protected_item_data_id: str = None, extended_info=None, extended_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureIaaSVMProtectedItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the VM represented by this backup item.
virtual_machine_id (str) – Fully qualified ARM ID of the virtual machine represented by this item.
protection_status (str) – Backup status of this backup item.
protection_state (str or ProtectionState) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
health_status (str or HealthStatus) – Health status of protected item. Possible values include: ‘Passed’, ‘ActionRequired’, ‘ActionSuggested’, ‘Invalid’
health_details (list[AzureIaaSVMHealthDetails]) – Health details on this backup item.
last_backup_status (str) – Last backup operation status.
last_backup_time (datetime) – Timestamp of the last backup operation on this backup item.
protected_item_data_id (str) – Data ID of the protected item.
extended_info (AzureIaaSVMProtectedItemExtendedInfo) – Additional information for this backup item.
extended_properties (ExtendedProperties) –

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMErrorInfo(**kwargs)[source]¶

Bases: msrest.serialization.Model

Azure IaaS VM workload-specific error information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

error_code (int) – Error code.
error_title (str) – Title: Typically, the entity that the error pertains to.
error_string (str) – Localized error string.
recommendations (list[str]) – List of localized recommendations for above error code.

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMHealthDetails(**kwargs)[source]¶

Bases: msrest.serialization.Model

Azure IaaS VM workload-specific Health Details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

code (int) – Health Code
title (str) – Health Title
message (str) – Health Message
recommendations (list[str]) – Health Recommended Actions

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMJob(*, entity_friendly_name: str = None, backup_management_type=None, operation: str = None, status: str = None, start_time=None, end_time=None, activity_id: str = None, duration=None, actions_info=None, error_details=None, virtual_machine_version: str = None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Job

Azure IaaS VM workload-specific job object.

All required parameters must be populated in order to send to Azure.

Parameters

entity_friendly_name (str) – Friendly name of the entity on which the current job is executing.
backup_management_type (str or BackupManagementType) – Backup management type to execute the current job. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
operation (str) – The operation name.
status (str) – Job status.
start_time (datetime) – The start time.
end_time (datetime) – The end time.
activity_id (str) – ActivityId of job.
job_type (str) – Required. Constant filled by server.
duration (timedelta) – Time elapsed during the execution of this job.
actions_info (list[str or JobSupportedAction]) – Gets or sets the state/actions applicable on this job like cancel/retry.
error_details (list[AzureIaaSVMErrorInfo]) – Error details on execution of this job.
virtual_machine_version (str) – Specifies whether the backup item is a Classic or an Azure Resource Manager VM.
extended_info (AzureIaaSVMJobExtendedInfo) – Additional information for this job.

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMJobExtendedInfo(*, tasks_list=None, property_bag=None, internal_property_bag=None, progress_percentage: float = None, estimated_remaining_duration: str = None, dynamic_error_message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure IaaS VM workload-specific additional information for job.

Parameters

tasks_list (list[AzureIaaSVMJobTaskDetails]) – List of tasks associated with this job.
property_bag (dict[str, str]) – Job properties.
internal_property_bag (dict[str, str]) – Job internal properties.
progress_percentage (float) – Indicates progress of the job. Null if it has not started or completed.
estimated_remaining_duration (str) – Time remaining for execution of this job.
dynamic_error_message (str) – Non localized error message on job execution.

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMJobTaskDetails(*, task_id: str = None, start_time=None, end_time=None, instance_id: str = None, duration=None, status: str = None, progress_percentage: float = None, task_execution_details: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure IaaS VM workload-specific job task details.

Parameters

task_id (str) – The task display name.
start_time (datetime) – The start time.
end_time (datetime) – The end time.
instance_id (str) – The instanceId.
duration (timedelta) – Time elapsed for task.
status (str) – The status.
progress_percentage (float) – Progress of the task.
task_execution_details (str) – Details about execution of the task. eg: number of bytes transferred etc

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, virtual_machine_id: str = None, protection_status: str = None, protection_state=None, health_status=None, health_details=None, last_backup_status: str = None, last_backup_time=None, protected_item_data_id: str = None, extended_info=None, extended_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectedItem

IaaS VM workload-specific backup item.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureIaaSClassicComputeVMProtectedItem, AzureIaaSComputeVMProtectedItem

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the VM represented by this backup item.
virtual_machine_id (str) – Fully qualified ARM ID of the virtual machine represented by this item.
protection_status (str) – Backup status of this backup item.
protection_state (str or ProtectionState) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
health_status (str or HealthStatus) – Health status of protected item. Possible values include: ‘Passed’, ‘ActionRequired’, ‘ActionSuggested’, ‘Invalid’
health_details (list[AzureIaaSVMHealthDetails]) – Health details on this backup item.
last_backup_status (str) – Last backup operation status.
last_backup_time (datetime) – Timestamp of the last backup operation on this backup item.
protected_item_data_id (str) – Data ID of the protected item.
extended_info (AzureIaaSVMProtectedItemExtendedInfo) – Additional information for this backup item.
extended_properties (ExtendedProperties) –

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMProtectedItemExtendedInfo(*, oldest_recovery_point=None, recovery_point_count: int = None, policy_inconsistent: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information on Azure IaaS VM specific backup item.

Parameters

oldest_recovery_point (datetime) – The oldest backup copy available for this backup item.
recovery_point_count (int) – Number of backup copies available for this backup item.
policy_inconsistent (bool) – Specifies if backup policy associated with the backup item is inconsistent.

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMProtectionPolicy(*, protected_items_count: int = None, instant_rp_details=None, schedule_policy=None, retention_policy=None, instant_rp_retention_range_in_days: int = None, time_zone: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionPolicy

IaaS VM workload-specific backup policy.

All required parameters must be populated in order to send to Azure.

Parameters

protected_items_count (int) – Number of items associated with this policy.
backup_management_type (str) – Required. Constant filled by server.
instant_rp_details (InstantRPAdditionalDetails) –
schedule_policy (SchedulePolicy) – Backup schedule specified as part of backup policy.
retention_policy (RetentionPolicy) – Retention policy with the details on backup copy retention ranges.
instant_rp_retention_range_in_days (int) – Instant RP retention policy range in days
time_zone (str) – TimeZone optional input as string. For example: TimeZone = “Pacific Standard Time”.

class azure.mgmt.recoveryservicesbackup.models.AzureRecoveryServiceVaultProtectionIntent(*, backup_management_type=None, source_resource_id: str = None, item_id: str = None, policy_id: str = None, protection_state=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionIntent

Azure Recovery Services Vault specific protection intent item.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureWorkloadAutoProtectionIntent

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
source_resource_id (str) – ARM ID of the resource to be backed up.
item_id (str) – ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policy_id (str) – ID of the backup policy with which this item is backed up.
protection_state (str or ProtectionStatus) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protection_intent_item_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.AzureResourceProtectionIntent(*, backup_management_type=None, source_resource_id: str = None, item_id: str = None, policy_id: str = None, protection_state=None, friendly_name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionIntent

IaaS VM specific backup protection intent item.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
source_resource_id (str) – ARM ID of the resource to be backed up.
item_id (str) – ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policy_id (str) – ID of the backup policy with which this item is backed up.
protection_state (str or ProtectionStatus) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protection_intent_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the VM represented by this backup item.

class azure.mgmt.recoveryservicesbackup.models.AzureSQLAGWorkloadContainerProtectionContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, source_resource_id: str = None, last_updated_time=None, extended_info=None, workload_type=None, operation_type=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadContainer

Container for SQL workloads under SQL Availability Group.

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
source_resource_id (str) – ARM ID of the virtual machine represented by this Azure Workload Container
last_updated_time (datetime) – Time stamp when this container was updated.
extended_info (AzureWorkloadContainerExtendedInfo) – Additional details of a workload container.
workload_type (str or WorkloadType) – Workload type for which registration was sent. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
operation_type (str or OperationType) – Re-Do Operation. Possible values include: ‘Invalid’, ‘Register’, ‘Reregister’

class azure.mgmt.recoveryservicesbackup.models.AzureSqlContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionContainer

Azure Sql workload-specific container.

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.AzureSqlProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, protected_item_data_id: str = None, protection_state=None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectedItem

Azure SQL workload-specific backup item.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
protected_item_data_id (str) – Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services.
protection_state (str or ProtectedItemState) – Backup state of the backed up item. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
extended_info (AzureSqlProtectedItemExtendedInfo) – Additional information for this backup item.

class azure.mgmt.recoveryservicesbackup.models.AzureSqlProtectedItemExtendedInfo(*, oldest_recovery_point=None, recovery_point_count: int = None, policy_state: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information on Azure Sql specific protected item.

Parameters

oldest_recovery_point (datetime) – The oldest backup copy available for this item in the service.
recovery_point_count (int) – Number of available backup copies associated with this backup item.
policy_state (str) – State of the backup policy associated with this backup item.

class azure.mgmt.recoveryservicesbackup.models.AzureSqlProtectionPolicy(*, protected_items_count: int = None, retention_policy=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionPolicy

Azure SQL workload-specific backup policy.

All required parameters must be populated in order to send to Azure.

Parameters

protected_items_count (int) – Number of items associated with this policy.
backup_management_type (str) – Required. Constant filled by server.
retention_policy (RetentionPolicy) – Retention policy details.

class azure.mgmt.recoveryservicesbackup.models.AzureStorageContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, source_resource_id: str = None, storage_account_version: str = None, resource_group: str = None, protected_item_count: int = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionContainer

Azure Storage Account workload-specific container.

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
source_resource_id (str) – Fully qualified ARM url.
storage_account_version (str) – Storage account version.
resource_group (str) – Resource group name of Recovery Services Vault.
protected_item_count (long) – Number of items backed up in this container.

class azure.mgmt.recoveryservicesbackup.models.AzureStorageErrorInfo(*, error_code: int = None, error_string: str = None, recommendations=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure storage specific error information.

Parameters

error_code (int) – Error code.
error_string (str) – Localized error string.
recommendations (list[str]) – List of localized recommendations for above error code.

class azure.mgmt.recoveryservicesbackup.models.AzureStorageJob(*, entity_friendly_name: str = None, backup_management_type=None, operation: str = None, status: str = None, start_time=None, end_time=None, activity_id: str = None, duration=None, actions_info=None, error_details=None, storage_account_name: str = None, storage_account_version: str = None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Job

Azure storage specific job.

All required parameters must be populated in order to send to Azure.

Parameters

entity_friendly_name (str) – Friendly name of the entity on which the current job is executing.
backup_management_type (str or BackupManagementType) – Backup management type to execute the current job. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
operation (str) – The operation name.
status (str) – Job status.
start_time (datetime) – The start time.
end_time (datetime) – The end time.
activity_id (str) – ActivityId of job.
job_type (str) – Required. Constant filled by server.
duration (timedelta) – Time elapsed during the execution of this job.
actions_info (list[str or JobSupportedAction]) – Gets or sets the state/actions applicable on this job like cancel/retry.
error_details (list[AzureStorageErrorInfo]) – Error details on execution of this job.
storage_account_name (str) – Specifies friendly name of the storage account.
storage_account_version (str) – Specifies whether the Storage account is a Classic or an Azure Resource Manager Storage account.
extended_info (AzureStorageJobExtendedInfo) – Additional information about the job.

class azure.mgmt.recoveryservicesbackup.models.AzureStorageJobExtendedInfo(*, tasks_list=None, property_bag=None, dynamic_error_message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure Storage workload-specific additional information for job.

Parameters

tasks_list (list[AzureStorageJobTaskDetails]) – List of tasks for this job
property_bag (dict[str, str]) – Job properties.
dynamic_error_message (str) – Non localized error message on job execution.

class azure.mgmt.recoveryservicesbackup.models.AzureStorageJobTaskDetails(*, task_id: str = None, status: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure storage workload specific job task details.

Parameters

task_id (str) – The task display name.
status (str) – The status.

class azure.mgmt.recoveryservicesbackup.models.AzureStorageProtectableContainer(*, friendly_name: str = None, backup_management_type=None, health_status: str = None, container_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectableContainer

Azure Storage-specific protectable containers.

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
health_status (str) – Status of health of the container.
container_id (str) – Fabric Id of the container such as ARM Id.
protectable_container_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.AzureVMAppContainerProtectableContainer(*, friendly_name: str = None, backup_management_type=None, health_status: str = None, container_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectableContainer

Azure workload-specific container.

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
health_status (str) – Status of health of the container.
container_id (str) – Fabric Id of the container such as ARM Id.
protectable_container_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.AzureVMAppContainerProtectionContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, source_resource_id: str = None, last_updated_time=None, extended_info=None, workload_type=None, operation_type=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadContainer

Container for SQL workloads under Azure Virtual Machines.

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
source_resource_id (str) – ARM ID of the virtual machine represented by this Azure Workload Container
last_updated_time (datetime) – Time stamp when this container was updated.
extended_info (AzureWorkloadContainerExtendedInfo) – Additional details of a workload container.
workload_type (str or WorkloadType) – Workload type for which registration was sent. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
operation_type (str or OperationType) – Re-Do Operation. Possible values include: ‘Invalid’, ‘Register’, ‘Reregister’

class azure.mgmt.recoveryservicesbackup.models.AzureVMResourceFeatureSupportRequest(*, vm_size: str = None, vm_sku: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.FeatureSupportRequest

AzureResource(IaaS VM) Specific feature support request.

All required parameters must be populated in order to send to Azure.

Parameters

feature_type (str) – Required. Constant filled by server.
vm_size (str) – Size of the resource: VM size(A/D series etc) in case of IaasVM
vm_sku (str) – SKUs (Premium/Managed etc) in case of IaasVM

class azure.mgmt.recoveryservicesbackup.models.AzureVMResourceFeatureSupportResponse(*, support_status=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for feature support requests for Azure IaasVm.

Parameters: support_status (str or SupportStatus) – Support status of feature. Possible values include: ‘Invalid’, ‘Supported’, ‘DefaultOFF’, ‘DefaultON’, ‘NotSupported’

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, server_name: str = None, is_auto_protectable: bool = None, subinquireditemcount: int = None, sub_workload_item_count: int = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.WorkloadItem

Azure VM workload-specific workload item.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureVmWorkloadSAPAseDatabaseWorkloadItem, AzureVmWorkloadSAPAseSystemWorkloadItem, AzureVmWorkloadSAPHanaDatabaseWorkloadItem, AzureVmWorkloadSAPHanaSystemWorkloadItem, AzureVmWorkloadSQLDatabaseWorkloadItem, AzureVmWorkloadSQLInstanceWorkloadItem

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
workload_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if workload item is auto-protectable
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
sub_workload_item_count (int) – For instance or AG, indicates number of DB’s to be protected

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, parent_unique_name: str = None, server_name: str = None, is_auto_protectable: bool = None, is_auto_protected: bool = None, subinquireditemcount: int = None, subprotectableitemcount: int = None, prebackupvalidation=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.WorkloadProtectableItem

Azure VM workload-specific protectable item.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureVmWorkloadSAPAseSystemProtectableItem, AzureVmWorkloadSAPHanaDatabaseProtectableItem, AzureVmWorkloadSAPHanaSystemProtectableItem, AzureVmWorkloadSQLAvailabilityGroupProtectableItem, AzureVmWorkloadSQLDatabaseProtectableItem, AzureVmWorkloadSQLInstanceProtectableItem

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
parent_unique_name (str) – Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if protectable item is auto-protectable
is_auto_protected (bool) – Indicates if protectable item is auto-protected
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
subprotectableitemcount (int) – For instance or AG, indicates number of DB’s to be protected
prebackupvalidation (PreBackupValidation) – Pre-backup validation for protectable objects

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, server_name: str = None, parent_name: str = None, parent_type: str = None, protection_status: str = None, protection_state=None, last_backup_status=None, last_backup_time=None, last_backup_error_detail=None, protected_item_data_source_id: str = None, protected_item_health_status=None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectedItem

Azure VM workload-specific protected item.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureVmWorkloadSAPAseDatabaseProtectedItem, AzureVmWorkloadSAPHanaDatabaseProtectedItem, AzureVmWorkloadSQLDatabaseProtectedItem

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the DB represented by this backup item.
server_name (str) – Host/Cluster Name for instance or AG
parent_name (str) – Parent name of the DB such as Instance or Availability Group.
parent_type (str) – Parent type of protected item, example: for a DB, standalone server or distributed
protection_status (str) – Backup status of this backup item.
protection_state (str or ProtectionState) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
last_backup_status (str or LastBackupStatus) – Last backup operation status. Possible values: Healthy, Unhealthy. Possible values include: ‘Invalid’, ‘Healthy’, ‘Unhealthy’, ‘IRPending’
last_backup_time (datetime) – Timestamp of the last backup operation on this backup item.
last_backup_error_detail (ErrorDetail) – Error details in last backup
protected_item_data_source_id (str) – Data ID of the protected item.
protected_item_health_status (str or ProtectedItemHealthStatus) – Health status of the backup item, evaluated based on last heartbeat received. Possible values include: ‘Invalid’, ‘Healthy’, ‘Unhealthy’, ‘NotReachable’, ‘IRPending’
extended_info (AzureVmWorkloadProtectedItemExtendedInfo) – Additional information for this backup item.

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadProtectedItemExtendedInfo(*, oldest_recovery_point=None, recovery_point_count: int = None, policy_state: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information on Azure Workload for SQL specific backup item.

Parameters

oldest_recovery_point (datetime) – The oldest backup copy available for this backup item.
recovery_point_count (int) – Number of backup copies available for this backup item.
policy_state (str) – Indicates consistency of policy object and policy applied to this backup item.

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadProtectionPolicy(*, protected_items_count: int = None, work_load_type=None, settings=None, sub_protection_policy=None, make_policy_consistent: bool = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionPolicy

Azure VM (Mercury) workload-specific backup policy.

All required parameters must be populated in order to send to Azure.

Parameters

protected_items_count (int) – Number of items associated with this policy.
backup_management_type (str) – Required. Constant filled by server.
work_load_type (str or WorkloadType) – Type of workload for the backup management. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
settings (Settings) – Common settings for the backup management
sub_protection_policy (list[SubProtectionPolicy]) – List of sub-protection policies which includes schedule and retention
make_policy_consistent (bool) – Fix the policy inconsistency

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSAPAseDatabaseProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, server_name: str = None, parent_name: str = None, parent_type: str = None, protection_status: str = None, protection_state=None, last_backup_status=None, last_backup_time=None, last_backup_error_detail=None, protected_item_data_source_id: str = None, protected_item_health_status=None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadProtectedItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the DB represented by this backup item.
server_name (str) – Host/Cluster Name for instance or AG
parent_name (str) – Parent name of the DB such as Instance or Availability Group.
parent_type (str) – Parent type of protected item, example: for a DB, standalone server or distributed
protection_status (str) – Backup status of this backup item.
protection_state (str or ProtectionState) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
last_backup_status (str or LastBackupStatus) – Last backup operation status. Possible values: Healthy, Unhealthy. Possible values include: ‘Invalid’, ‘Healthy’, ‘Unhealthy’, ‘IRPending’
last_backup_time (datetime) – Timestamp of the last backup operation on this backup item.
last_backup_error_detail (ErrorDetail) – Error details in last backup
protected_item_data_source_id (str) – Data ID of the protected item.
protected_item_health_status (str or ProtectedItemHealthStatus) – Health status of the backup item, evaluated based on last heartbeat received. Possible values include: ‘Invalid’, ‘Healthy’, ‘Unhealthy’, ‘NotReachable’, ‘IRPending’
extended_info (AzureVmWorkloadProtectedItemExtendedInfo) – Additional information for this backup item.

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSAPAseDatabaseWorkloadItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, server_name: str = None, is_auto_protectable: bool = None, subinquireditemcount: int = None, sub_workload_item_count: int = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
workload_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if workload item is auto-protectable
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
sub_workload_item_count (int) – For instance or AG, indicates number of DB’s to be protected

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSAPAseSystemProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, parent_unique_name: str = None, server_name: str = None, is_auto_protectable: bool = None, is_auto_protected: bool = None, subinquireditemcount: int = None, subprotectableitemcount: int = None, prebackupvalidation=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadProtectableItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
parent_unique_name (str) – Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if protectable item is auto-protectable
is_auto_protected (bool) – Indicates if protectable item is auto-protected
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
subprotectableitemcount (int) – For instance or AG, indicates number of DB’s to be protected
prebackupvalidation (PreBackupValidation) – Pre-backup validation for protectable objects

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSAPAseSystemWorkloadItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, server_name: str = None, is_auto_protectable: bool = None, subinquireditemcount: int = None, sub_workload_item_count: int = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
workload_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if workload item is auto-protectable
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
sub_workload_item_count (int) – For instance or AG, indicates number of DB’s to be protected

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSAPHanaDatabaseProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, parent_unique_name: str = None, server_name: str = None, is_auto_protectable: bool = None, is_auto_protected: bool = None, subinquireditemcount: int = None, subprotectableitemcount: int = None, prebackupvalidation=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadProtectableItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
parent_unique_name (str) – Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if protectable item is auto-protectable
is_auto_protected (bool) – Indicates if protectable item is auto-protected
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
subprotectableitemcount (int) – For instance or AG, indicates number of DB’s to be protected
prebackupvalidation (PreBackupValidation) – Pre-backup validation for protectable objects

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSAPHanaDatabaseProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, server_name: str = None, parent_name: str = None, parent_type: str = None, protection_status: str = None, protection_state=None, last_backup_status=None, last_backup_time=None, last_backup_error_detail=None, protected_item_data_source_id: str = None, protected_item_health_status=None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadProtectedItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the DB represented by this backup item.
server_name (str) – Host/Cluster Name for instance or AG
parent_name (str) – Parent name of the DB such as Instance or Availability Group.
parent_type (str) – Parent type of protected item, example: for a DB, standalone server or distributed
protection_status (str) – Backup status of this backup item.
protection_state (str or ProtectionState) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
last_backup_status (str or LastBackupStatus) – Last backup operation status. Possible values: Healthy, Unhealthy. Possible values include: ‘Invalid’, ‘Healthy’, ‘Unhealthy’, ‘IRPending’
last_backup_time (datetime) – Timestamp of the last backup operation on this backup item.
last_backup_error_detail (ErrorDetail) – Error details in last backup
protected_item_data_source_id (str) – Data ID of the protected item.
protected_item_health_status (str or ProtectedItemHealthStatus) – Health status of the backup item, evaluated based on last heartbeat received. Possible values include: ‘Invalid’, ‘Healthy’, ‘Unhealthy’, ‘NotReachable’, ‘IRPending’
extended_info (AzureVmWorkloadProtectedItemExtendedInfo) – Additional information for this backup item.

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSAPHanaDatabaseWorkloadItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, server_name: str = None, is_auto_protectable: bool = None, subinquireditemcount: int = None, sub_workload_item_count: int = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
workload_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if workload item is auto-protectable
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
sub_workload_item_count (int) – For instance or AG, indicates number of DB’s to be protected

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSAPHanaSystemProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, parent_unique_name: str = None, server_name: str = None, is_auto_protectable: bool = None, is_auto_protected: bool = None, subinquireditemcount: int = None, subprotectableitemcount: int = None, prebackupvalidation=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadProtectableItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
parent_unique_name (str) – Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if protectable item is auto-protectable
is_auto_protected (bool) – Indicates if protectable item is auto-protected
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
subprotectableitemcount (int) – For instance or AG, indicates number of DB’s to be protected
prebackupvalidation (PreBackupValidation) – Pre-backup validation for protectable objects

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSAPHanaSystemWorkloadItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, server_name: str = None, is_auto_protectable: bool = None, subinquireditemcount: int = None, sub_workload_item_count: int = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
workload_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if workload item is auto-protectable
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
sub_workload_item_count (int) – For instance or AG, indicates number of DB’s to be protected

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSQLAvailabilityGroupProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, parent_unique_name: str = None, server_name: str = None, is_auto_protectable: bool = None, is_auto_protected: bool = None, subinquireditemcount: int = None, subprotectableitemcount: int = None, prebackupvalidation=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadProtectableItem

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

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
parent_unique_name (str) – Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if protectable item is auto-protectable
is_auto_protected (bool) – Indicates if protectable item is auto-protected
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
subprotectableitemcount (int) – For instance or AG, indicates number of DB’s to be protected
prebackupvalidation (PreBackupValidation) – Pre-backup validation for protectable objects

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSQLDatabaseProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, parent_unique_name: str = None, server_name: str = None, is_auto_protectable: bool = None, is_auto_protected: bool = None, subinquireditemcount: int = None, subprotectableitemcount: int = None, prebackupvalidation=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadProtectableItem

Azure VM workload-specific protectable item representing SQL Database.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
parent_unique_name (str) – Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if protectable item is auto-protectable
is_auto_protected (bool) – Indicates if protectable item is auto-protected
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
subprotectableitemcount (int) – For instance or AG, indicates number of DB’s to be protected
prebackupvalidation (PreBackupValidation) – Pre-backup validation for protectable objects

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSQLDatabaseProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, server_name: str = None, parent_name: str = None, parent_type: str = None, protection_status: str = None, protection_state=None, last_backup_status=None, last_backup_time=None, last_backup_error_detail=None, protected_item_data_source_id: str = None, protected_item_health_status=None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadProtectedItem

Azure VM workload-specific protected item representing SQL Database.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the DB represented by this backup item.
server_name (str) – Host/Cluster Name for instance or AG
parent_name (str) – Parent name of the DB such as Instance or Availability Group.
parent_type (str) – Parent type of protected item, example: for a DB, standalone server or distributed
protection_status (str) – Backup status of this backup item.
protection_state (str or ProtectionState) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
last_backup_status (str or LastBackupStatus) – Last backup operation status. Possible values: Healthy, Unhealthy. Possible values include: ‘Invalid’, ‘Healthy’, ‘Unhealthy’, ‘IRPending’
last_backup_time (datetime) – Timestamp of the last backup operation on this backup item.
last_backup_error_detail (ErrorDetail) – Error details in last backup
protected_item_data_source_id (str) – Data ID of the protected item.
protected_item_health_status (str or ProtectedItemHealthStatus) – Health status of the backup item, evaluated based on last heartbeat received. Possible values include: ‘Invalid’, ‘Healthy’, ‘Unhealthy’, ‘NotReachable’, ‘IRPending’
extended_info (AzureVmWorkloadProtectedItemExtendedInfo) – Additional information for this backup item.

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSQLDatabaseWorkloadItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, server_name: str = None, is_auto_protectable: bool = None, subinquireditemcount: int = None, sub_workload_item_count: int = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadItem

Azure VM workload-specific workload item representing SQL Database.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
workload_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if workload item is auto-protectable
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
sub_workload_item_count (int) – For instance or AG, indicates number of DB’s to be protected

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSQLInstanceProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, parent_unique_name: str = None, server_name: str = None, is_auto_protectable: bool = None, is_auto_protected: bool = None, subinquireditemcount: int = None, subprotectableitemcount: int = None, prebackupvalidation=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadProtectableItem

Azure VM workload-specific protectable item representing SQL Instance.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
parent_unique_name (str) – Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if protectable item is auto-protectable
is_auto_protected (bool) – Indicates if protectable item is auto-protected
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
subprotectableitemcount (int) – For instance or AG, indicates number of DB’s to be protected
prebackupvalidation (PreBackupValidation) – Pre-backup validation for protectable objects

class azure.mgmt.recoveryservicesbackup.models.AzureVmWorkloadSQLInstanceWorkloadItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, parent_name: str = None, server_name: str = None, is_auto_protectable: bool = None, subinquireditemcount: int = None, sub_workload_item_count: int = None, data_directory_paths=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureVmWorkloadItem

Azure VM workload-specific workload item representing SQL Instance.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
workload_item_type (str) – Required. Constant filled by server.
parent_name (str) – Name for instance or AG
server_name (str) – Host/Cluster Name for instance or AG
is_auto_protectable (bool) – Indicates if workload item is auto-protectable
subinquireditemcount (int) – For instance or AG, indicates number of DB’s present
sub_workload_item_count (int) – For instance or AG, indicates number of DB’s to be protected
data_directory_paths (list[SQLDataDirectory]) – Data Directory Paths for default directories

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadAutoProtectionIntent(*, backup_management_type=None, source_resource_id: str = None, item_id: str = None, policy_id: str = None, protection_state=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureRecoveryServiceVaultProtectionIntent

Azure Recovery Services Vault specific protection intent item.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureWorkloadSQLAutoProtectionIntent

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
source_resource_id (str) – ARM ID of the resource to be backed up.
item_id (str) – ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policy_id (str) – ID of the backup policy with which this item is backed up.
protection_state (str or ProtectionStatus) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protection_intent_item_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadBackupRequest(*, backup_type=None, enable_compression: bool = None, recovery_point_expiry_time_in_utc=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.BackupRequest

AzureWorkload workload-specific backup request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
backup_type (str or BackupType) – Type of backup, viz. Full, Differential, Log or CopyOnlyFull. Possible values include: ‘Invalid’, ‘Full’, ‘Differential’, ‘Log’, ‘CopyOnlyFull’
enable_compression (bool) – Bool for Compression setting
recovery_point_expiry_time_in_utc (datetime) – Backup copy will expire after the time specified (UTC).

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, source_resource_id: str = None, last_updated_time=None, extended_info=None, workload_type=None, operation_type=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionContainer

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureSQLAGWorkloadContainerProtectionContainer, AzureVMAppContainerProtectionContainer

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
source_resource_id (str) – ARM ID of the virtual machine represented by this Azure Workload Container
last_updated_time (datetime) – Time stamp when this container was updated.
extended_info (AzureWorkloadContainerExtendedInfo) – Additional details of a workload container.
workload_type (str or WorkloadType) – Workload type for which registration was sent. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
operation_type (str or OperationType) – Re-Do Operation. Possible values include: ‘Invalid’, ‘Register’, ‘Reregister’

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadContainerExtendedInfo(*, host_server_name: str = None, inquiry_info=None, nodes_list=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Extended information of the container.

Parameters

host_server_name (str) – Host Os Name in case of Stand Alone and Cluster Name in case of distributed container.
inquiry_info (InquiryInfo) – Inquiry Status for the container.
nodes_list (list[DistributedNodesInfo]) – List of the nodes in case of distributed container.

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadErrorInfo(*, error_code: int = None, error_string: str = None, error_title: str = None, recommendations=None, additional_details: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure storage specific error information.

Parameters

error_code (int) – Error code.
error_string (str) – Localized error string.
error_title (str) – Title: Typically, the entity that the error pertains to.
recommendations (list[str]) – List of localized recommendations for above error code.
additional_details (str) – Additional details for above error code.

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadJob(*, entity_friendly_name: str = None, backup_management_type=None, operation: str = None, status: str = None, start_time=None, end_time=None, activity_id: str = None, workload_type: str = None, duration=None, actions_info=None, error_details=None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Job

Azure storage specific job.

All required parameters must be populated in order to send to Azure.

Parameters

entity_friendly_name (str) – Friendly name of the entity on which the current job is executing.
backup_management_type (str or BackupManagementType) – Backup management type to execute the current job. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
operation (str) – The operation name.
status (str) – Job status.
start_time (datetime) – The start time.
end_time (datetime) – The end time.
activity_id (str) – ActivityId of job.
job_type (str) – Required. Constant filled by server.
workload_type (str) – Workload type of the job
duration (timedelta) – Time elapsed during the execution of this job.
actions_info (list[str or JobSupportedAction]) – Gets or sets the state/actions applicable on this job like cancel/retry.
error_details (list[AzureWorkloadErrorInfo]) – Error details on execution of this job.
extended_info (AzureWorkloadJobExtendedInfo) – Additional information about the job.

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadJobExtendedInfo(*, tasks_list=None, property_bag=None, dynamic_error_message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure VM workload-specific additional information for job.

Parameters

tasks_list (list[AzureWorkloadJobTaskDetails]) – List of tasks for this job
property_bag (dict[str, str]) – Job properties.
dynamic_error_message (str) – Non localized error message on job execution.

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadJobTaskDetails(*, task_id: str = None, status: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure VM workload specific job task details.

Parameters

task_id (str) – The task display name.
status (str) – The status.

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadPointInTimeRecoveryPoint(*, time_ranges=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadRecoveryPoint

Recovery point specific to PointInTime.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureWorkloadSAPHanaPointInTimeRecoveryPoint

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
time_ranges (list[PointInTimeRange]) – List of log ranges

Variables

recovery_point_time_in_utc (datetime) – UTC time at which recovery point was created
type (str or RestorePointType) – Type of restore point. Possible values include: ‘Invalid’, ‘Full’, ‘Log’, ‘Differential’

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadPointInTimeRestoreRequest(*, recovery_type=None, source_resource_id: str = None, property_bag=None, target_info=None, recovery_mode=None, point_in_time=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadRestoreRequest

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

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_type (str or RecoveryType) – Type of this recovery. Possible values include: ‘Invalid’, ‘OriginalLocation’, ‘AlternateLocation’, ‘RestoreDisks’, ‘Offline’
source_resource_id (str) – Fully qualified ARM ID of the VM on which workload that was running is being recovered.
property_bag (dict[str, str]) – Workload specific property bag.
target_info (TargetRestoreInfo) – Details of target database
recovery_mode (str or RecoveryMode) – Defines whether the current recovery mode is file restore or database restore. Possible values include: ‘Invalid’, ‘FileRecovery’, ‘WorkloadRecovery’
point_in_time (datetime) – PointInTime value

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadRecoveryPoint(**kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.RecoveryPoint

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureWorkloadPointInTimeRecoveryPoint, AzureWorkloadSAPHanaRecoveryPoint, AzureWorkloadSQLRecoveryPoint

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.

Variables

recovery_point_time_in_utc (datetime) – UTC time at which recovery point was created
type (str or RestorePointType) – Type of restore point. Possible values include: ‘Invalid’, ‘Full’, ‘Log’, ‘Differential’

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadRestoreRequest(*, recovery_type=None, source_resource_id: str = None, property_bag=None, target_info=None, recovery_mode=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.RestoreRequest

AzureWorkload-specific restore.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureWorkloadPointInTimeRestoreRequest, AzureWorkloadSAPHanaRestoreRequest, AzureWorkloadSQLRestoreRequest

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_type (str or RecoveryType) – Type of this recovery. Possible values include: ‘Invalid’, ‘OriginalLocation’, ‘AlternateLocation’, ‘RestoreDisks’, ‘Offline’
source_resource_id (str) – Fully qualified ARM ID of the VM on which workload that was running is being recovered.
property_bag (dict[str, str]) – Workload specific property bag.
target_info (TargetRestoreInfo) – Details of target database
recovery_mode (str or RecoveryMode) – Defines whether the current recovery mode is file restore or database restore. Possible values include: ‘Invalid’, ‘FileRecovery’, ‘WorkloadRecovery’

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadSAPHanaPointInTimeRecoveryPoint(*, time_ranges=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadPointInTimeRecoveryPoint

Recovery point specific to PointInTime in SAPHana.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
time_ranges (list[PointInTimeRange]) – List of log ranges

Variables

recovery_point_time_in_utc (datetime) – UTC time at which recovery point was created
type (str or RestorePointType) – Type of restore point. Possible values include: ‘Invalid’, ‘Full’, ‘Log’, ‘Differential’

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadSAPHanaPointInTimeRestoreRequest(*, recovery_type=None, source_resource_id: str = None, property_bag=None, target_info=None, recovery_mode=None, point_in_time=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadSAPHanaRestoreRequest

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

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_type (str or RecoveryType) – Type of this recovery. Possible values include: ‘Invalid’, ‘OriginalLocation’, ‘AlternateLocation’, ‘RestoreDisks’, ‘Offline’
source_resource_id (str) – Fully qualified ARM ID of the VM on which workload that was running is being recovered.
property_bag (dict[str, str]) – Workload specific property bag.
target_info (TargetRestoreInfo) – Details of target database
recovery_mode (str or RecoveryMode) – Defines whether the current recovery mode is file restore or database restore. Possible values include: ‘Invalid’, ‘FileRecovery’, ‘WorkloadRecovery’
point_in_time (datetime) – PointInTime value

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadSAPHanaRecoveryPoint(**kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadRecoveryPoint

SAPHana specific recoverypoint, specifically encapsulates full/diff recoverypoints.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.

Variables

recovery_point_time_in_utc (datetime) – UTC time at which recovery point was created
type (str or RestorePointType) – Type of restore point. Possible values include: ‘Invalid’, ‘Full’, ‘Log’, ‘Differential’

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadSAPHanaRestoreRequest(*, recovery_type=None, source_resource_id: str = None, property_bag=None, target_info=None, recovery_mode=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadRestoreRequest

AzureWorkload SAP Hana-specific restore.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureWorkloadSAPHanaPointInTimeRestoreRequest

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_type (str or RecoveryType) – Type of this recovery. Possible values include: ‘Invalid’, ‘OriginalLocation’, ‘AlternateLocation’, ‘RestoreDisks’, ‘Offline’
source_resource_id (str) – Fully qualified ARM ID of the VM on which workload that was running is being recovered.
property_bag (dict[str, str]) – Workload specific property bag.
target_info (TargetRestoreInfo) – Details of target database
recovery_mode (str or RecoveryMode) – Defines whether the current recovery mode is file restore or database restore. Possible values include: ‘Invalid’, ‘FileRecovery’, ‘WorkloadRecovery’

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadSQLAutoProtectionIntent(*, backup_management_type=None, source_resource_id: str = None, item_id: str = None, policy_id: str = None, protection_state=None, workload_item_type=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadAutoProtectionIntent

Azure Workload SQL Auto Protection intent item.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
source_resource_id (str) – ARM ID of the resource to be backed up.
item_id (str) – ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policy_id (str) – ID of the backup policy with which this item is backed up.
protection_state (str or ProtectionStatus) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protection_intent_item_type (str) – Required. Constant filled by server.
workload_item_type (str or WorkloadItemType) – Workload item type of the item for which intent is to be set. Possible values include: ‘Invalid’, ‘SQLInstance’, ‘SQLDataBase’, ‘SAPHanaSystem’, ‘SAPHanaDatabase’, ‘SAPAseSystem’, ‘SAPAseDatabase’

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadSQLPointInTimeRecoveryPoint(*, extended_info=None, time_ranges=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadSQLRecoveryPoint

Recovery point specific to PointInTime.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
extended_info (AzureWorkloadSQLRecoveryPointExtendedInfo) – Extended Info that provides data directory details. Will be populated in two cases: When a specific recovery point is accessed using GetRecoveryPoint Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter
time_ranges (list[PointInTimeRange]) – List of log ranges

Variables

recovery_point_time_in_utc (datetime) – UTC time at which recovery point was created
type (str or RestorePointType) – Type of restore point. Possible values include: ‘Invalid’, ‘Full’, ‘Log’, ‘Differential’

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadSQLPointInTimeRestoreRequest(*, recovery_type=None, source_resource_id: str = None, property_bag=None, target_info=None, recovery_mode=None, should_use_alternate_target_location: bool = None, is_non_recoverable: bool = None, alternate_directory_paths=None, point_in_time=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadSQLRestoreRequest

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

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_type (str or RecoveryType) – Type of this recovery. Possible values include: ‘Invalid’, ‘OriginalLocation’, ‘AlternateLocation’, ‘RestoreDisks’, ‘Offline’
source_resource_id (str) – Fully qualified ARM ID of the VM on which workload that was running is being recovered.
property_bag (dict[str, str]) – Workload specific property bag.
target_info (TargetRestoreInfo) – Details of target database
recovery_mode (str or RecoveryMode) – Defines whether the current recovery mode is file restore or database restore. Possible values include: ‘Invalid’, ‘FileRecovery’, ‘WorkloadRecovery’
should_use_alternate_target_location (bool) – Default option set to true. If this is set to false, alternate data directory must be provided
is_non_recoverable (bool) – SQL specific property where user can chose to set no-recovery when restore operation is tried
alternate_directory_paths (list[SQLDataDirectoryMapping]) – Data directory details
point_in_time (datetime) – PointInTime value

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadSQLRecoveryPoint(*, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadRecoveryPoint

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureWorkloadSQLPointInTimeRecoveryPoint

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
extended_info (AzureWorkloadSQLRecoveryPointExtendedInfo) – Extended Info that provides data directory details. Will be populated in two cases: When a specific recovery point is accessed using GetRecoveryPoint Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter

Variables

recovery_point_time_in_utc (datetime) – UTC time at which recovery point was created
type (str or RestorePointType) – Type of restore point. Possible values include: ‘Invalid’, ‘Full’, ‘Log’, ‘Differential’

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadSQLRecoveryPointExtendedInfo(**kwargs)[source]¶

Bases: msrest.serialization.Model

Extended info class details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

data_directory_time_in_utc (datetime) – UTC time at which data directory info was captured
data_directory_paths (list[SQLDataDirectory]) – List of data directory paths during restore operation.

class azure.mgmt.recoveryservicesbackup.models.AzureWorkloadSQLRestoreRequest(*, recovery_type=None, source_resource_id: str = None, property_bag=None, target_info=None, recovery_mode=None, should_use_alternate_target_location: bool = None, is_non_recoverable: bool = None, alternate_directory_paths=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.AzureWorkloadRestoreRequest

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureWorkloadSQLPointInTimeRestoreRequest

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_type (str or RecoveryType) – Type of this recovery. Possible values include: ‘Invalid’, ‘OriginalLocation’, ‘AlternateLocation’, ‘RestoreDisks’, ‘Offline’
source_resource_id (str) – Fully qualified ARM ID of the VM on which workload that was running is being recovered.
property_bag (dict[str, str]) – Workload specific property bag.
target_info (TargetRestoreInfo) – Details of target database
recovery_mode (str or RecoveryMode) – Defines whether the current recovery mode is file restore or database restore. Possible values include: ‘Invalid’, ‘FileRecovery’, ‘WorkloadRecovery’
should_use_alternate_target_location (bool) – Default option set to true. If this is set to false, alternate data directory must be provided
is_non_recoverable (bool) – SQL specific property where user can chose to set no-recovery when restore operation is tried
alternate_directory_paths (list[SQLDataDirectoryMapping]) – Data directory details

class azure.mgmt.recoveryservicesbackup.models.BackupEngineBase(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, backup_engine_state: str = None, health_status: str = None, can_re_register: bool = None, backup_engine_id: str = None, dpm_version: str = None, azure_backup_agent_version: str = None, is_azure_backup_agent_upgrade_available: bool = None, is_dpm_upgrade_available: bool = None, extended_info=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The base backup engine class. All workload specific backup engines derive from this class.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureBackupServerEngine, DpmBackupEngine

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the backup engine.
backup_management_type (str or BackupManagementType) – Type of backup management for the backup engine. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Registration status of the backup engine with the Recovery Services Vault.
backup_engine_state (str) – Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}
health_status (str) – Backup status of the backup engine.
can_re_register (bool) – Flag indicating if the backup engine be registered, once already registered.
backup_engine_id (str) – ID of the backup engine.
dpm_version (str) – Backup engine version
azure_backup_agent_version (str) – Backup agent version
is_azure_backup_agent_upgrade_available (bool) – To check if backup agent upgrade available
is_dpm_upgrade_available (bool) – To check if backup engine upgrade available
extended_info (BackupEngineExtendedInfo) – Extended info of the backupengine
backup_engine_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.BackupEngineBaseResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

The base backup engine class. All workload specific backup engines derive from this class.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (BackupEngineBase) – BackupEngineBaseResource properties

class azure.mgmt.recoveryservicesbackup.models.BackupEngineExtendedInfo(*, database_name: str = None, protected_items_count: int = None, protected_servers_count: int = None, disk_count: int = None, used_disk_space: float = None, available_disk_space: float = None, refreshed_at=None, azure_protected_instances: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information on backup engine.

Parameters

database_name (str) – Database name of backup engine.
protected_items_count (int) – Number of protected items in the backup engine.
protected_servers_count (int) – Number of protected servers in the backup engine.
disk_count (int) – Number of disks in the backup engine.
used_disk_space (float) – Disk space used in the backup engine.
available_disk_space (float) – Disk space currently available in the backup engine.
refreshed_at (datetime) – Last refresh time in the backup engine.
azure_protected_instances (int) – Protected instances in the backup engine.

class azure.mgmt.recoveryservicesbackup.models.BackupManagementUsage(*, unit=None, quota_period: str = None, next_reset_time=None, current_value: int = None, limit: int = None, name=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Backup management usages of a vault.

Parameters

unit (str or UsagesUnit) – Unit of the usage. Possible values include: ‘Count’, ‘Bytes’, ‘Seconds’, ‘Percent’, ‘CountPerSecond’, ‘BytesPerSecond’
quota_period (str) – Quota period of usage.
next_reset_time (datetime) – Next reset time of usage.
current_value (long) – Current value of usage.
limit (long) – Limit of usage.
name (NameInfo) – Name of usage.

class azure.mgmt.recoveryservicesbackup.models.BackupRequest(**kwargs)[source]¶

Bases: msrest.serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureFileShareBackupRequest, AzureWorkloadBackupRequest, IaasVMBackupRequest

All required parameters must be populated in order to send to Azure.

Parameters: object_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.BackupRequestResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (BackupRequest) – BackupRequestResource properties

class azure.mgmt.recoveryservicesbackup.models.BackupResourceConfig(*, storage_model_type=None, storage_type=None, storage_type_state=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The resource storage details.

Parameters

storage_model_type (str or StorageType) – Storage type. Possible values include: ‘Invalid’, ‘GeoRedundant’, ‘LocallyRedundant’
storage_type (str or StorageType) – Storage type. Possible values include: ‘Invalid’, ‘GeoRedundant’, ‘LocallyRedundant’
storage_type_state (str or StorageTypeState) – Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. Possible values include: ‘Invalid’, ‘Locked’, ‘Unlocked’

class azure.mgmt.recoveryservicesbackup.models.BackupResourceConfigResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

The resource storage details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (BackupResourceConfig) – BackupResourceConfigResource properties

class azure.mgmt.recoveryservicesbackup.models.BackupResourceVaultConfig(*, storage_model_type=None, storage_type=None, storage_type_state=None, enhanced_security_state=None, soft_delete_feature_state=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Backup resource vault config details.

Parameters

storage_model_type (str or StorageType) – Storage type. Possible values include: ‘Invalid’, ‘GeoRedundant’, ‘LocallyRedundant’
storage_type (str or StorageType) – Storage type. Possible values include: ‘Invalid’, ‘GeoRedundant’, ‘LocallyRedundant’
storage_type_state (str or StorageTypeState) – Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. Possible values include: ‘Invalid’, ‘Locked’, ‘Unlocked’
enhanced_security_state (str or EnhancedSecurityState) – Enabled or Disabled. Possible values include: ‘Invalid’, ‘Enabled’, ‘Disabled’
soft_delete_feature_state (str or SoftDeleteFeatureState) – Soft Delete feature state. Possible values include: ‘Invalid’, ‘Enabled’, ‘Disabled’

class azure.mgmt.recoveryservicesbackup.models.BackupResourceVaultConfigResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

Backup resource vault config details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (BackupResourceVaultConfig) – BackupResourceVaultConfigResource properties

class azure.mgmt.recoveryservicesbackup.models.BackupStatusRequest(*, resource_type=None, resource_id: str = None, po_logical_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

BackupStatus request.

Parameters

resource_type (str or DataSourceType) – Container Type - VM, SQLPaaS, DPM, AzureFileShare. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
resource_id (str) – Entire ARM resource id of the resource
po_logical_name (str) – Protectable Item Logical Name

class azure.mgmt.recoveryservicesbackup.models.BackupStatusResponse(*, protection_status=None, vault_id: str = None, fabric_name=None, container_name: str = None, protected_item_name: str = None, error_code: str = None, error_message: str = None, policy_name: str = None, registration_status: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

BackupStatus response.

Parameters

protection_status (str or ProtectionStatus) – Specifies whether the container is registered or not. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
vault_id (str) – Specifies the arm resource id of the vault
fabric_name (str or FabricName) – Specifies the fabric name - Azure or AD. Possible values include: ‘Invalid’, ‘Azure’
container_name (str) – Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname.
protected_item_name (str) – Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname.
error_code (str) – ErrorCode in case of intent failed
error_message (str) – ErrorMessage in case of intent failed.
policy_name (str) – Specifies the policy name which is used for protection
registration_status (str) – Container registration status

class azure.mgmt.recoveryservicesbackup.models.BEKDetails(*, secret_url: str = None, secret_vault_id: str = None, secret_data: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

BEK is bitlocker encryption key.

Parameters

secret_url (str) – Secret is BEK.
secret_vault_id (str) – ID of the Key Vault where this Secret is stored.
secret_data (str) – BEK data.

class azure.mgmt.recoveryservicesbackup.models.BMSBackupEngineQueryObject(*, expand: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Query parameters to fetch list of backup engines.

Parameters: expand (str) – attribute to add extended info

class azure.mgmt.recoveryservicesbackup.models.BMSBackupEnginesQueryObject(*, backup_management_type=None, friendly_name: str = None, expand: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Query parameters to fetch list of backup engines.

Parameters

backup_management_type (str or BackupManagementType) – Backup management type for the backup engine. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
friendly_name (str) – Friendly name of the backup engine.
expand (str) – Attribute to add extended info.

class azure.mgmt.recoveryservicesbackup.models.BMSBackupSummariesQueryObject(*, type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Query parameters to fetch backup summaries.

Parameters: type (str or Type) – Backup management type for this container. Possible values include: ‘Invalid’, ‘BackupProtectedItemCountSummary’, ‘BackupProtectionContainerCountSummary’

class azure.mgmt.recoveryservicesbackup.models.BMSContainerQueryObject(*, backup_management_type, container_type=None, backup_engine_name: str = None, fabric_name: str = None, status: str = None, friendly_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The query filters that can be used with the list containers API.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Required. Backup management type for this container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
container_type (str or ContainerType) – Type of container for filter. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’, ‘VMAppContainer’, ‘SQLAGWorkLoadContainer’, ‘StorageContainer’, ‘GenericContainer’
backup_engine_name (str) – Backup engine name
fabric_name (str) – Fabric name for filter
status (str) – Status of registration of this container with the Recovery Services Vault.
friendly_name (str) – Friendly name of this container.

class azure.mgmt.recoveryservicesbackup.models.BMSContainersInquiryQueryObject(*, backup_management_type=None, workload_type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The query filters that can be used with the inquire container API.

Parameters

backup_management_type (str or BackupManagementType) – Backup management type for this container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or WorkloadType) – Workload type for this container. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’

class azure.mgmt.recoveryservicesbackup.models.BMSPOQueryObject(*, backup_management_type=None, workload_type=None, container_name: str = None, status: str = None, friendly_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Filters to list items that can be backed up.

Parameters

backup_management_type (str or BackupManagementType) – Backup management type. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or WorkloadType) – Workload type. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Full name of the container whose Protectable Objects should be returned.
status (str) – Backup status query parameter.
friendly_name (str) – Friendly name.

class azure.mgmt.recoveryservicesbackup.models.BMSRefreshContainersQueryObject(*, backup_management_type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The query filters that can be used with the refresh container API.

Parameters: backup_management_type (str or BackupManagementType) – Backup management type for this container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’

class azure.mgmt.recoveryservicesbackup.models.BMSRPQueryObject(*, start_date=None, end_date=None, restore_point_query_type=None, extended_info: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Filters to list backup copies.

Parameters

start_date (datetime) – Backup copies created after this time.
end_date (datetime) – Backup copies created before this time.
restore_point_query_type (str or RestorePointQueryType) – RestorePoint type. Possible values include: ‘Invalid’, ‘Full’, ‘Log’, ‘Differential’, ‘FullAndDifferential’, ‘All’
extended_info (bool) – In Get Recovery Point, it tells whether extended information about recovery point is asked.

class azure.mgmt.recoveryservicesbackup.models.BMSWorkloadItemQueryObject(*, backup_management_type=None, workload_item_type=None, workload_type=None, protection_status=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Filters to list items that can be backed up.

Parameters

backup_management_type (str or BackupManagementType) – Backup management type. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_item_type (str or WorkloadItemType) – Workload Item type. Possible values include: ‘Invalid’, ‘SQLInstance’, ‘SQLDataBase’, ‘SAPHanaSystem’, ‘SAPHanaDatabase’, ‘SAPAseSystem’, ‘SAPAseDatabase’
workload_type (str or WorkloadType) – Workload type. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
protection_status (str or ProtectionStatus) – Backup status query parameter. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’

class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryDisplay(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Localized display information of an operation.

Parameters

provider (str) – Name of the provider for display purposes
resource (str) – ResourceType for which this Operation can be performed.
operation (str) – Operations Name itself.
description (str) – Description of the operation having details of what operation is about.

class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryForLogSpecification(*, name: str = None, display_name: str = None, blob_duration: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Class to represent shoebox log specification in json client discovery.

Parameters

name (str) – Name for shoebox log specification.
display_name (str) – Localized display name
blob_duration (str) – blob duration of shoebox log specification

class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryForProperties(*, service_specification=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Class to represent shoebox properties in json client discovery.

Parameters: service_specification (ClientDiscoveryForServiceSpecification) – Operation properties.

class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryForServiceSpecification(*, log_specifications=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Class to represent shoebox service specification in json client discovery.

Parameters: log_specifications (list[ClientDiscoveryForLogSpecification]) – List of log specifications of this operation.

class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryValueForSingleApi(*, name: str = None, display=None, origin: str = None, properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Available operation details.

Parameters

name (str) – Name of the Operation.
display (ClientDiscoveryDisplay) – Contains the localized display information for this particular operation
origin (str) – The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX
properties (ClientDiscoveryForProperties) – ShoeBox properties for the given operation.

class azure.mgmt.recoveryservicesbackup.models.ClientScriptForConnect(*, script_content: str = None, script_extension: str = None, os_type: str = None, url: str = None, script_name_suffix: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Client script details for file / folder restore.

Parameters

script_content (str) – File content of the client script for file / folder restore.
script_extension (str) – File extension of the client script for file / folder restore - .ps1 , .sh , etc.
os_type (str) – OS type - Windows, Linux etc. for which this file / folder restore client script works.
url (str) – URL of Executable from where to source the content. If this is not null then ScriptContent should not be used
script_name_suffix (str) – Mandatory suffix that should be added to the name of script that is given for download to user. If its null or empty then , ignore it.

class azure.mgmt.recoveryservicesbackup.models.ContainerIdentityInfo(*, unique_name: str = None, aad_tenant_id: str = None, service_principal_client_id: str = None, audience: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Container identity information.

Parameters

unique_name (str) – Unique name of the container
aad_tenant_id (str) – Protection container identity - AAD Tenant
service_principal_client_id (str) – Protection container identity - AAD Service Principal
audience (str) – Protection container identity - Audience

class azure.mgmt.recoveryservicesbackup.models.DailyRetentionFormat(*, days_of_the_month=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Daily retention format.

Parameters: days_of_the_month (list[Day]) – List of days of the month.

class azure.mgmt.recoveryservicesbackup.models.DailyRetentionSchedule(*, retention_times=None, retention_duration=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Daily retention schedule.

Parameters

retention_times (list[datetime]) – Retention times of retention policy.
retention_duration (RetentionDuration) – Retention duration of retention Policy.

class azure.mgmt.recoveryservicesbackup.models.Day(*, date_property: int = None, is_last: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Day of the week.

Parameters

date_property (int) – Date of the month
is_last (bool) – Whether Date is last date of month

class azure.mgmt.recoveryservicesbackup.models.DiskExclusionProperties(*, disk_lun_list=None, is_inclusion_list: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

DiskExclusionProperties.

Parameters

disk_lun_list (list[int]) – List of Disks’ Logical Unit Numbers (LUN) to be used for VM Protection.
is_inclusion_list (bool) – Flag to indicate whether DiskLunList is to be included/ excluded from backup.

class azure.mgmt.recoveryservicesbackup.models.DiskInformation(*, lun: int = None, name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Disk information.

Parameters

lun (int) –
name (str) –

class azure.mgmt.recoveryservicesbackup.models.DistributedNodesInfo(*, node_name: str = None, status: str = None, error_detail=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

Parameters

node_name (str) – Name of the node under a distributed container.
status (str) – Status of this Node. Failed | Succeeded
error_detail (ErrorDetail) – Error Details if the Status is non-success.

class azure.mgmt.recoveryservicesbackup.models.DpmBackupEngine(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, backup_engine_state: str = None, health_status: str = None, can_re_register: bool = None, backup_engine_id: str = None, dpm_version: str = None, azure_backup_agent_version: str = None, is_azure_backup_agent_upgrade_available: bool = None, is_dpm_upgrade_available: bool = None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.BackupEngineBase

Data Protection Manager (DPM) specific backup engine.

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the backup engine.
backup_management_type (str or BackupManagementType) – Type of backup management for the backup engine. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Registration status of the backup engine with the Recovery Services Vault.
backup_engine_state (str) – Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}
health_status (str) – Backup status of the backup engine.
can_re_register (bool) – Flag indicating if the backup engine be registered, once already registered.
backup_engine_id (str) – ID of the backup engine.
dpm_version (str) – Backup engine version
azure_backup_agent_version (str) – Backup agent version
is_azure_backup_agent_upgrade_available (bool) – To check if backup agent upgrade available
is_dpm_upgrade_available (bool) – To check if backup engine upgrade available
extended_info (BackupEngineExtendedInfo) – Extended info of the backupengine
backup_engine_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.DpmContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, can_re_register: bool = None, container_id: str = None, protected_item_count: int = None, dpm_agent_version: str = None, dpm_servers=None, upgrade_available: bool = None, protection_status: str = None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionContainer

DPM workload-specific protection container.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureBackupServerContainer

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
can_re_register (bool) – Specifies whether the container is re-registrable.
container_id (str) – ID of container.
protected_item_count (long) – Number of protected items in the BackupEngine
dpm_agent_version (str) – Backup engine Agent version
dpm_servers (list[str]) – List of BackupEngines protecting the container
upgrade_available (bool) – To check if upgrade available
protection_status (str) – Protection status of the container.
extended_info (DPMContainerExtendedInfo) – Extended Info of the container.

class azure.mgmt.recoveryservicesbackup.models.DPMContainerExtendedInfo(*, last_refreshed_at=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information of the DPMContainer.

Parameters: last_refreshed_at (datetime) – Last refresh time of the DPMContainer.

class azure.mgmt.recoveryservicesbackup.models.DpmErrorInfo(*, error_string: str = None, recommendations=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

DPM workload-specific error information.

Parameters

error_string (str) – Localized error string.
recommendations (list[str]) – List of localized recommendations for above error code.

class azure.mgmt.recoveryservicesbackup.models.DpmJob(*, entity_friendly_name: str = None, backup_management_type=None, operation: str = None, status: str = None, start_time=None, end_time=None, activity_id: str = None, duration=None, dpm_server_name: str = None, container_name: str = None, container_type: str = None, workload_type: str = None, actions_info=None, error_details=None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Job

DPM workload-specific job object.

All required parameters must be populated in order to send to Azure.

Parameters

entity_friendly_name (str) – Friendly name of the entity on which the current job is executing.
backup_management_type (str or BackupManagementType) – Backup management type to execute the current job. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
operation (str) – The operation name.
status (str) – Job status.
start_time (datetime) – The start time.
end_time (datetime) – The end time.
activity_id (str) – ActivityId of job.
job_type (str) – Required. Constant filled by server.
duration (timedelta) – Time elapsed for job.
dpm_server_name (str) – DPM server name managing the backup item or backup job.
container_name (str) – Name of cluster/server protecting current backup item, if any.
container_type (str) – Type of container.
workload_type (str) – Type of backup item.
actions_info (list[str or JobSupportedAction]) – The state/actions applicable on this job like cancel/retry.
error_details (list[DpmErrorInfo]) – The errors.
extended_info (DpmJobExtendedInfo) – Additional information for this job.

class azure.mgmt.recoveryservicesbackup.models.DpmJobExtendedInfo(*, tasks_list=None, property_bag=None, dynamic_error_message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information on the DPM workload-specific job.

Parameters

tasks_list (list[DpmJobTaskDetails]) – List of tasks associated with this job.
property_bag (dict[str, str]) – The job properties.
dynamic_error_message (str) – Non localized error message on job execution.

class azure.mgmt.recoveryservicesbackup.models.DpmJobTaskDetails(*, task_id: str = None, start_time=None, end_time=None, duration=None, status: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

DPM workload-specific job task details.

Parameters

task_id (str) – The task display name.
start_time (datetime) – The start time.
end_time (datetime) – The end time.
duration (timedelta) – Time elapsed for task.
status (str) – The status.

class azure.mgmt.recoveryservicesbackup.models.DPMProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, backup_engine_name: str = None, protection_state=None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectedItem

Additional information on Backup engine specific backup item.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the managed item
backup_engine_name (str) – Backup Management server protecting this backup item
protection_state (str or ProtectedItemState) – Protection state of the backup engine. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
extended_info (DPMProtectedItemExtendedInfo) – Extended info of the backup item.

class azure.mgmt.recoveryservicesbackup.models.DPMProtectedItemExtendedInfo(*, protectable_object_load_path=None, protected: bool = None, is_present_on_cloud: bool = None, last_backup_status: str = None, last_refreshed_at=None, oldest_recovery_point=None, recovery_point_count: int = None, on_premise_oldest_recovery_point=None, on_premise_latest_recovery_point=None, on_premise_recovery_point_count: int = None, is_collocated: bool = None, protection_group_name: str = None, disk_storage_used_in_bytes: str = None, total_disk_storage_size_in_bytes: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information of DPM Protected item.

Parameters

protectable_object_load_path (dict[str, str]) – Attribute to provide information on various DBs.
protected (bool) – To check if backup item is disk protected.
is_present_on_cloud (bool) – To check if backup item is cloud protected.
last_backup_status (str) – Last backup status information on backup item.
last_refreshed_at (datetime) – Last refresh time on backup item.
oldest_recovery_point (datetime) – Oldest cloud recovery point time.
recovery_point_count (int) – cloud recovery point count.
on_premise_oldest_recovery_point (datetime) – Oldest disk recovery point time.
on_premise_latest_recovery_point (datetime) – latest disk recovery point time.
on_premise_recovery_point_count (int) – disk recovery point count.
is_collocated (bool) – To check if backup item is collocated.
protection_group_name (str) – Protection group name of the backup item.
disk_storage_used_in_bytes (str) – Used Disk storage in bytes.
total_disk_storage_size_in_bytes (str) – total Disk storage in bytes.

class azure.mgmt.recoveryservicesbackup.models.EncryptionDetails(*, encryption_enabled: bool = None, kek_url: str = None, secret_key_url: str = None, kek_vault_id: str = None, secret_key_vault_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

Parameters

encryption_enabled (bool) – Identifies whether this backup copy represents an encrypted VM at the time of backup.
kek_url (str) – Key Url.
secret_key_url (str) – Secret Url.
kek_vault_id (str) – ID of Key Vault where KEK is stored.
secret_key_vault_id (str) – ID of Key Vault where Secret is stored.

class azure.mgmt.recoveryservicesbackup.models.ErrorDetail(**kwargs)[source]¶

Bases: msrest.serialization.Model

Error Detail class which encapsulates Code, Message and Recommendations.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

code (str) – Error code.
message (str) – Error Message related to the Code.
recommendations (list[str]) – List of recommendation strings.

class azure.mgmt.recoveryservicesbackup.models.ExportJobsOperationResultInfo(*, blob_url: str = None, blob_sas_key: str = None, excel_file_blob_url: str = None, excel_file_blob_sas_key: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.OperationResultInfoBase

This class is used to send blob details after exporting jobs.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
blob_url (str) – URL of the blob into which the serialized string of list of jobs is exported.
blob_sas_key (str) – SAS key to access the blob. It expires in 15 mins.
excel_file_blob_url (str) – URL of the blob into which the ExcelFile is uploaded.
excel_file_blob_sas_key (str) – SAS key to access the blob. It expires in 15 mins.

class azure.mgmt.recoveryservicesbackup.models.ExtendedProperties(*, disk_exclusion_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Extended Properties for Azure IaasVM Backup.

Parameters: disk_exclusion_properties (DiskExclusionProperties) – Extended Properties for Disk Exclusion.

class azure.mgmt.recoveryservicesbackup.models.FeatureSupportRequest(**kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for feature request.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureBackupGoalFeatureSupportRequest, AzureVMResourceFeatureSupportRequest

All required parameters must be populated in order to send to Azure.

Parameters: feature_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.GenericContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, fabric_name: str = None, extended_information=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionContainer

Base class for generic container of backup items.

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
fabric_name (str) – Name of the container’s fabric
extended_information (GenericContainerExtendedInfo) – Extended information (not returned in List container API calls)

class azure.mgmt.recoveryservicesbackup.models.GenericContainerExtendedInfo(*, raw_cert_data: str = None, container_identity_info=None, service_endpoints=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Container extended information.

Parameters

raw_cert_data (str) – Public key of container cert
container_identity_info (ContainerIdentityInfo) – Container identity information
service_endpoints (dict[str, str]) – Azure Backup Service Endpoints for the container

class azure.mgmt.recoveryservicesbackup.models.GenericProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, policy_state: str = None, protection_state=None, protected_item_id: int = None, source_associations=None, fabric_name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectedItem

Base class for backup items.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the container.
policy_state (str) – Indicates consistency of policy object and policy applied to this backup item.
protection_state (str or ProtectionState) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
protected_item_id (long) – Data Plane Service ID of the protected item.
source_associations (dict[str, str]) – Loosely coupled (type, value) associations (example - parent of a protected item)
fabric_name (str) – Name of this backup item’s fabric.

class azure.mgmt.recoveryservicesbackup.models.GenericProtectionPolicy(*, protected_items_count: int = None, sub_protection_policy=None, time_zone: str = None, fabric_name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionPolicy

Azure VM (Mercury) workload-specific backup policy.

All required parameters must be populated in order to send to Azure.

Parameters

protected_items_count (int) – Number of items associated with this policy.
backup_management_type (str) – Required. Constant filled by server.
sub_protection_policy (list[SubProtectionPolicy]) – List of sub-protection policies which includes schedule and retention
time_zone (str) – TimeZone optional input as string. For example: TimeZone = “Pacific Standard Time”.
fabric_name (str) – Name of this policy’s fabric.

class azure.mgmt.recoveryservicesbackup.models.GenericRecoveryPoint(*, friendly_name: str = None, recovery_point_type: str = None, recovery_point_time=None, recovery_point_additional_info: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.RecoveryPoint

Generic backup copy.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of the backup copy.
recovery_point_type (str) – Type of the backup copy.
recovery_point_time (datetime) – Time at which this backup copy was created.
recovery_point_additional_info (str) – Additional information associated with this backup copy.

class azure.mgmt.recoveryservicesbackup.models.GetProtectedItemQueryObject(*, expand: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Filters to list backup items.

Parameters: expand (str) – Specifies if the additional information should be provided for this item.

class azure.mgmt.recoveryservicesbackup.models.IaasVMBackupRequest(*, recovery_point_expiry_time_in_utc=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.BackupRequest

IaaS VM workload-specific backup request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_point_expiry_time_in_utc (datetime) – Backup copy will expire after the time specified (UTC).

class azure.mgmt.recoveryservicesbackup.models.IaaSVMContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, virtual_machine_id: str = None, virtual_machine_version: str = None, resource_group: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionContainer

IaaS VM workload-specific container.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureIaaSClassicComputeVMContainer, AzureIaaSComputeVMContainer

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
virtual_machine_id (str) – Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.
virtual_machine_version (str) – Specifies whether the container represents a Classic or an Azure Resource Manager VM.
resource_group (str) – Resource group name of Recovery Services Vault.

class azure.mgmt.recoveryservicesbackup.models.IaasVMILRRegistrationRequest(*, recovery_point_id: str = None, virtual_machine_id: str = None, initiator_name: str = None, renew_existing_registration: bool = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ILRRequest

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

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_point_id (str) – ID of the IaaS VM backup copy from where the files/folders have to be restored.
virtual_machine_id (str) – Fully qualified ARM ID of the virtual machine whose the files / folders have to be restored.
initiator_name (str) – iSCSI initiator name.
renew_existing_registration (bool) – Whether to renew existing registration with the iSCSI server.

class azure.mgmt.recoveryservicesbackup.models.IaaSVMProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, virtual_machine_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.WorkloadProtectableItem

IaaS VM workload-specific backup item.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureIaaSClassicComputeVMProtectableItem, AzureIaaSComputeVMProtectableItem

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.
virtual_machine_id (str) – Fully qualified ARM ID of the virtual machine.

class azure.mgmt.recoveryservicesbackup.models.IaasVMRecoveryPoint(*, key_and_secret=None, is_instant_ilr_session_active: bool = None, recovery_point_tier_details=None, is_managed_virtual_machine: bool = None, virtual_machine_size: str = None, original_storage_account_option: bool = None, os_type: str = None, recovery_point_disk_configuration=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.RecoveryPoint

IaaS VM workload specific backup copy.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
key_and_secret (KeyAndSecretDetails) – Required details for recovering an encrypted VM. Applicable only when IsSourceVMEncrypted is true.
is_instant_ilr_session_active (bool) – Is the session to recover items from this backup copy still active.
recovery_point_tier_details (list[RecoveryPointTierInformation]) – Recovery point tier information.
is_managed_virtual_machine (bool) – Whether VM is with Managed Disks
virtual_machine_size (str) – Virtual Machine Size
original_storage_account_option (bool) – Original Storage Account Option
os_type (str) – OS type
recovery_point_disk_configuration (RecoveryPointDiskConfiguration) – Disk configuration

Variables

recovery_point_type (str) – Type of the backup copy.
recovery_point_time (datetime) – Time at which this backup copy was created.
recovery_point_additional_info (str) – Additional information associated with this backup copy.
source_vm_storage_type (str) – Storage type of the VM whose backup copy is created.
is_source_vm_encrypted (bool) – Identifies whether the VM was encrypted when the backup copy is created.

class azure.mgmt.recoveryservicesbackup.models.IaasVMRestoreRequest(*, recovery_point_id: str = None, recovery_type=None, source_resource_id: str = None, target_virtual_machine_id: str = None, target_resource_group_id: str = None, storage_account_id: str = None, virtual_network_id: str = None, subnet_id: str = None, target_domain_name_id: str = None, region: str = None, affinity_group: str = None, create_new_cloud_service: bool = None, original_storage_account_option: bool = None, encryption_details=None, restore_disk_lun_list=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.RestoreRequest

IaaS VM workload-specific restore.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_point_id (str) – ID of the backup copy to be recovered.
recovery_type (str or RecoveryType) – Type of this recovery. Possible values include: ‘Invalid’, ‘OriginalLocation’, ‘AlternateLocation’, ‘RestoreDisks’, ‘Offline’
source_resource_id (str) – Fully qualified ARM ID of the VM which is being recovered.
target_virtual_machine_id (str) – This is the complete ARM Id of the VM that will be created. For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
target_resource_group_id (str) – This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts. For e.g. /subscriptions/{subId}/resourcegroups/{rg}
storage_account_id (str) – Fully qualified ARM ID of the storage account to which the VM has to be restored.
virtual_network_id (str) – This is the virtual network Id of the vnet that will be attached to the virtual machine. User will be validated for join action permissions in the linked access.
subnet_id (str) – Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent the subnet.
target_domain_name_id (str) – Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic Virtual Machines.
region (str) – Region in which the virtual machine is restored.
affinity_group (str) – Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.
create_new_cloud_service (bool) – Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same cloud service as it was at the time of backup.
original_storage_account_option (bool) – Original Storage Account Option
encryption_details (EncryptionDetails) – Details needed if the VM was encrypted at the time of backup.
restore_disk_lun_list (list[int]) – List of Disk LUNs for partial restore

class azure.mgmt.recoveryservicesbackup.models.ILRRequest(**kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters to Provision ILR API.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureFileShareProvisionILRRequest, IaasVMILRRegistrationRequest

All required parameters must be populated in order to send to Azure.

Parameters: object_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.ILRRequestResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

Parameters to Provision ILR API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (ILRRequest) – ILRRequestResource properties

class azure.mgmt.recoveryservicesbackup.models.InquiryInfo(*, status: str = None, error_detail=None, inquiry_details=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Details about inquired protectable items under a given container.

Parameters

status (str) – Inquiry Status for this container such as InProgress | Failed | Succeeded
error_detail (ErrorDetail) – Error Details if the Status is non-success.
inquiry_details (list[WorkloadInquiryDetails]) – Inquiry Details which will have workload specific details. For e.g. - For SQL and oracle this will contain different details.

class azure.mgmt.recoveryservicesbackup.models.InquiryValidation(*, status: str = None, error_detail=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Validation for inquired protectable items under a given container.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

status (str) – Status for the Inquiry Validation.
error_detail (ErrorDetail) – Error Detail in case the status is non-success.

Variables

additional_detail (str) – Error Additional Detail in case the status is non-success.

class azure.mgmt.recoveryservicesbackup.models.InstantItemRecoveryTarget(*, client_scripts=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Target details for file / folder restore.

Parameters: client_scripts (list[ClientScriptForConnect]) – List of client scripts.

class azure.mgmt.recoveryservicesbackup.models.InstantRPAdditionalDetails(*, azure_backup_rg_name_prefix: str = None, azure_backup_rg_name_suffix: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

InstantRPAdditionalDetails.

Parameters

azure_backup_rg_name_prefix (str) –
azure_backup_rg_name_suffix (str) –

class azure.mgmt.recoveryservicesbackup.models.Job(*, entity_friendly_name: str = None, backup_management_type=None, operation: str = None, status: str = None, start_time=None, end_time=None, activity_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines workload agnostic properties for a job.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureIaaSVMJob, AzureStorageJob, AzureWorkloadJob, DpmJob, MabJob

All required parameters must be populated in order to send to Azure.

Parameters

entity_friendly_name (str) – Friendly name of the entity on which the current job is executing.
backup_management_type (str or BackupManagementType) – Backup management type to execute the current job. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
operation (str) – The operation name.
status (str) – Job status.
start_time (datetime) – The start time.
end_time (datetime) – The end time.
activity_id (str) – ActivityId of job.
job_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.JobQueryObject(*, status=None, backup_management_type=None, operation=None, job_id: str = None, start_time=None, end_time=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Filters to list the jobs.

Parameters

status (str or JobStatus) – Status of the job. Possible values include: ‘Invalid’, ‘InProgress’, ‘Completed’, ‘Failed’, ‘CompletedWithWarnings’, ‘Cancelled’, ‘Cancelling’
backup_management_type (str or BackupManagementType) – Type of backup management for the job. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
operation (str or JobOperationType) – Type of operation. Possible values include: ‘Invalid’, ‘Register’, ‘UnRegister’, ‘ConfigureBackup’, ‘Backup’, ‘Restore’, ‘DisableBackup’, ‘DeleteBackupData’, ‘CrossRegionRestore’, ‘Undelete’
job_id (str) – JobID represents the job uniquely.
start_time (datetime) – Job has started at this time. Value is in UTC.
end_time (datetime) – Job has ended at this time. Value is in UTC.

class azure.mgmt.recoveryservicesbackup.models.JobResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

Defines workload agnostic properties for a job.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (Job) – JobResource properties

class azure.mgmt.recoveryservicesbackup.models.KEKDetails(*, key_url: str = None, key_vault_id: str = None, key_backup_data: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

KEK is encryption key for BEK.

Parameters

key_url (str) – Key is KEK.
key_vault_id (str) – Key Vault ID where this Key is stored.
key_backup_data (str) – KEK data.

class azure.mgmt.recoveryservicesbackup.models.KeyAndSecretDetails(*, kek_details=None, bek_details=None, encryption_mechanism: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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.

Parameters

kek_details (KEKDetails) – KEK is encryption key for BEK.
bek_details (BEKDetails) – BEK is bitlocker encryption key.
encryption_mechanism (str) – Encryption mechanism: None/ SinglePass/ DoublePass

class azure.mgmt.recoveryservicesbackup.models.LogSchedulePolicy(*, schedule_frequency_in_mins: int = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.SchedulePolicy

Log policy schedule.

All required parameters must be populated in order to send to Azure.

Parameters

schedule_policy_type (str) – Required. Constant filled by server.
schedule_frequency_in_mins (int) – Frequency of the log schedule operation of this policy in minutes.

class azure.mgmt.recoveryservicesbackup.models.LongTermRetentionPolicy(*, daily_schedule=None, weekly_schedule=None, monthly_schedule=None, yearly_schedule=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.RetentionPolicy

Long term retention policy.

All required parameters must be populated in order to send to Azure.

Parameters

retention_policy_type (str) – Required. Constant filled by server.
daily_schedule (DailyRetentionSchedule) – Daily retention schedule of the protection policy.
weekly_schedule (WeeklyRetentionSchedule) – Weekly retention schedule of the protection policy.
monthly_schedule (MonthlyRetentionSchedule) – Monthly retention schedule of the protection policy.
yearly_schedule (YearlyRetentionSchedule) – Yearly retention schedule of the protection policy.

class azure.mgmt.recoveryservicesbackup.models.LongTermSchedulePolicy(**kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.SchedulePolicy

Long term policy schedule.

All required parameters must be populated in order to send to Azure.

Parameters: schedule_policy_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.MabContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, can_re_register: bool = None, container_id: int = None, protected_item_count: int = None, agent_version: str = None, extended_info=None, mab_container_health_details=None, container_health_state: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionContainer

Container with items backed up using MAB backup engine.

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.
can_re_register (bool) – Can the container be registered one more time.
container_id (long) – ContainerID represents the container.
protected_item_count (long) – Number of items backed up in this container.
agent_version (str) – Agent version of this container.
extended_info (MabContainerExtendedInfo) – Additional information for this container
mab_container_health_details (list[MABContainerHealthDetails]) – Health details on this mab container.
container_health_state (str) – Health state of mab container.

class azure.mgmt.recoveryservicesbackup.models.MabContainerExtendedInfo(*, last_refreshed_at=None, backup_item_type=None, backup_items=None, policy_name: str = None, last_backup_status: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information of the container.

Parameters

last_refreshed_at (datetime) – Time stamp when this container was refreshed.
backup_item_type (str or BackupItemType) – Type of backup items associated with this container. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
backup_items (list[str]) – List of backup items associated with this container.
policy_name (str) – Backup policy associated with this container.
last_backup_status (str) – Latest backup status of this container.

class azure.mgmt.recoveryservicesbackup.models.MABContainerHealthDetails(*, code: int = None, title: str = None, message: str = None, recommendations=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

MAB workload-specific Health Details.

Parameters

code (int) – Health Code
title (str) – Health Title
message (str) – Health Message
recommendations (list[str]) – Health Recommended Actions

class azure.mgmt.recoveryservicesbackup.models.MabErrorInfo(**kwargs)[source]¶

Bases: msrest.serialization.Model

MAB workload-specific error information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

error_string (str) – Localized error string.
recommendations (list[str]) – List of localized recommendations.

class azure.mgmt.recoveryservicesbackup.models.MabFileFolderProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, friendly_name: str = None, computer_name: str = None, last_backup_status: str = None, last_backup_time=None, protection_state: str = None, deferred_delete_sync_time_in_utc: int = None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectedItem

MAB workload-specific backup item.

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.
friendly_name (str) – Friendly name of this backup item.
computer_name (str) – Name of the computer associated with this backup item.
last_backup_status (str) – Status of last backup operation.
last_backup_time (datetime) – Timestamp of the last backup operation on this backup item.
protection_state (str) – Protected, ProtectionStopped, IRPending or ProtectionError
deferred_delete_sync_time_in_utc (long) – Sync time for deferred deletion in UTC
extended_info (MabFileFolderProtectedItemExtendedInfo) – Additional information with this backup item.

class azure.mgmt.recoveryservicesbackup.models.MabFileFolderProtectedItemExtendedInfo(*, last_refreshed_at=None, oldest_recovery_point=None, recovery_point_count: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information on the backed up item.

Parameters

last_refreshed_at (datetime) – Last time when the agent data synced to service.
oldest_recovery_point (datetime) – The oldest backup copy available.
recovery_point_count (int) – Number of backup copies associated with the backup item.

class azure.mgmt.recoveryservicesbackup.models.MabJob(*, entity_friendly_name: str = None, backup_management_type=None, operation: str = None, status: str = None, start_time=None, end_time=None, activity_id: str = None, duration=None, actions_info=None, mab_server_name: str = None, mab_server_type=None, workload_type=None, error_details=None, extended_info=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Job

MAB workload-specific job.

All required parameters must be populated in order to send to Azure.

Parameters

entity_friendly_name (str) – Friendly name of the entity on which the current job is executing.
backup_management_type (str or BackupManagementType) – Backup management type to execute the current job. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
operation (str) – The operation name.
status (str) – Job status.
start_time (datetime) – The start time.
end_time (datetime) – The end time.
activity_id (str) – ActivityId of job.
job_type (str) – Required. Constant filled by server.
duration (timedelta) – Time taken by job to run.
actions_info (list[str or JobSupportedAction]) – The state/actions applicable on jobs like cancel/retry.
mab_server_name (str) – Name of server protecting the DS.
mab_server_type (str or MabServerType) – Server type of MAB container. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’, ‘VMAppContainer’, ‘SQLAGWorkLoadContainer’, ‘StorageContainer’, ‘GenericContainer’
workload_type (str or WorkloadType) – Workload type of backup item. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
error_details (list[MabErrorInfo]) – The errors.
extended_info (MabJobExtendedInfo) – Additional information on the job.

class azure.mgmt.recoveryservicesbackup.models.MabJobExtendedInfo(*, tasks_list=None, property_bag=None, dynamic_error_message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional information for the MAB workload-specific job.

Parameters

tasks_list (list[MabJobTaskDetails]) – List of tasks for this job.
property_bag (dict[str, str]) – The job properties.
dynamic_error_message (str) – Non localized error message specific to this job.

class azure.mgmt.recoveryservicesbackup.models.MabJobTaskDetails(*, task_id: str = None, start_time=None, end_time=None, duration=None, status: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

MAB workload-specific job task details.

Parameters

task_id (str) – The task display name.
start_time (datetime) – The start time.
end_time (datetime) – The end time.
duration (timedelta) – Time elapsed for task.
status (str) – The status.

class azure.mgmt.recoveryservicesbackup.models.MabProtectionPolicy(*, protected_items_count: int = None, schedule_policy=None, retention_policy=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ProtectionPolicy

Mab container-specific backup policy.

All required parameters must be populated in order to send to Azure.

Parameters

protected_items_count (int) – Number of items associated with this policy.
backup_management_type (str) – Required. Constant filled by server.
schedule_policy (SchedulePolicy) – Backup schedule of backup policy.
retention_policy (RetentionPolicy) – Retention policy details.

class azure.mgmt.recoveryservicesbackup.models.MonthlyRetentionSchedule(*, retention_schedule_format_type=None, retention_schedule_daily=None, retention_schedule_weekly=None, retention_times=None, retention_duration=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Monthly retention schedule.

Parameters

retention_schedule_format_type (str or RetentionScheduleFormat) – Retention schedule format type for monthly retention policy. Possible values include: ‘Invalid’, ‘Daily’, ‘Weekly’
retention_schedule_daily (DailyRetentionFormat) – Daily retention format for monthly retention policy.
retention_schedule_weekly (WeeklyRetentionFormat) – Weekly retention format for monthly retention policy.
retention_times (list[datetime]) – Retention times of retention policy.
retention_duration (RetentionDuration) – Retention duration of retention Policy.

class azure.mgmt.recoveryservicesbackup.models.NameInfo(*, value: str = None, localized_value: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The name of usage.

Parameters

value (str) – Value of usage.
localized_value (str) – Localized value of usage.

class azure.mgmt.recoveryservicesbackup.models.OperationResultInfo(*, job_list=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.OperationResultInfoBase

Operation result info.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
job_list (list[str]) – List of jobs created by this operation.

class azure.mgmt.recoveryservicesbackup.models.OperationResultInfoBase(**kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for operation result info.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ExportJobsOperationResultInfo, OperationResultInfo

All required parameters must be populated in order to send to Azure.

Parameters: object_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.OperationResultInfoBaseResource(*, status_code=None, headers=None, operation=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.OperationWorkerResponse

Base class for operation result info.

Parameters

status_code (str or HttpStatusCode) – HTTP Status Code of the operation. Possible values include: ‘Continue’, ‘SwitchingProtocols’, ‘OK’, ‘Created’, ‘Accepted’, ‘NonAuthoritativeInformation’, ‘NoContent’, ‘ResetContent’, ‘PartialContent’, ‘MultipleChoices’, ‘Ambiguous’, ‘MovedPermanently’, ‘Moved’, ‘Found’, ‘Redirect’, ‘SeeOther’, ‘RedirectMethod’, ‘NotModified’, ‘UseProxy’, ‘Unused’, ‘TemporaryRedirect’, ‘RedirectKeepVerb’, ‘BadRequest’, ‘Unauthorized’, ‘PaymentRequired’, ‘Forbidden’, ‘NotFound’, ‘MethodNotAllowed’, ‘NotAcceptable’, ‘ProxyAuthenticationRequired’, ‘RequestTimeout’, ‘Conflict’, ‘Gone’, ‘LengthRequired’, ‘PreconditionFailed’, ‘RequestEntityTooLarge’, ‘RequestUriTooLong’, ‘UnsupportedMediaType’, ‘RequestedRangeNotSatisfiable’, ‘ExpectationFailed’, ‘UpgradeRequired’, ‘InternalServerError’, ‘NotImplemented’, ‘BadGateway’, ‘ServiceUnavailable’, ‘GatewayTimeout’, ‘HttpVersionNotSupported’
headers (dict[str, list[str]]) – HTTP headers associated with this operation.
operation (OperationResultInfoBase) – OperationResultInfoBaseResource operation

class azure.mgmt.recoveryservicesbackup.models.OperationStatus(*, id: str = None, name: str = None, status=None, start_time=None, end_time=None, error=None, properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Operation status.

Parameters

id (str) – ID of the operation.
name (str) – Name of the operation.
status (str or OperationStatusValues) – Operation status. Possible values include: ‘Invalid’, ‘InProgress’, ‘Succeeded’, ‘Failed’, ‘Canceled’
start_time (datetime) – Operation start time. Format: ISO-8601.
end_time (datetime) – Operation end time. Format: ISO-8601.
error (OperationStatusError) – Error information related to this operation.
properties (OperationStatusExtendedInfo) – Additional information associated with this operation.

class azure.mgmt.recoveryservicesbackup.models.OperationStatusError(*, code: str = None, message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Error information associated with operation status call.

Parameters

code (str) – Error code of the operation failure.
message (str) – Error message displayed if the operation failure.

class azure.mgmt.recoveryservicesbackup.models.OperationStatusExtendedInfo(**kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for additional information of operation status.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: OperationStatusJobExtendedInfo, OperationStatusJobsExtendedInfo, OperationStatusProvisionILRExtendedInfo

All required parameters must be populated in order to send to Azure.

Parameters: object_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.OperationStatusJobExtendedInfo(*, job_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.OperationStatusExtendedInfo

Operation status job extended info.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
job_id (str) – ID of the job created for this protected item.

class azure.mgmt.recoveryservicesbackup.models.OperationStatusJobsExtendedInfo(*, job_ids=None, failed_jobs_error=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.OperationStatusExtendedInfo

Operation status extended info for list of jobs.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
job_ids (list[str]) – IDs of the jobs created for the protected item.
failed_jobs_error (dict[str, str]) – Stores all the failed jobs along with the corresponding error codes.

class azure.mgmt.recoveryservicesbackup.models.OperationStatusProvisionILRExtendedInfo(*, recovery_target=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.OperationStatusExtendedInfo

Operation status extended info for ILR provision action.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
recovery_target (InstantItemRecoveryTarget) – Target details for file / folder restore.

class azure.mgmt.recoveryservicesbackup.models.OperationWorkerResponse(*, status_code=None, headers=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

This is the base class for operation result responses.

Parameters

status_code (str or HttpStatusCode) – HTTP Status Code of the operation. Possible values include: ‘Continue’, ‘SwitchingProtocols’, ‘OK’, ‘Created’, ‘Accepted’, ‘NonAuthoritativeInformation’, ‘NoContent’, ‘ResetContent’, ‘PartialContent’, ‘MultipleChoices’, ‘Ambiguous’, ‘MovedPermanently’, ‘Moved’, ‘Found’, ‘Redirect’, ‘SeeOther’, ‘RedirectMethod’, ‘NotModified’, ‘UseProxy’, ‘Unused’, ‘TemporaryRedirect’, ‘RedirectKeepVerb’, ‘BadRequest’, ‘Unauthorized’, ‘PaymentRequired’, ‘Forbidden’, ‘NotFound’, ‘MethodNotAllowed’, ‘NotAcceptable’, ‘ProxyAuthenticationRequired’, ‘RequestTimeout’, ‘Conflict’, ‘Gone’, ‘LengthRequired’, ‘PreconditionFailed’, ‘RequestEntityTooLarge’, ‘RequestUriTooLong’, ‘UnsupportedMediaType’, ‘RequestedRangeNotSatisfiable’, ‘ExpectationFailed’, ‘UpgradeRequired’, ‘InternalServerError’, ‘NotImplemented’, ‘BadGateway’, ‘ServiceUnavailable’, ‘GatewayTimeout’, ‘HttpVersionNotSupported’
headers (dict[str, list[str]]) – HTTP headers associated with this operation.

class azure.mgmt.recoveryservicesbackup.models.PointInTimeRange(*, start_time=None, end_time=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Provides details for log ranges.

Parameters

start_time (datetime) – Start time of the time range for log recovery.
end_time (datetime) – End time of the time range for log recovery.

class azure.mgmt.recoveryservicesbackup.models.PreBackupValidation(*, status=None, code: str = None, message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Pre-backup validation for Azure VM Workload provider.

Parameters

status (str or InquiryStatus) – Status of protectable item, i.e. InProgress,Succeeded,Failed. Possible values include: ‘Invalid’, ‘Success’, ‘Failed’
code (str) – Error code of protectable item
message (str) – Message corresponding to the error code for the protectable item

class azure.mgmt.recoveryservicesbackup.models.PreValidateEnableBackupRequest(*, resource_type=None, resource_id: str = None, vault_id: str = None, properties: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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.

Parameters

resource_type (str or DataSourceType) – ProtectedItem Type- VM, SqlDataBase, AzureFileShare etc. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
resource_id (str) – ARM Virtual Machine Id
vault_id (str) – ARM id of the Recovery Services Vault
properties (str) – Configuration of VM if any needs to be validated like OS type etc

class azure.mgmt.recoveryservicesbackup.models.PreValidateEnableBackupResponse(*, status=None, error_code: str = None, error_message: str = None, recommendation: str = None, container_name: str = None, protected_item_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response contract for enable backup validation request.

Parameters

status (str or ValidationStatus) – Validation Status. Possible values include: ‘Invalid’, ‘Succeeded’, ‘Failed’
error_code (str) – Response error code
error_message (str) – Response error message
recommendation (str) – Recommended action for user
container_name (str) – Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required for portal
protected_item_name (str) – Specifies the product specific ds name. E.g. vm;iaasvmcontainer;rgname;vmname. This is required for portal

class azure.mgmt.recoveryservicesbackup.models.ProtectableContainer(*, friendly_name: str = None, backup_management_type=None, health_status: str = None, container_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Protectable Container Class.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureStorageProtectableContainer, AzureVMAppContainerProtectableContainer

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
health_status (str) – Status of health of the container.
container_id (str) – Fabric Id of the container such as ARM Id.
protectable_container_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.ProtectableContainerResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

Protectable Container Class.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (ProtectableContainer) – ProtectableContainerResource properties

class azure.mgmt.recoveryservicesbackup.models.ProtectedItem(*, backup_management_type=None, workload_type=None, container_name: str = None, source_resource_id: str = None, policy_id: str = None, last_recovery_point=None, backup_set_name: str = None, create_mode=None, deferred_delete_time_in_utc=None, is_scheduled_for_deferred_delete: bool = None, deferred_delete_time_remaining: str = None, is_deferred_delete_schedule_upcoming: bool = None, is_rehydrate: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for backup items.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureFileshareProtectedItem, AzureIaaSVMProtectedItem, AzureSqlProtectedItem, AzureVmWorkloadProtectedItem, DPMProtectedItem, GenericProtectedItem, MabFileFolderProtectedItem

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
workload_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
container_name (str) – Unique name of container
source_resource_id (str) – ARM ID of the resource to be backed up.
policy_id (str) – ID of the backup policy with which this item is backed up.
last_recovery_point (datetime) – Timestamp when the last (latest) backup copy was created for this backup item.
backup_set_name (str) – Name of the backup set the backup item belongs to
create_mode (str or CreateMode) – Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: ‘Invalid’, ‘Default’, ‘Recover’
deferred_delete_time_in_utc (datetime) – Time for deferred deletion in UTC
is_scheduled_for_deferred_delete (bool) – Flag to identify whether the DS is scheduled for deferred delete
deferred_delete_time_remaining (str) – Time remaining before the DS marked for deferred delete is permanently deleted
is_deferred_delete_schedule_upcoming (bool) – Flag to identify whether the deferred deleted DS is to be purged soon
is_rehydrate (bool) – Flag to identify that deferred deleted DS is to be moved into Pause state
protected_item_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.ProtectedItemQueryObject(*, health_state=None, backup_management_type=None, item_type=None, policy_name: str = None, container_name: str = None, backup_engine_name: str = None, friendly_name: str = None, fabric_name: str = None, backup_set_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Filters to list backup items.

Parameters

health_state (str or HealthState) – Health State for the backed up item. Possible values include: ‘Passed’, ‘ActionRequired’, ‘ActionSuggested’, ‘Invalid’
backup_management_type (str or BackupManagementType) – Backup management type for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
item_type (str or DataSourceType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’
policy_name (str) – Backup policy name associated with the backup item.
container_name (str) – Name of the container.
backup_engine_name (str) – Backup Engine name
friendly_name (str) – Friendly name of protected item
fabric_name (str) – Name of the fabric.
backup_set_name (str) – Name of the backup set.

class azure.mgmt.recoveryservicesbackup.models.ProtectedItemResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

Base class for backup items.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (ProtectedItem) – ProtectedItemResource properties

class azure.mgmt.recoveryservicesbackup.models.ProtectionContainer(*, friendly_name: str = None, backup_management_type=None, registration_status: str = None, health_status: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for container with backup items. Containers with specific workloads are derived from this class.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureSqlContainer, AzureStorageContainer, AzureWorkloadContainer, DpmContainer, GenericContainer, IaaSVMContainer, MabContainer

All required parameters must be populated in order to send to Azure.

Parameters

friendly_name (str) – Friendly name of the container.
backup_management_type (str or BackupManagementType) – Type of backup management for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
registration_status (str) – Status of registration of the container with the Recovery Services Vault.
health_status (str) – Status of health of the container.
container_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.ProtectionContainerResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

Base class for container with backup items. Containers with specific workloads are derived from this class.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (ProtectionContainer) – ProtectionContainerResource properties

class azure.mgmt.recoveryservicesbackup.models.ProtectionIntent(*, backup_management_type=None, source_resource_id: str = None, item_id: str = None, policy_id: str = None, protection_state=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for backup ProtectionIntent.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureRecoveryServiceVaultProtectionIntent, AzureResourceProtectionIntent

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str or BackupManagementType) – Type of backup management for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
source_resource_id (str) – ARM ID of the resource to be backed up.
item_id (str) – ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policy_id (str) – ID of the backup policy with which this item is backed up.
protection_state (str or ProtectionStatus) – Backup state of this backup item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protection_intent_item_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.ProtectionIntentQueryObject(*, backup_management_type=None, item_type=None, parent_name: str = None, item_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Filters to list protection intent.

Parameters

backup_management_type (str or BackupManagementType) – Backup management type for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
item_type (str or IntentItemType) – Type of workload this item represents. Possible values include: ‘Invalid’, ‘SQLInstance’, ‘SQLAvailabilityGroupContainer’
parent_name (str) – Parent name of the intent
item_name (str) – Item name of the intent

class azure.mgmt.recoveryservicesbackup.models.ProtectionIntentResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

Base class for backup ProtectionIntent.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (ProtectionIntent) – ProtectionIntentResource properties

class azure.mgmt.recoveryservicesbackup.models.ProtectionPolicy(*, protected_items_count: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for backup policy. Workload-specific backup policies are derived from this class.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureVmWorkloadProtectionPolicy, AzureFileShareProtectionPolicy, AzureIaaSVMProtectionPolicy, AzureSqlProtectionPolicy, GenericProtectionPolicy, MabProtectionPolicy

All required parameters must be populated in order to send to Azure.

Parameters

protected_items_count (int) – Number of items associated with this policy.
backup_management_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.ProtectionPolicyQueryObject(*, backup_management_type=None, fabric_name: str = None, workload_type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Filters the list backup policies API.

Parameters

backup_management_type (str or BackupManagementType) – Backup management type for the backup policy. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’, ‘AzureStorage’, ‘AzureWorkload’, ‘DefaultBackup’
fabric_name (str) – Fabric name for filter
workload_type (str or WorkloadType) – Workload type for the backup policy. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’, ‘SQLDataBase’, ‘AzureFileShare’, ‘SAPHanaDatabase’, ‘SAPAseDatabase’

class azure.mgmt.recoveryservicesbackup.models.ProtectionPolicyResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

Base class for backup policy. Workload-specific backup policies are derived from this class.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (ProtectionPolicy) – ProtectionPolicyResource properties

class azure.mgmt.recoveryservicesbackup.models.RecoveryPoint(**kwargs)[source]¶

Bases: msrest.serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureFileShareRecoveryPoint, AzureWorkloadRecoveryPoint, GenericRecoveryPoint, IaasVMRecoveryPoint

All required parameters must be populated in order to send to Azure.

Parameters: object_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.RecoveryPointDiskConfiguration(*, number_of_disks_included_in_backup: int = None, number_of_disks_attached_to_vm: int = None, included_disk_list=None, excluded_disk_list=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Disk configuration.

Parameters

number_of_disks_included_in_backup (int) – Number of disks included in backup
number_of_disks_attached_to_vm (int) – Number of disks attached to the VM
included_disk_list (list[DiskInformation]) – Information of disks included in backup
excluded_disk_list (list[DiskInformation]) – Information of disks excluded from backup

class azure.mgmt.recoveryservicesbackup.models.RecoveryPointResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (RecoveryPoint) – RecoveryPointResource properties

class azure.mgmt.recoveryservicesbackup.models.RecoveryPointTierInformation(*, type=None, status=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Recovery point tier information.

Parameters

type (str or RecoveryPointTierType) – Recovery point tier type. Possible values include: ‘Invalid’, ‘InstantRP’, ‘HardenedRP’
status (str or RecoveryPointTierStatus) – Recovery point tier status. Possible values include: ‘Invalid’, ‘Valid’, ‘Disabled’, ‘Deleted’

class azure.mgmt.recoveryservicesbackup.models.Resource(*, location: str = None, tags=None, e_tag: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

ARM Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.

class azure.mgmt.recoveryservicesbackup.models.ResourceList(*, next_link: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Base for all lists of resources.

Parameters: next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.

class azure.mgmt.recoveryservicesbackup.models.RestoreFileSpecs(*, path: str = None, file_spec_type: str = None, target_folder_path: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

Parameters

path (str) – Source File/Folder path
file_spec_type (str) – Indicates what the Path variable stands for
target_folder_path (str) – Destination folder path in target FileShare

class azure.mgmt.recoveryservicesbackup.models.RestoreRequest(**kwargs)[source]¶

Bases: msrest.serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureFileShareRestoreRequest, AzureWorkloadRestoreRequest, IaasVMRestoreRequest

All required parameters must be populated in order to send to Azure.

Parameters: object_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.RestoreRequestResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (RestoreRequest) – RestoreRequestResource properties

class azure.mgmt.recoveryservicesbackup.models.RetentionDuration(*, count: int = None, duration_type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Retention duration.

Parameters

count (int) – Count of duration types. Retention duration is obtained by the counting the duration type Count times. For example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.
duration_type (str or RetentionDurationType) – Retention duration type of retention policy. Possible values include: ‘Invalid’, ‘Days’, ‘Weeks’, ‘Months’, ‘Years’

class azure.mgmt.recoveryservicesbackup.models.RetentionPolicy(**kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for retention policy.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: LongTermRetentionPolicy, SimpleRetentionPolicy

All required parameters must be populated in order to send to Azure.

Parameters: retention_policy_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.SchedulePolicy(**kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for backup schedule.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: LogSchedulePolicy, LongTermSchedulePolicy, SimpleSchedulePolicy

All required parameters must be populated in order to send to Azure.

Parameters: schedule_policy_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.Settings(*, time_zone: str = None, issqlcompression: bool = None, is_compression: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Common settings field for backup management.

Parameters

time_zone (str) – TimeZone optional input as string. For example: TimeZone = “Pacific Standard Time”.
issqlcompression (bool) – SQL compression flag
is_compression (bool) – Workload compression flag. This has been added so that ‘isSqlCompression’ will be deprecated once clients upgrade to consider this flag.

class azure.mgmt.recoveryservicesbackup.models.SimpleRetentionPolicy(*, retention_duration=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.RetentionPolicy

Simple policy retention.

All required parameters must be populated in order to send to Azure.

Parameters

retention_policy_type (str) – Required. Constant filled by server.
retention_duration (RetentionDuration) – Retention duration of the protection policy.

class azure.mgmt.recoveryservicesbackup.models.SimpleSchedulePolicy(*, schedule_run_frequency=None, schedule_run_days=None, schedule_run_times=None, schedule_weekly_frequency: int = None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.SchedulePolicy

Simple policy schedule.

All required parameters must be populated in order to send to Azure.

Parameters

schedule_policy_type (str) – Required. Constant filled by server.
schedule_run_frequency (str or ScheduleRunType) – Frequency of the schedule operation of this policy. Possible values include: ‘Invalid’, ‘Daily’, ‘Weekly’
schedule_run_days (list[str or DayOfWeek]) – List of days of week this schedule has to be run.
schedule_run_times (list[datetime]) – List of times of day this schedule has to be run.
schedule_weekly_frequency (int) – At every number weeks this schedule has to be run.

class azure.mgmt.recoveryservicesbackup.models.SQLDataDirectory(*, type=None, path: str = None, logical_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SQLDataDirectory info.

Parameters

type (str or SQLDataDirectoryType) – Type of data directory mapping. Possible values include: ‘Invalid’, ‘Data’, ‘Log’
path (str) – File path
logical_name (str) – Logical name of the file

class azure.mgmt.recoveryservicesbackup.models.SQLDataDirectoryMapping(*, mapping_type=None, source_logical_name: str = None, source_path: str = None, target_path: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Encapsulates information regarding data directory.

Parameters

mapping_type (str or SQLDataDirectoryType) – Type of data directory mapping. Possible values include: ‘Invalid’, ‘Data’, ‘Log’
source_logical_name (str) – Restore source logical name path
source_path (str) – Restore source path
target_path (str) – Target path

class azure.mgmt.recoveryservicesbackup.models.SubProtectionPolicy(*, policy_type=None, schedule_policy=None, retention_policy=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Sub-protection policy which includes schedule and retention.

Parameters

policy_type (str or PolicyType) – Type of backup policy type. Possible values include: ‘Invalid’, ‘Full’, ‘Differential’, ‘Log’, ‘CopyOnlyFull’
schedule_policy (SchedulePolicy) – Backup schedule specified as part of backup policy.
retention_policy (RetentionPolicy) – Retention policy with the details on backup copy retention ranges.

class azure.mgmt.recoveryservicesbackup.models.TargetAFSRestoreInfo(*, name: str = None, target_resource_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Target Azure File Share Info.

Parameters

name (str) – File share name
target_resource_id (str) – Target file share resource ARM ID

class azure.mgmt.recoveryservicesbackup.models.TargetRestoreInfo(*, overwrite_option=None, container_id: str = None, database_name: str = None, target_directory_for_file_restore: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Details about target workload during restore operation.

Parameters

overwrite_option (str or OverwriteOptions) – Can Overwrite if Target DataBase already exists. Possible values include: ‘Invalid’, ‘FailOnConflict’, ‘Overwrite’
container_id (str) – Resource Id name of the container in which Target DataBase resides
database_name (str) – Database name InstanceName/DataBaseName for SQL or System/DbName for SAP Hana
target_directory_for_file_restore (str) – Target directory location for restore as files.

class azure.mgmt.recoveryservicesbackup.models.TokenInformation(*, token: str = None, expiry_time_in_utc_ticks: int = None, security_pin: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The token information details.

Parameters

token (str) – Token value.
expiry_time_in_utc_ticks (long) – Expiry time of token.
security_pin (str) – Security PIN

class azure.mgmt.recoveryservicesbackup.models.ValidateIaasVMRestoreOperationRequest(*, restore_request=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ValidateRestoreOperationRequest

AzureRestoreValidation request.

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
restore_request (RestoreRequest) – Sets restore request to be validated

class azure.mgmt.recoveryservicesbackup.models.ValidateOperationRequest(**kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for validate operation request.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ValidateRestoreOperationRequest

All required parameters must be populated in order to send to Azure.

Parameters: object_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.ValidateOperationResponse(*, validation_results=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Base class for validate operation response.

Parameters: validation_results (list[ErrorDetail]) – Gets the validation result

class azure.mgmt.recoveryservicesbackup.models.ValidateOperationsResponse(*, validate_operation_response=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

ValidateOperationsResponse.

Parameters: validate_operation_response (ValidateOperationResponse) –

class azure.mgmt.recoveryservicesbackup.models.ValidateRestoreOperationRequest(*, restore_request=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.ValidateOperationRequest

AzureRestoreValidation request.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ValidateIaasVMRestoreOperationRequest

All required parameters must be populated in order to send to Azure.

Parameters

object_type (str) – Required. Constant filled by server.
restore_request (RestoreRequest) – Sets restore request to be validated

class azure.mgmt.recoveryservicesbackup.models.WeeklyRetentionFormat(*, days_of_the_week=None, weeks_of_the_month=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Weekly retention format.

Parameters

days_of_the_week (list[str or DayOfWeek]) – List of days of the week.
weeks_of_the_month (list[str or WeekOfMonth]) – List of weeks of month.

class azure.mgmt.recoveryservicesbackup.models.WeeklyRetentionSchedule(*, days_of_the_week=None, retention_times=None, retention_duration=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Weekly retention schedule.

Parameters

days_of_the_week (list[str or DayOfWeek]) – List of days of week for weekly retention policy.
retention_times (list[datetime]) – Retention times of retention policy.
retention_duration (RetentionDuration) – Retention duration of retention Policy.

class azure.mgmt.recoveryservicesbackup.models.WorkloadInquiryDetails(*, type: str = None, item_count: int = None, inquiry_validation=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Details of an inquired protectable item.

Parameters

type (str) – Type of the Workload such as SQL, Oracle etc.
item_count (long) – Contains the protectable item Count inside this Container.
inquiry_validation (InquiryValidation) – Inquiry validation such as permissions and other backup validations.

class azure.mgmt.recoveryservicesbackup.models.WorkloadItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureVmWorkloadItem

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
workload_item_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.WorkloadItemResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (WorkloadItem) – WorkloadItemResource properties

class azure.mgmt.recoveryservicesbackup.models.WorkloadProtectableItem(*, backup_management_type: str = None, workload_type: str = None, friendly_name: str = None, protection_state=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureFileShareProtectableItem, AzureVmWorkloadProtectableItem, IaaSVMProtectableItem

All required parameters must be populated in order to send to Azure.

Parameters

backup_management_type (str) – Type of backup management to backup an item.
workload_type (str) – Type of workload for the backup management
friendly_name (str) – Friendly name of the backup item.
protection_state (str or ProtectionStatus) – State of the back up item. Possible values include: ‘Invalid’, ‘NotProtected’, ‘Protecting’, ‘Protected’, ‘ProtectionFailed’
protectable_item_type (str) – Required. Constant filled by server.

class azure.mgmt.recoveryservicesbackup.models.WorkloadProtectableItemResource(*, location: str = None, tags=None, e_tag: str = None, properties=None, **kwargs)[source]¶

Bases: azure.mgmt.recoveryservicesbackup.models._models_py3.Resource

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource Id represents the complete path to the resource.
name (str) – Resource name associated with the resource.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

Parameters

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
e_tag (str) – Optional ETag.
properties (WorkloadProtectableItem) – WorkloadProtectableItemResource properties

class azure.mgmt.recoveryservicesbackup.models.YearlyRetentionSchedule(*, retention_schedule_format_type=None, months_of_year=None, retention_schedule_daily=None, retention_schedule_weekly=None, retention_times=None, retention_duration=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Yearly retention schedule.

Parameters

retention_schedule_format_type (str or RetentionScheduleFormat) – Retention schedule format for yearly retention policy. Possible values include: ‘Invalid’, ‘Daily’, ‘Weekly’
months_of_year (list[str or MonthOfYear]) – List of months of year of yearly retention policy.
retention_schedule_daily (DailyRetentionFormat) – Daily retention format for yearly retention policy.
retention_schedule_weekly (WeeklyRetentionFormat) – Weekly retention format for yearly retention policy.
retention_times (list[datetime]) – Retention times of retention policy.
retention_duration (RetentionDuration) – Retention duration of retention Policy.

class azure.mgmt.recoveryservicesbackup.models.RecoveryPointResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of RecoveryPointResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.ProtectionPolicyResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProtectionPolicyResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.JobResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of JobResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.ProtectedItemResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProtectedItemResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.ProtectionIntentResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProtectionIntentResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.BackupManagementUsagePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of BackupManagementUsage object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.BackupEngineBaseResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of BackupEngineBaseResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.ProtectableContainerResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProtectableContainerResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.WorkloadItemResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of WorkloadItemResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.WorkloadProtectableItemResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of WorkloadProtectableItemResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.ProtectionContainerResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProtectionContainerResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryValueForSingleApiPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ClientDiscoveryValueForSingleApi object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.recoveryservicesbackup.models.ProtectionState[source]¶

Bases: str, enum.Enum

An enumeration.

invalid = 'Invalid'¶

ir_pending = 'IRPending'¶

protected = 'Protected'¶

protection_error = 'ProtectionError'¶

protection_paused = 'ProtectionPaused'¶

protection_stopped = 'ProtectionStopped'¶

class azure.mgmt.recoveryservicesbackup.models.HealthStatus[source]¶

Bases: str, enum.Enum

An enumeration.

action_required = 'ActionRequired'¶

action_suggested = 'ActionSuggested'¶

invalid = 'Invalid'¶

passed = 'Passed'¶

class azure.mgmt.recoveryservicesbackup.models.RecoveryType[source]¶

Bases: str, enum.Enum

An enumeration.

alternate_location = 'AlternateLocation'¶

invalid = 'Invalid'¶

offline = 'Offline'¶

original_location = 'OriginalLocation'¶

restore_disks = 'RestoreDisks'¶

class azure.mgmt.recoveryservicesbackup.models.CopyOptions[source]¶

Bases: str, enum.Enum

An enumeration.

create_copy = 'CreateCopy'¶

fail_on_conflict = 'FailOnConflict'¶

invalid = 'Invalid'¶

overwrite = 'Overwrite'¶

skip = 'Skip'¶

class azure.mgmt.recoveryservicesbackup.models.RestoreRequestType[source]¶

Bases: str, enum.Enum

An enumeration.

full_share_restore = 'FullShareRestore'¶

invalid = 'Invalid'¶

item_level_restore = 'ItemLevelRestore'¶

class azure.mgmt.recoveryservicesbackup.models.WorkloadType[source]¶

Bases: str, enum.Enum

An enumeration.

azure_file_share = 'AzureFileShare'¶

azure_sql_db = 'AzureSqlDb'¶

client = 'Client'¶

exchange = 'Exchange'¶

file_folder = 'FileFolder'¶

generic_data_source = 'GenericDataSource'¶

invalid = 'Invalid'¶

sap_ase_database = 'SAPAseDatabase'¶

sap_hana_database = 'SAPHanaDatabase'¶

sharepoint = 'Sharepoint'¶

sql_data_base = 'SQLDataBase'¶

sqldb = 'SQLDB'¶

system_state = 'SystemState'¶

vm = 'VM'¶

vmware_vm = 'VMwareVM'¶

class azure.mgmt.recoveryservicesbackup.models.PolicyType[source]¶

Bases: str, enum.Enum

An enumeration.

copy_only_full = 'CopyOnlyFull'¶

differential = 'Differential'¶

full = 'Full'¶

invalid = 'Invalid'¶

log = 'Log'¶

class azure.mgmt.recoveryservicesbackup.models.JobSupportedAction[source]¶

Bases: str, enum.Enum

An enumeration.

cancellable = 'Cancellable'¶

invalid = 'Invalid'¶

retriable = 'Retriable'¶

class azure.mgmt.recoveryservicesbackup.models.ProtectedItemState[source]¶

Bases: str, enum.Enum

An enumeration.

invalid = 'Invalid'¶

ir_pending = 'IRPending'¶

protected = 'Protected'¶

protection_error = 'ProtectionError'¶

protection_paused = 'ProtectionPaused'¶

protection_stopped = 'ProtectionStopped'¶

class azure.mgmt.recoveryservicesbackup.models.LastBackupStatus[source]¶

Bases: str, enum.Enum

An enumeration.

healthy = 'Healthy'¶

invalid = 'Invalid'¶

ir_pending = 'IRPending'¶

unhealthy = 'Unhealthy'¶

class azure.mgmt.recoveryservicesbackup.models.ProtectedItemHealthStatus[source]¶

Bases: str, enum.Enum

An enumeration.

healthy = 'Healthy'¶

invalid = 'Invalid'¶

ir_pending = 'IRPending'¶

not_reachable = 'NotReachable'¶

unhealthy = 'Unhealthy'¶

class azure.mgmt.recoveryservicesbackup.models.RestorePointType[source]¶

Bases: str, enum.Enum

An enumeration.

differential = 'Differential'¶

full = 'Full'¶

invalid = 'Invalid'¶

log = 'Log'¶

class azure.mgmt.recoveryservicesbackup.models.OverwriteOptions[source]¶

Bases: str, enum.Enum

An enumeration.

fail_on_conflict = 'FailOnConflict'¶

invalid = 'Invalid'¶

overwrite = 'Overwrite'¶

class azure.mgmt.recoveryservicesbackup.models.RecoveryMode[source]¶

Bases: str, enum.Enum

An enumeration.

file_recovery = 'FileRecovery'¶

invalid = 'Invalid'¶

workload_recovery = 'WorkloadRecovery'¶

class azure.mgmt.recoveryservicesbackup.models.SQLDataDirectoryType[source]¶

Bases: str, enum.Enum

An enumeration.

data = 'Data'¶

invalid = 'Invalid'¶

log = 'Log'¶

class azure.mgmt.recoveryservicesbackup.models.StorageType[source]¶

Bases: str, enum.Enum

An enumeration.

geo_redundant = 'GeoRedundant'¶

invalid = 'Invalid'¶

locally_redundant = 'LocallyRedundant'¶

class azure.mgmt.recoveryservicesbackup.models.StorageTypeState[source]¶

Bases: str, enum.Enum

An enumeration.

invalid = 'Invalid'¶

locked = 'Locked'¶

unlocked = 'Unlocked'¶

class azure.mgmt.recoveryservicesbackup.models.EnhancedSecurityState[source]¶

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'¶

enabled = 'Enabled'¶

invalid = 'Invalid'¶

class azure.mgmt.recoveryservicesbackup.models.SoftDeleteFeatureState[source]¶

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'¶

enabled = 'Enabled'¶

invalid = 'Invalid'¶

class azure.mgmt.recoveryservicesbackup.models.RestorePointQueryType[source]¶

Bases: str, enum.Enum

An enumeration.

all = 'All'¶

differential = 'Differential'¶

full = 'Full'¶

full_and_differential = 'FullAndDifferential'¶

invalid = 'Invalid'¶

log = 'Log'¶

class azure.mgmt.recoveryservicesbackup.models.RetentionDurationType[source]¶

Bases: str, enum.Enum

An enumeration.

days = 'Days'¶

invalid = 'Invalid'¶

months = 'Months'¶

weeks = 'Weeks'¶

years = 'Years'¶

class azure.mgmt.recoveryservicesbackup.models.RecoveryPointTierType[source]¶

Bases: str, enum.Enum

An enumeration.

hardened_rp = 'HardenedRP'¶

instant_rp = 'InstantRP'¶

invalid = 'Invalid'¶

class azure.mgmt.recoveryservicesbackup.models.RecoveryPointTierStatus[source]¶

Bases: str, enum.Enum

An enumeration.

deleted = 'Deleted'¶

disabled = 'Disabled'¶

invalid = 'Invalid'¶

valid = 'Valid'¶

class azure.mgmt.recoveryservicesbackup.models.BackupManagementType[source]¶

Bases: str, enum.Enum

An enumeration.

azure_backup_server = 'AzureBackupServer'¶

azure_iaas_vm = 'AzureIaasVM'¶

azure_sql = 'AzureSql'¶

azure_storage = 'AzureStorage'¶

azure_workload = 'AzureWorkload'¶

default_backup = 'DefaultBackup'¶

dpm = 'DPM'¶

invalid = 'Invalid'¶

mab = 'MAB'¶

class azure.mgmt.recoveryservicesbackup.models.JobStatus[source]¶

Bases: str, enum.Enum

An enumeration.

cancelled = 'Cancelled'¶

cancelling = 'Cancelling'¶

completed = 'Completed'¶

completed_with_warnings = 'CompletedWithWarnings'¶

failed = 'Failed'¶

in_progress = 'InProgress'¶

invalid = 'Invalid'¶

class azure.mgmt.recoveryservicesbackup.models.JobOperationType[source]¶

Bases: str, enum.Enum

An enumeration.

backup = 'Backup'¶

configure_backup = 'ConfigureBackup'¶

cross_region_restore = 'CrossRegionRestore'¶

delete_backup_data = 'DeleteBackupData'¶

disable_backup = 'DisableBackup'¶

invalid = 'Invalid'¶

register = 'Register'¶

restore = 'Restore'¶

un_register = 'UnRegister'¶

undelete = 'Undelete'¶

class azure.mgmt.recoveryservicesbackup.models.DayOfWeek[source]¶

Bases: str, enum.Enum

An enumeration.

friday = 'Friday'¶

monday = 'Monday'¶

saturday = 'Saturday'¶

sunday = 'Sunday'¶

thursday = 'Thursday'¶

tuesday = 'Tuesday'¶

wednesday = 'Wednesday'¶

class azure.mgmt.recoveryservicesbackup.models.RetentionScheduleFormat[source]¶

Bases: str, enum.Enum

An enumeration.

daily = 'Daily'¶

invalid = 'Invalid'¶

weekly = 'Weekly'¶

class azure.mgmt.recoveryservicesbackup.models.WeekOfMonth[source]¶

Bases: str, enum.Enum

An enumeration.

first = 'First'¶

fourth = 'Fourth'¶

invalid = 'Invalid'¶

last = 'Last'¶

second = 'Second'¶

third = 'Third'¶

class azure.mgmt.recoveryservicesbackup.models.MonthOfYear[source]¶

Bases: str, enum.Enum

An enumeration.

april = 'April'¶

august = 'August'¶

december = 'December'¶

february = 'February'¶

invalid = 'Invalid'¶

january = 'January'¶

july = 'July'¶

june = 'June'¶

march = 'March'¶

may = 'May'¶

november = 'November'¶

october = 'October'¶

september = 'September'¶

class azure.mgmt.recoveryservicesbackup.models.MabServerType[source]¶

Bases: str, enum.Enum

An enumeration.

azure_backup_server_container = 'AzureBackupServerContainer'¶

azure_sql_container = 'AzureSqlContainer'¶

cluster = 'Cluster'¶

dpm_container = 'DPMContainer'¶

generic_container = 'GenericContainer'¶

iaas_vm_container = 'IaasVMContainer'¶

iaas_vm_service_container = 'IaasVMServiceContainer'¶

invalid = 'Invalid'¶

mab_container = 'MABContainer'¶

sqlag_work_load_container = 'SQLAGWorkLoadContainer'¶

storage_container = 'StorageContainer'¶

unknown = 'Unknown'¶

vcenter = 'VCenter'¶

vm_app_container = 'VMAppContainer'¶

windows = 'Windows'¶

class azure.mgmt.recoveryservicesbackup.models.HttpStatusCode[source]¶

Bases: str, enum.Enum

An enumeration.

accepted = 'Accepted'¶

ambiguous = 'Ambiguous'¶

bad_gateway = 'BadGateway'¶

bad_request = 'BadRequest'¶

conflict = 'Conflict'¶

continue_enum = 'Continue'¶

created = 'Created'¶

expectation_failed = 'ExpectationFailed'¶

forbidden = 'Forbidden'¶

found = 'Found'¶

gateway_timeout = 'GatewayTimeout'¶

gone = 'Gone'¶

http_version_not_supported = 'HttpVersionNotSupported'¶

internal_server_error = 'InternalServerError'¶

length_required = 'LengthRequired'¶

method_not_allowed = 'MethodNotAllowed'¶

moved = 'Moved'¶

moved_permanently = 'MovedPermanently'¶

multiple_choices = 'MultipleChoices'¶

no_content = 'NoContent'¶

non_authoritative_information = 'NonAuthoritativeInformation'¶

not_acceptable = 'NotAcceptable'¶

not_found = 'NotFound'¶

not_implemented = 'NotImplemented'¶

not_modified = 'NotModified'¶

ok = 'OK'¶

partial_content = 'PartialContent'¶

payment_required = 'PaymentRequired'¶

precondition_failed = 'PreconditionFailed'¶

proxy_authentication_required = 'ProxyAuthenticationRequired'¶

redirect = 'Redirect'¶

redirect_keep_verb = 'RedirectKeepVerb'¶

redirect_method = 'RedirectMethod'¶

request_entity_too_large = 'RequestEntityTooLarge'¶

request_timeout = 'RequestTimeout'¶

request_uri_too_long = 'RequestUriTooLong'¶

requested_range_not_satisfiable = 'RequestedRangeNotSatisfiable'¶

reset_content = 'ResetContent'¶

see_other = 'SeeOther'¶

service_unavailable = 'ServiceUnavailable'¶

switching_protocols = 'SwitchingProtocols'¶

temporary_redirect = 'TemporaryRedirect'¶

unauthorized = 'Unauthorized'¶

unsupported_media_type = 'UnsupportedMediaType'¶

unused = 'Unused'¶

upgrade_required = 'UpgradeRequired'¶

use_proxy = 'UseProxy'¶

class azure.mgmt.recoveryservicesbackup.models.DataSourceType[source]¶

Bases: str, enum.Enum

An enumeration.

azure_file_share = 'AzureFileShare'¶

azure_sql_db = 'AzureSqlDb'¶

client = 'Client'¶

exchange = 'Exchange'¶

file_folder = 'FileFolder'¶

generic_data_source = 'GenericDataSource'¶

invalid = 'Invalid'¶

sap_ase_database = 'SAPAseDatabase'¶

sap_hana_database = 'SAPHanaDatabase'¶

sharepoint = 'Sharepoint'¶

sql_data_base = 'SQLDataBase'¶

sqldb = 'SQLDB'¶

system_state = 'SystemState'¶

vm = 'VM'¶

vmware_vm = 'VMwareVM'¶

class azure.mgmt.recoveryservicesbackup.models.CreateMode[source]¶

Bases: str, enum.Enum

An enumeration.

default = 'Default'¶

invalid = 'Invalid'¶

recover = 'Recover'¶

class azure.mgmt.recoveryservicesbackup.models.HealthState[source]¶

Bases: str, enum.Enum

An enumeration.

action_required = 'ActionRequired'¶

action_suggested = 'ActionSuggested'¶

invalid = 'Invalid'¶

passed = 'Passed'¶

class azure.mgmt.recoveryservicesbackup.models.ScheduleRunType[source]¶

Bases: str, enum.Enum

An enumeration.

daily = 'Daily'¶

invalid = 'Invalid'¶

weekly = 'Weekly'¶

class azure.mgmt.recoveryservicesbackup.models.SupportStatus[source]¶

Bases: str, enum.Enum

An enumeration.

default_off = 'DefaultOFF'¶

default_on = 'DefaultON'¶

invalid = 'Invalid'¶

not_supported = 'NotSupported'¶

supported = 'Supported'¶

class azure.mgmt.recoveryservicesbackup.models.WorkloadItemType[source]¶

Bases: str, enum.Enum

An enumeration.

invalid = 'Invalid'¶

sap_ase_database = 'SAPAseDatabase'¶

sap_ase_system = 'SAPAseSystem'¶

sap_hana_database = 'SAPHanaDatabase'¶

sap_hana_system = 'SAPHanaSystem'¶

sql_data_base = 'SQLDataBase'¶

sql_instance = 'SQLInstance'¶

class azure.mgmt.recoveryservicesbackup.models.UsagesUnit[source]¶

Bases: str, enum.Enum

An enumeration.

bytes = 'Bytes'¶

bytes_per_second = 'BytesPerSecond'¶

count = 'Count'¶

count_per_second = 'CountPerSecond'¶

percent = 'Percent'¶

seconds = 'Seconds'¶

class azure.mgmt.recoveryservicesbackup.models.ProtectionStatus[source]¶

Bases: str, enum.Enum

An enumeration.

invalid = 'Invalid'¶

not_protected = 'NotProtected'¶

protected = 'Protected'¶

protecting = 'Protecting'¶

protection_failed = 'ProtectionFailed'¶

class azure.mgmt.recoveryservicesbackup.models.FabricName[source]¶

Bases: str, enum.Enum

An enumeration.

azure = 'Azure'¶

invalid = 'Invalid'¶

class azure.mgmt.recoveryservicesbackup.models.Type[source]¶

Bases: str, enum.Enum

An enumeration.

backup_protected_item_count_summary = 'BackupProtectedItemCountSummary'¶

backup_protection_container_count_summary = 'BackupProtectionContainerCountSummary'¶

invalid = 'Invalid'¶

class azure.mgmt.recoveryservicesbackup.models.ValidationStatus[source]¶

Bases: str, enum.Enum

An enumeration.

failed = 'Failed'¶

invalid = 'Invalid'¶

succeeded = 'Succeeded'¶

class azure.mgmt.recoveryservicesbackup.models.IntentItemType[source]¶

Bases: str, enum.Enum

An enumeration.

invalid = 'Invalid'¶

sql_availability_group_container = 'SQLAvailabilityGroupContainer'¶

sql_instance = 'SQLInstance'¶

class azure.mgmt.recoveryservicesbackup.models.AzureFileShareType[source]¶

Bases: str, enum.Enum

An enumeration.

invalid = 'Invalid'¶

xsmb = 'XSMB'¶

xsync = 'XSync'¶

class azure.mgmt.recoveryservicesbackup.models.InquiryStatus[source]¶

Bases: str, enum.Enum

An enumeration.

failed = 'Failed'¶

invalid = 'Invalid'¶

success = 'Success'¶

class azure.mgmt.recoveryservicesbackup.models.BackupType[source]¶

Bases: str, enum.Enum

An enumeration.

copy_only_full = 'CopyOnlyFull'¶

differential = 'Differential'¶

full = 'Full'¶

invalid = 'Invalid'¶

log = 'Log'¶

class azure.mgmt.recoveryservicesbackup.models.OperationType[source]¶

Bases: str, enum.Enum

An enumeration.

invalid = 'Invalid'¶

register = 'Register'¶

reregister = 'Reregister'¶

class azure.mgmt.recoveryservicesbackup.models.ContainerType[source]¶

Bases: str, enum.Enum

An enumeration.

azure_backup_server_container = 'AzureBackupServerContainer'¶

azure_sql_container = 'AzureSqlContainer'¶

cluster = 'Cluster'¶

dpm_container = 'DPMContainer'¶

generic_container = 'GenericContainer'¶

iaas_vm_container = 'IaasVMContainer'¶

iaas_vm_service_container = 'IaasVMServiceContainer'¶

invalid = 'Invalid'¶

mab_container = 'MABContainer'¶

sqlag_work_load_container = 'SQLAGWorkLoadContainer'¶

storage_container = 'StorageContainer'¶

unknown = 'Unknown'¶

vcenter = 'VCenter'¶

vm_app_container = 'VMAppContainer'¶

windows = 'Windows'¶

class azure.mgmt.recoveryservicesbackup.models.BackupItemType[source]¶

Bases: str, enum.Enum

An enumeration.

azure_file_share = 'AzureFileShare'¶

azure_sql_db = 'AzureSqlDb'¶

client = 'Client'¶

exchange = 'Exchange'¶

file_folder = 'FileFolder'¶

generic_data_source = 'GenericDataSource'¶

invalid = 'Invalid'¶

sap_ase_database = 'SAPAseDatabase'¶

sap_hana_database = 'SAPHanaDatabase'¶

sharepoint = 'Sharepoint'¶

sql_data_base = 'SQLDataBase'¶

sqldb = 'SQLDB'¶

system_state = 'SystemState'¶

vm = 'VM'¶

vmware_vm = 'VMwareVM'¶

class azure.mgmt.recoveryservicesbackup.models.OperationStatusValues[source]¶

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'¶

failed = 'Failed'¶

in_progress = 'InProgress'¶

invalid = 'Invalid'¶

succeeded = 'Succeeded'¶