azure.mgmt.recoveryservicesbackup.models module

class azure.mgmt.recoveryservicesbackup.models.DPMContainerExtendedInfo(last_refreshed_at=None)[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.AzureBackupServerContainer(friendly_name=None, backup_management_type=None, registration_status=None, health_status=None, can_re_register=None, container_id=None, protected_item_count=None, dpm_agent_version=None, dpm_servers=None, upgrade_available=None, protection_status=None, extended_info=None)[source]

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

AzureBackupServer (DPMVenus) workload-specific protection container.

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

Parameters:
  • friendly_name (str) – Friendly name of the container.
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • registration_status (str) – Status of registration of the container with the Recovery Services Vault.
  • health_status (str) – Status of health of the container.
  • protectable_object_type (str) – Polymorphic Discriminator
  • 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 of 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.
Variables:

container_type (str or ContainerType) – Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’

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

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

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

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’
  • 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) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.AzureIaaSClassicComputeVMContainer(friendly_name=None, backup_management_type=None, registration_status=None, health_status=None, virtual_machine_id=None, virtual_machine_version=None, resource_group=None)[source]

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

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

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

Parameters:
  • friendly_name (str) – Friendly name of the container.
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • registration_status (str) – Status of registration of the container with the Recovery Services Vault.
  • health_status (str) – Status of health of the container.
  • protectable_object_type (str) – Polymorphic Discriminator
  • 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.
Variables:

container_type (str or ContainerType) – Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSClassicComputeVMProtectableItem(backup_management_type=None, friendly_name=None, protection_state=None, virtual_machine_id=None)[source]

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

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

Parameters:
  • backup_management_type (str) – Type of backup managemenent to backup an item.
  • 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’
  • protectable_item_type (str) – Polymorphic Discriminator
  • 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=None, source_resource_id=None, policy_id=None, last_recovery_point=None, friendly_name=None, virtual_machine_id=None, protection_status=None, protection_state=None, health_status=None, health_details=None, last_backup_status=None, last_backup_time=None, protected_item_data_id=None, extended_info=None)[source]

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

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

Parameters:
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • 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’
  • 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.
  • protected_item_type (str) – Polymorphic Discriminator
  • 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 of AzureIaaSVMHealthDetails) – Health details on this backup item.
  • 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.
  • protected_item_data_id (str) – Data ID of the protected item.
  • extended_info (AzureIaaSVMProtectedItemExtendedInfo) – Additional information for this backup item.
class azure.mgmt.recoveryservicesbackup.models.AzureIaaSComputeVMContainer(friendly_name=None, backup_management_type=None, registration_status=None, health_status=None, virtual_machine_id=None, virtual_machine_version=None, resource_group=None)[source]

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

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

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

Parameters:
  • friendly_name (str) – Friendly name of the container.
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • registration_status (str) – Status of registration of the container with the Recovery Services Vault.
  • health_status (str) – Status of health of the container.
  • protectable_object_type (str) – Polymorphic Discriminator
  • 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.
Variables:

container_type (str or ContainerType) – Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’

class azure.mgmt.recoveryservicesbackup.models.AzureIaaSComputeVMProtectableItem(backup_management_type=None, friendly_name=None, protection_state=None, virtual_machine_id=None)[source]

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

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

Parameters:
  • backup_management_type (str) – Type of backup managemenent to backup an item.
  • 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’
  • protectable_item_type (str) – Polymorphic Discriminator
  • 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=None, source_resource_id=None, policy_id=None, last_recovery_point=None, friendly_name=None, virtual_machine_id=None, protection_status=None, protection_state=None, health_status=None, health_details=None, last_backup_status=None, last_backup_time=None, protected_item_data_id=None, extended_info=None)[source]

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

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

Parameters:
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • 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’
  • 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.
  • protected_item_type (str) – Polymorphic Discriminator
  • 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 of AzureIaaSVMHealthDetails) – Health details on this backup item.
  • 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.
  • protected_item_data_id (str) – Data ID of the protected item.
  • extended_info (AzureIaaSVMProtectedItemExtendedInfo) – Additional information for this backup item.
class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMErrorInfo(error_code=None, error_title=None, error_string=None, recommendations=None)[source]

Bases: msrest.serialization.Model

Azure IaaS VM workload-specific error information.

Parameters:
  • 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 of str) – List of localized recommendations for above error code.
class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMHealthDetails(code=None, title=None, message=None, recommendations=None)[source]

Bases: msrest.serialization.Model

Azure IaaS VM workload-specific Health Details.

Parameters:
  • code (int) – Health Code
  • title (str) – Health Title
  • message (str) – Health Message
  • recommendations (list of str) – Health Recommended Actions
class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMJobTaskDetails(task_id=None, start_time=None, end_time=None, instance_id=None, duration=None, status=None, progress_percentage=None)[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.
class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMJobExtendedInfo(tasks_list=None, property_bag=None, progress_percentage=None, dynamic_error_message=None)[source]

Bases: msrest.serialization.Model

Azure IaaS VM workload-specific additional information for job.

Parameters:
  • tasks_list (list of AzureIaaSVMJobTaskDetails) – List of tasks associated with this job.
  • property_bag (dict) – Job properties.
  • progress_percentage (float) – Indicates progress of the job. Null if it has not started or completed.
  • dynamic_error_message (str) – Non localized error message on job execution.
class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMJob(entity_friendly_name=None, backup_management_type=None, operation=None, status=None, start_time=None, end_time=None, activity_id=None, duration=None, actions_info=None, error_details=None, virtual_machine_version=None, extended_info=None)[source]

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

Azure IaaS VM workload-specifc job object.

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’
  • 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) – Polymorphic Discriminator
  • duration (timedelta) – Time elapsed during the execution of this job.
  • actions_info (list of str or JobSupportedAction) – Gets or sets the state/actions applicable on this job like cancel/retry.
  • error_details (list of 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.AzureIaaSVMProtectedItemExtendedInfo(oldest_recovery_point=None, recovery_point_count=None, policy_inconsistent=None)[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.AzureIaaSVMProtectedItem(backup_management_type=None, workload_type=None, container_name=None, source_resource_id=None, policy_id=None, last_recovery_point=None, friendly_name=None, virtual_machine_id=None, protection_status=None, protection_state=None, health_status=None, health_details=None, last_backup_status=None, last_backup_time=None, protected_item_data_id=None, extended_info=None)[source]

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

IaaS VM workload-specific backup item.

Parameters:
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • 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’
  • 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.
  • protected_item_type (str) – Polymorphic Discriminator
  • 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 of AzureIaaSVMHealthDetails) – Health details on this backup item.
  • 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.
  • protected_item_data_id (str) – Data ID of the protected item.
  • extended_info (AzureIaaSVMProtectedItemExtendedInfo) – Additional information for this backup item.
class azure.mgmt.recoveryservicesbackup.models.SchedulePolicy[source]

Bases: msrest.serialization.Model

Base class for backup schedule.

Parameters:schedule_policy_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.RetentionPolicy[source]

Bases: msrest.serialization.Model

Base class for retention policy.

Parameters:retention_policy_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.AzureIaaSVMProtectionPolicy(protected_items_count=None, schedule_policy=None, retention_policy=None, time_zone=None)[source]

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

IaaS VM workload-specific backup policy.

Parameters:
  • protected_items_count (int) – Number of items associated with this policy.
  • backup_management_type (str) – Polymorphic Discriminator
  • 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.AzureSqlContainer(friendly_name=None, backup_management_type=None, registration_status=None, health_status=None)[source]

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

Azure Sql workload-specific container.

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

Parameters:
  • friendly_name (str) – Friendly name of the container.
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • registration_status (str) – Status of registration of the container with the Recovery Services Vault.
  • health_status (str) – Status of health of the container.
  • protectable_object_type (str) – Polymorphic Discriminator
Variables:

container_type (str or ContainerType) – Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’

class azure.mgmt.recoveryservicesbackup.models.AzureSqlProtectedItemExtendedInfo(oldest_recovery_point=None, recovery_point_count=None, policy_state=None)[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.AzureSqlProtectedItem(backup_management_type=None, workload_type=None, container_name=None, source_resource_id=None, policy_id=None, last_recovery_point=None, protected_item_data_id=None, protection_state=None, extended_info=None)[source]

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

Azure SQL workload-specific backup item.

Parameters:
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • 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’
  • 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.
  • protected_item_type (str) – Polymorphic Discriminator
  • 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.AzureSqlProtectionPolicy(protected_items_count=None, retention_policy=None)[source]

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

Azure SQL workload-specific backup policy.

Parameters:
  • protected_items_count (int) – Number of items associated with this policy.
  • backup_management_type (str) – Polymorphic Discriminator
  • retention_policy (RetentionPolicy) – Retention policy details.
class azure.mgmt.recoveryservicesbackup.models.BackupEngineExtendedInfo(database_name=None, protected_items_count=None, protected_servers_count=None, disk_count=None, used_disk_space=None, available_disk_space=None, refreshed_at=None, azure_protected_instances=None)[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) – Diskspace used in the backup engine.
  • available_disk_space (float) – Diskspace 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.BackupEngineBase(friendly_name=None, backup_management_type=None, registration_status=None, backup_engine_state=None, health_status=None, can_re_register=None, backup_engine_id=None, dpm_version=None, azure_backup_agent_version=None, is_azure_backup_agent_upgrade_available=None, is_dpm_upgrade_available=None, extended_info=None)[source]

Bases: msrest.serialization.Model

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

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’
  • 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) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.BackupEngineBaseResource(location=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (BackupEngineBase) – BackupEngineBaseResource properties
class azure.mgmt.recoveryservicesbackup.models.NameInfo(value=None, localized_value=None)[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.BackupManagementUsage(unit=None, quota_period=None, next_reset_time=None, current_value=None, limit=None, name=None)[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[source]

Bases: msrest.serialization.Model

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

Parameters:object_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.BackupRequestResource(location=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (BackupRequest) – BackupRequestResource properties
class azure.mgmt.recoveryservicesbackup.models.BackupResourceConfig(storage_type=None, storage_type_state=None)[source]

Bases: msrest.serialization.Model

The resource storage details.

Parameters:
  • 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=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (BackupResourceConfig) – BackupResourceConfigResource properties
class azure.mgmt.recoveryservicesbackup.models.BackupResourceVaultConfig(storage_type=None, storage_type_state=None, enhanced_security_state=None)[source]

Bases: msrest.serialization.Model

Backup resource vault config details.

Parameters:
  • 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’
class azure.mgmt.recoveryservicesbackup.models.BackupResourceVaultConfigResource(location=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (BackupResourceVaultConfig) – BackupResourceVaultConfigResource properties
class azure.mgmt.recoveryservicesbackup.models.BEKDetails(secret_url=None, secret_vault_id=None, secret_data=None)[source]

Bases: msrest.serialization.Model

BEK is bitlocker encrpytion 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=None)[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=None, expand=None)[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’
  • friendly_name (str) – Friendly name of the backup engine.
  • expand (str) – Attribute to add extended info.
class azure.mgmt.recoveryservicesbackup.models.BMSBackupSummariesQueryObject(type=None)[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=None, status=None, friendly_name=None)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • backup_management_type (str or BackupManagementType) – Backup management type for this container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • container_type (str or ContainerType) – Type of container for filter. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’
  • backup_engine_name (str) – Backup engine name
  • 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.BMSPOQueryObject(backup_management_type=None, status=None, friendly_name=None)[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’
  • status (str) – Backup status query parameter.
  • friendly_name (str) – Friendly name.
class azure.mgmt.recoveryservicesbackup.models.BMSRPQueryObject(start_date=None, end_date=None)[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.
class azure.mgmt.recoveryservicesbackup.models.ClientScriptForConnect(script_content=None, script_extension=None, os_type=None, url=None, script_name_suffix=None)[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) – Mandator 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.Day(date_property=None, is_last=None)[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.DailyRetentionFormat(days_of_the_month=None)[source]

Bases: msrest.serialization.Model

Daily retention format.

Parameters:days_of_the_month (list of Day) – List of days of the month.
class azure.mgmt.recoveryservicesbackup.models.RetentionDuration(count=None, duration_type=None)[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.DailyRetentionSchedule(retention_times=None, retention_duration=None)[source]

Bases: msrest.serialization.Model

Daily retention schedule.

Parameters:
  • retention_times (list of datetime) – Retention times of retention policy.
  • retention_duration (RetentionDuration) – Retention duration of retention Policy.
class azure.mgmt.recoveryservicesbackup.models.DpmBackupEngine(friendly_name=None, backup_management_type=None, registration_status=None, backup_engine_state=None, health_status=None, can_re_register=None, backup_engine_id=None, dpm_version=None, azure_backup_agent_version=None, is_azure_backup_agent_upgrade_available=None, is_dpm_upgrade_available=None, extended_info=None)[source]

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

Data Protection Manager (DPM) specific backup engine.

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’
  • 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) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.DpmContainer(friendly_name=None, backup_management_type=None, registration_status=None, health_status=None, can_re_register=None, container_id=None, protected_item_count=None, dpm_agent_version=None, dpm_servers=None, upgrade_available=None, protection_status=None, extended_info=None)[source]

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

DPM workload-specific protection container.

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

Parameters:
  • friendly_name (str) – Friendly name of the container.
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • registration_status (str) – Status of registration of the container with the Recovery Services Vault.
  • health_status (str) – Status of health of the container.
  • protectable_object_type (str) – Polymorphic Discriminator
  • 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 of 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.
Variables:

container_type (str or ContainerType) – Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’

class azure.mgmt.recoveryservicesbackup.models.DpmErrorInfo(error_string=None, recommendations=None)[source]

Bases: msrest.serialization.Model

DPM workload-specific error information.

Parameters:
  • error_string (str) – Localized error string.
  • recommendations (list of str) – List of localized recommendations for above error code.
class azure.mgmt.recoveryservicesbackup.models.DpmJobTaskDetails(task_id=None, start_time=None, end_time=None, duration=None, status=None)[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.DpmJobExtendedInfo(tasks_list=None, property_bag=None, dynamic_error_message=None)[source]

Bases: msrest.serialization.Model

Additional information on the DPM workload-specific job.

Parameters:
  • tasks_list (list of DpmJobTaskDetails) – List of tasks associated with this job.
  • property_bag (dict) – The job properties.
  • dynamic_error_message (str) – Non localized error message on job execution.
class azure.mgmt.recoveryservicesbackup.models.DpmJob(entity_friendly_name=None, backup_management_type=None, operation=None, status=None, start_time=None, end_time=None, activity_id=None, duration=None, dpm_server_name=None, container_name=None, container_type=None, workload_type=None, actions_info=None, error_details=None, extended_info=None)[source]

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

DPM workload-specifc job object.

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’
  • 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) – Polymorphic Discriminator
  • 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 of str or JobSupportedAction) – The state/actions applicable on this job like cancel/retry.
  • error_details (list of DpmErrorInfo) – The errors.
  • extended_info (DpmJobExtendedInfo) – Additional information for this job.
class azure.mgmt.recoveryservicesbackup.models.DPMProtectedItemExtendedInfo(protectable_object_load_path=None, protected=None, is_present_on_cloud=None, last_backup_status=None, last_refreshed_at=None, oldest_recovery_point=None, recovery_point_count=None, on_premise_oldest_recovery_point=None, on_premise_latest_recovery_point=None, on_premise_recovery_point_count=None, is_collocated=None, protection_group_name=None, disk_storage_used_in_bytes=None, total_disk_storage_size_in_bytes=None)[source]

Bases: msrest.serialization.Model

Additional information of DPM Protected item.

Parameters:
  • protectable_object_load_path (dict) – 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.DPMProtectedItem(backup_management_type=None, workload_type=None, container_name=None, source_resource_id=None, policy_id=None, last_recovery_point=None, friendly_name=None, backup_engine_name=None, protection_state=None, is_scheduled_for_deferred_delete=None, extended_info=None)[source]

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

Additional information on Backup engine specific backup item.

Parameters:
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • 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’
  • 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.
  • protected_item_type (str) – Polymorphic Discriminator
  • 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 backupengine. Possible values include: ‘Invalid’, ‘IRPending’, ‘Protected’, ‘ProtectionError’, ‘ProtectionStopped’, ‘ProtectionPaused’
  • is_scheduled_for_deferred_delete (bool) – To check if backup item is scheduled for deferred delete
  • extended_info (DPMProtectedItemExtendedInfo) – Extended info of the backup item.
class azure.mgmt.recoveryservicesbackup.models.EncryptionDetails(encryption_enabled=None, kek_url=None, secret_key_url=None, kek_vault_id=None, secret_key_vault_id=None)[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.ExportJobsOperationResultInfo(blob_url=None, blob_sas_key=None)[source]

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

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

Parameters:
  • object_type (str) – Polymorphic Discriminator
  • 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.
class azure.mgmt.recoveryservicesbackup.models.GenericRecoveryPoint(friendly_name=None, recovery_point_type=None, recovery_point_time=None, recovery_point_additional_info=None)[source]

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

Generic backup copy.

Parameters:
  • object_type (str) – Polymorphic Discriminator
  • 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=None)[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)[source]

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

IaaS VM workload-specific backup request.

Parameters:
  • object_type (str) – Polymorphic Discriminator
  • recovery_point_expiry_time_in_utc (datetime) – Backup copy will expire after the time specified (UTC).
class azure.mgmt.recoveryservicesbackup.models.IaaSVMContainer(friendly_name=None, backup_management_type=None, registration_status=None, health_status=None, virtual_machine_id=None, virtual_machine_version=None, resource_group=None)[source]

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

IaaS VM workload-specific container.

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

Parameters:
  • friendly_name (str) – Friendly name of the container.
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • registration_status (str) – Status of registration of the container with the Recovery Services Vault.
  • health_status (str) – Status of health of the container.
  • protectable_object_type (str) – Polymorphic Discriminator
  • 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.
Variables:

container_type (str or ContainerType) – Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’

class azure.mgmt.recoveryservicesbackup.models.IaasVMILRRegistrationRequest(recovery_point_id=None, virtual_machine_id=None, initiator_name=None, renew_existing_registration=None)[source]

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

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

Parameters:
  • object_type (str) – Polymorphic Discriminator
  • 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=None, friendly_name=None, protection_state=None, virtual_machine_id=None)[source]

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

IaaS VM workload-specific backup item.

Parameters:
  • backup_management_type (str) – Type of backup managemenent to backup an item.
  • 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’
  • protectable_item_type (str) – Polymorphic Discriminator
  • virtual_machine_id (str) – Fully qualified ARM ID of the virtual machine.
class azure.mgmt.recoveryservicesbackup.models.KEKDetails(key_url=None, key_vault_id=None, key_backup_data=None)[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)[source]

Bases: msrest.serialization.Model

BEK is bitlocker key. KEK is encryption key for BEK If the VM was encrypted then we will store follwing details : 1. Secret(BEK) - Url + Backup Data + vaultId. 2. Key(KEK) - Url + Backup Data + vaultId. BEK and KEK can potentiallty have different vault ids.

Parameters:
  • kek_details (KEKDetails) – KEK is encryption key for BEK.
  • bek_details (BEKDetails) – BEK is bitlocker encrpytion key.
class azure.mgmt.recoveryservicesbackup.models.RecoveryPointTierInformation(type=None, status=None)[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.IaasVMRecoveryPoint(recovery_point_type=None, recovery_point_time=None, recovery_point_additional_info=None, source_vm_storage_type=None, is_source_vm_encrypted=None, key_and_secret=None, is_instant_ilr_session_active=None, recovery_point_tier_details=None, is_managed_virtual_machine=None, virtual_machine_size=None)[source]

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

IaaS VM workload specific backup copy.

Parameters:
  • object_type (str) – Polymorphic Discriminator
  • 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.
  • 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 of RecoveryPointTierInformation) – Recovery point tier information.
  • is_managed_virtual_machine (bool) – Whether VM is with Managed Disks
  • virtual_machine_size (str) – Virtual Machine Size
class azure.mgmt.recoveryservicesbackup.models.IaasVMRestoreRequest(recovery_point_id=None, recovery_type=None, source_resource_id=None, target_virtual_machine_id=None, target_resource_group_id=None, storage_account_id=None, virtual_network_id=None, subnet_id=None, target_domain_name_id=None, region=None, affinity_group=None, create_new_cloud_service=None, encryption_details=None)[source]

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

IaaS VM workload-specific restore.

Parameters:
  • object_type (str) – Polymorphic Discriminator
  • 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’
  • 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.
  • encryption_details (EncryptionDetails) – Details needed if the VM was encrypted at the time of backup.
class azure.mgmt.recoveryservicesbackup.models.ILRRequest[source]

Bases: msrest.serialization.Model

Parameters to restore file/folders API.

Parameters:object_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.ILRRequestResource(location=None, tags=None, e_tag=None, properties=None)[source]

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

Parameters to restore file/folders 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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (ILRRequest) – ILRRequestResource properties
class azure.mgmt.recoveryservicesbackup.models.InstantItemRecoveryTarget(client_scripts=None)[source]

Bases: msrest.serialization.Model

Target details for file / folder restore.

Parameters:client_scripts (list of ClientScriptForConnect) – List of client scripts.
class azure.mgmt.recoveryservicesbackup.models.Job(entity_friendly_name=None, backup_management_type=None, operation=None, status=None, start_time=None, end_time=None, activity_id=None)[source]

Bases: msrest.serialization.Model

Defines workload agnostic properties for a job.

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’
  • 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) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.JobQueryObject(status=None, backup_management_type=None, operation=None, job_id=None, start_time=None, end_time=None)[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 managmenent for the job. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • operation (str or JobOperationType) – Type of operation. Possible values include: ‘Invalid’, ‘Register’, ‘UnRegister’, ‘ConfigureBackup’, ‘Backup’, ‘Restore’, ‘DisableBackup’, ‘DeleteBackupData’
  • 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=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (Job) – JobResource properties
class azure.mgmt.recoveryservicesbackup.models.WeeklyRetentionSchedule(days_of_the_week=None, retention_times=None, retention_duration=None)[source]

Bases: msrest.serialization.Model

Weekly retention schedule.

Parameters:
  • days_of_the_week (list of str or DayOfWeek) – List of days of week for weekly retention policy.
  • retention_times (list of datetime) – Retention times of retention policy.
  • retention_duration (RetentionDuration) – Retention duration of retention Policy.
class azure.mgmt.recoveryservicesbackup.models.WeeklyRetentionFormat(days_of_the_week=None, weeks_of_the_month=None)[source]

Bases: msrest.serialization.Model

Weekly retention format.

Parameters:
  • days_of_the_week (list of str or DayOfWeek) – List of days of the week.
  • weeks_of_the_month (list of str or WeekOfMonth) – List of weeks of month.
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)[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 of datetime) – Retention times of retention policy.
  • retention_duration (RetentionDuration) – Retention duration of retention Policy.
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)[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 of 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 of datetime) – Retention times of retention policy.
  • retention_duration (RetentionDuration) – Retention duration of retention Policy.
class azure.mgmt.recoveryservicesbackup.models.LongTermRetentionPolicy(daily_schedule=None, weekly_schedule=None, monthly_schedule=None, yearly_schedule=None)[source]

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

Long term retention policy.

Parameters:
class azure.mgmt.recoveryservicesbackup.models.LongTermSchedulePolicy[source]

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

Long term policy schedule.

Parameters:schedule_policy_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.MabContainerExtendedInfo(last_refreshed_at=None, backup_item_type=None, backup_items=None, policy_name=None, last_backup_status=None)[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’
  • backup_items (list of 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.MabContainer(friendly_name=None, backup_management_type=None, registration_status=None, health_status=None, can_re_register=None, container_id=None, protected_item_count=None, agent_version=None, extended_info=None)[source]

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

Container with items backed up using MAB backup engine.

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

Parameters:
  • friendly_name (str) – Friendly name of the container.
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • registration_status (str) – Status of registration of the container with the Recovery Services Vault.
  • health_status (str) – Status of health of the container.
  • protectable_object_type (str) – Polymorphic Discriminator
  • 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
Variables:

container_type (str or ContainerType) – Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’

class azure.mgmt.recoveryservicesbackup.models.MabErrorInfo(error_string=None, recommendations=None)[source]

Bases: msrest.serialization.Model

MAB workload-specific error information.

Parameters:
  • error_string (str) – Localized error string.
  • recommendations (list of str) – List of localized recommendations.
class azure.mgmt.recoveryservicesbackup.models.MabFileFolderProtectedItemExtendedInfo(last_refreshed_at=None, oldest_recovery_point=None, recovery_point_count=None)[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.MabFileFolderProtectedItem(backup_management_type=None, workload_type=None, container_name=None, source_resource_id=None, policy_id=None, last_recovery_point=None, friendly_name=None, computer_name=None, last_backup_status=None, protection_state=None, is_scheduled_for_deferred_delete=None, deferred_delete_sync_time_in_utc=None, extended_info=None)[source]

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

MAB workload-specific backup item.

Parameters:
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • 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’
  • 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.
  • protected_item_type (str) – Polymorphic Discriminator
  • 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.
  • protection_state (str) – Protected, ProtectionStopped, IRPending or ProtectionError
  • is_scheduled_for_deferred_delete (bool) – Specifies if the item is scheduled for deferred deletion.
  • deferred_delete_sync_time_in_utc (long) – Sync time for deferred deletion.
  • extended_info (MabFileFolderProtectedItemExtendedInfo) – Additional information with this backup item.
class azure.mgmt.recoveryservicesbackup.models.MabJobTaskDetails(task_id=None, start_time=None, end_time=None, duration=None, status=None)[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.MabJobExtendedInfo(tasks_list=None, property_bag=None, dynamic_error_message=None)[source]

Bases: msrest.serialization.Model

Additional information for the MAB workload-specific job.

Parameters:
  • tasks_list (list of MabJobTaskDetails) – List of tasks for this job.
  • property_bag (dict) – The job properties.
  • dynamic_error_message (str) – Non localized error message specific to this job.
class azure.mgmt.recoveryservicesbackup.models.MabJob(entity_friendly_name=None, backup_management_type=None, operation=None, status=None, start_time=None, end_time=None, activity_id=None, duration=None, actions_info=None, mab_server_name=None, mab_server_type=None, workload_type=None, error_details=None, extended_info=None)[source]

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

MAB workload-specific job.

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’
  • 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) – Polymorphic Discriminator
  • duration (timedelta) – Time taken by job to run.
  • actions_info (list of 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’
  • workload_type (str or WorkloadType) – Workload type of backup item. Possible values include: ‘Invalid’, ‘VM’, ‘FileFolder’, ‘AzureSqlDb’, ‘SQLDB’, ‘Exchange’, ‘Sharepoint’, ‘VMwareVM’, ‘SystemState’, ‘Client’, ‘GenericDataSource’
  • error_details (list of MabErrorInfo) – The errors.
  • extended_info (MabJobExtendedInfo) – Additional information on the job.
class azure.mgmt.recoveryservicesbackup.models.MabProtectionPolicy(protected_items_count=None, schedule_policy=None, retention_policy=None)[source]

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

Mab container-specific backup policy.

Parameters:
  • protected_items_count (int) – Number of items associated with this policy.
  • backup_management_type (str) – Polymorphic Discriminator
  • schedule_policy (SchedulePolicy) – Backup schedule of backup policy.
  • retention_policy (RetentionPolicy) – Retention policy details.
class azure.mgmt.recoveryservicesbackup.models.OperationResultInfo(job_list=None)[source]

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

Operation result info.

Parameters:
  • object_type (str) – Polymorphic Discriminator
  • job_list (list of str) – List of jobs created by this operation.
class azure.mgmt.recoveryservicesbackup.models.OperationResultInfoBase[source]

Bases: msrest.serialization.Model

Base class for operation result info.

Parameters:object_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.OperationResultInfoBaseResource(status_code=None, headers=None, operation=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.operation_worker_response.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) – HTTP headers associated with this operation.
  • operation (OperationResultInfoBase) – OperationResultInfoBaseResource operation
class azure.mgmt.recoveryservicesbackup.models.OperationStatusError(code=None, message=None)[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[source]

Bases: msrest.serialization.Model

Base class for additional information of operation status.

Parameters:object_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.OperationStatus(id=None, name=None, status=None, start_time=None, end_time=None, error=None, properties=None)[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.OperationStatusJobExtendedInfo(job_id=None)[source]

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

Operation status job extended info.

Parameters:
  • object_type (str) – Polymorphic Discriminator
  • 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)[source]

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

Operation status extended info for list of jobs.

Parameters:
  • object_type (str) – Polymorphic Discriminator
  • job_ids (list of str) – IDs of the jobs created for the protected item.
  • failed_jobs_error (dict) – Stores all the failed jobs along with the corresponding error codes.
class azure.mgmt.recoveryservicesbackup.models.OperationStatusProvisionILRExtendedInfo(recovery_target=None)[source]

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

Operation status extended info for ILR provision action.

Parameters:
class azure.mgmt.recoveryservicesbackup.models.OperationWorkerResponse(status_code=None, headers=None)[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) – HTTP headers associated with this operation.
class azure.mgmt.recoveryservicesbackup.models.ProtectedItem(backup_management_type=None, workload_type=None, container_name=None, source_resource_id=None, policy_id=None, last_recovery_point=None)[source]

Bases: msrest.serialization.Model

Base class for backup items.

Parameters:
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the backed up item. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • 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’
  • 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.
  • protected_item_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.ProtectedItemQueryObject(health_state=None, backup_management_type=None, item_type=None, policy_name=None, container_name=None, backup_engine_name=None, friendly_name=None)[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’
  • 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’
  • 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
class azure.mgmt.recoveryservicesbackup.models.ProtectedItemResource(location=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (ProtectedItem) – ProtectedItemResource properties
class azure.mgmt.recoveryservicesbackup.models.ProtectionContainer(friendly_name=None, backup_management_type=None, registration_status=None, health_status=None)[source]

Bases: msrest.serialization.Model

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.

Parameters:
  • friendly_name (str) – Friendly name of the container.
  • backup_management_type (str or BackupManagementType) – Type of backup managemenent for the container. Possible values include: ‘Invalid’, ‘AzureIaasVM’, ‘MAB’, ‘DPM’, ‘AzureBackupServer’, ‘AzureSql’
  • registration_status (str) – Status of registration of the container with the Recovery Services Vault.
  • health_status (str) – Status of health of the container.
  • protectable_object_type (str) – Polymorphic Discriminator
Variables:

container_type (str or ContainerType) – Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. Possible values include: ‘Invalid’, ‘Unknown’, ‘IaasVMContainer’, ‘IaasVMServiceContainer’, ‘DPMContainer’, ‘AzureBackupServerContainer’, ‘MABContainer’, ‘Cluster’, ‘AzureSqlContainer’, ‘Windows’, ‘VCenter’

class azure.mgmt.recoveryservicesbackup.models.ProtectionContainerResource(location=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (ProtectionContainer) – ProtectionContainerResource properties
class azure.mgmt.recoveryservicesbackup.models.ProtectionPolicy(protected_items_count=None)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • protected_items_count (int) – Number of items associated with this policy.
  • backup_management_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.ProtectionPolicyQueryObject(backup_management_type=None)[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’
class azure.mgmt.recoveryservicesbackup.models.ProtectionPolicyResource(location=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (ProtectionPolicy) – ProtectionPolicyResource properties
class azure.mgmt.recoveryservicesbackup.models.RecoveryPoint[source]

Bases: msrest.serialization.Model

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

Parameters:object_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.RecoveryPointResource(location=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (RecoveryPoint) – RecoveryPointResource properties
class azure.mgmt.recoveryservicesbackup.models.Resource(location=None, tags=None, e_tag=None)[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) – Resource tags.
  • e_tag (str) – Optional ETag.
class azure.mgmt.recoveryservicesbackup.models.ResourceList(next_link=None)[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.RestoreRequest[source]

Bases: msrest.serialization.Model

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

Parameters:object_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.RestoreRequestResource(location=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (RestoreRequest) – RestoreRequestResource properties
class azure.mgmt.recoveryservicesbackup.models.SimpleRetentionPolicy(retention_duration=None)[source]

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

Simple policy retention.

Parameters:
  • retention_policy_type (str) – Polymorphic Discriminator
  • 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=None)[source]

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

Simple policy schedule.

Parameters:
  • schedule_policy_type (str) – Polymorphic Discriminator
  • schedule_run_frequency (str or ScheduleRunType) – Frequency of the schedule operation of this policy. Possible values include: ‘Invalid’, ‘Daily’, ‘Weekly’
  • schedule_run_days (list of str or DayOfWeek) – List of days of week this schedule has to be run.
  • schedule_run_times (list of 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.TokenInformation(token=None, expiry_time_in_utc_ticks=None, security_pin=None)[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.WorkloadProtectableItem(backup_management_type=None, friendly_name=None, protection_state=None)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • backup_management_type (str) – Type of backup managemenent to backup an item.
  • 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’
  • protectable_item_type (str) – Polymorphic Discriminator
class azure.mgmt.recoveryservicesbackup.models.WorkloadProtectableItemResource(location=None, tags=None, e_tag=None, properties=None)[source]

Bases: azure.mgmt.recoveryservicesbackup.models.resource.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) – Resource tags.
  • e_tag (str) – Optional ETag.
  • properties (WorkloadProtectableItem) – WorkloadProtectableItemResource properties
class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryDisplay(provider=None, resource=None, operation=None, description=None)[source]

Bases: msrest.serialization.Model

Localized display information of an operation.

Parameters:
  • provider (str) – Name of the provider for display purposes
  • resource (str) – Name of the resource type for display purposes
  • operation (str) – Name of the operation for display purposes
  • description (str) – Description of the operation for display purposes
class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryForLogSpecification(name=None, display_name=None, blob_duration=None)[source]

Bases: msrest.serialization.Model

Class to represent shoebox log specification in json client discovery.

Parameters:
  • name (str) – Name
  • display_name (str) – Localized display name
  • blob_duration (str) – blob duration
class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryForServiceSpecification(log_specifications=None)[source]

Bases: msrest.serialization.Model

Class to represent shoebox service specification in json client discovery.

Parameters:log_specifications (list of ClientDiscoveryForLogSpecification) – List of log specifications of this operation.
class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryForProperties(service_specification=None)[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.ClientDiscoveryValueForSingleApi(name=None, display=None, origin=None, properties=None)[source]

Bases: msrest.serialization.Model

Available operation details.

Parameters:
  • name (str) – Name
  • 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) – Properties
class azure.mgmt.recoveryservicesbackup.models.BackupEngineBaseResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of BackupEngineBaseResource object

class azure.mgmt.recoveryservicesbackup.models.RecoveryPointResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of RecoveryPointResource object

class azure.mgmt.recoveryservicesbackup.models.JobResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of JobResource object

class azure.mgmt.recoveryservicesbackup.models.ProtectionPolicyResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProtectionPolicyResource object

class azure.mgmt.recoveryservicesbackup.models.WorkloadProtectableItemResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of WorkloadProtectableItemResource object

class azure.mgmt.recoveryservicesbackup.models.ProtectedItemResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProtectedItemResource object

class azure.mgmt.recoveryservicesbackup.models.ProtectionContainerResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProtectionContainerResource object

class azure.mgmt.recoveryservicesbackup.models.BackupManagementUsagePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of BackupManagementUsage object

class azure.mgmt.recoveryservicesbackup.models.ClientDiscoveryValueForSingleApiPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ClientDiscoveryValueForSingleApi object

class azure.mgmt.recoveryservicesbackup.models.JobSupportedAction[source]

Bases: enum.Enum

cancellable = 'Cancellable'
invalid = 'Invalid'
retriable = 'Retriable'
class azure.mgmt.recoveryservicesbackup.models.ProtectionState[source]

Bases: enum.Enum

invalid = 'Invalid'
ir_pending = 'IRPending'
protected = 'Protected'
protection_error = 'ProtectionError'
protection_paused = 'ProtectionPaused'
protection_stopped = 'ProtectionStopped'
class azure.mgmt.recoveryservicesbackup.models.HealthStatus[source]

Bases: enum.Enum

action_required = 'ActionRequired'
action_suggested = 'ActionSuggested'
invalid = 'Invalid'
passed = 'Passed'
class azure.mgmt.recoveryservicesbackup.models.ProtectedItemState[source]

Bases: enum.Enum

invalid = 'Invalid'
ir_pending = 'IRPending'
protected = 'Protected'
protection_error = 'ProtectionError'
protection_paused = 'ProtectionPaused'
protection_stopped = 'ProtectionStopped'
class azure.mgmt.recoveryservicesbackup.models.BackupManagementType[source]

Bases: enum.Enum

azure_backup_server = 'AzureBackupServer'
azure_iaas_vm = 'AzureIaasVM'
azure_sql = 'AzureSql'
dpm = 'DPM'
invalid = 'Invalid'
mab = 'MAB'
class azure.mgmt.recoveryservicesbackup.models.UsagesUnit[source]

Bases: enum.Enum

bytes = 'Bytes'
bytes_per_second = 'BytesPerSecond'
count = 'Count'
count_per_second = 'CountPerSecond'
percent = 'Percent'
seconds = 'Seconds'
class azure.mgmt.recoveryservicesbackup.models.StorageType[source]

Bases: enum.Enum

geo_redundant = 'GeoRedundant'
invalid = 'Invalid'
locally_redundant = 'LocallyRedundant'
class azure.mgmt.recoveryservicesbackup.models.StorageTypeState[source]

Bases: enum.Enum

invalid = 'Invalid'
locked = 'Locked'
unlocked = 'Unlocked'
class azure.mgmt.recoveryservicesbackup.models.EnhancedSecurityState[source]

Bases: enum.Enum

disabled = 'Disabled'
enabled = 'Enabled'
invalid = 'Invalid'
class azure.mgmt.recoveryservicesbackup.models.Type[source]

Bases: enum.Enum

backup_protected_item_count_summary = 'BackupProtectedItemCountSummary'
backup_protection_container_count_summary = 'BackupProtectionContainerCountSummary'
invalid = 'Invalid'
class azure.mgmt.recoveryservicesbackup.models.ContainerType[source]

Bases: enum.Enum

azure_backup_server_container = 'AzureBackupServerContainer'
azure_sql_container = 'AzureSqlContainer'
cluster = 'Cluster'
dpm_container = 'DPMContainer'
iaas_vm_container = 'IaasVMContainer'
iaas_vm_service_container = 'IaasVMServiceContainer'
invalid = 'Invalid'
mab_container = 'MABContainer'
unknown = 'Unknown'
vcenter = 'VCenter'
windows = 'Windows'
class azure.mgmt.recoveryservicesbackup.models.RetentionDurationType[source]

Bases: enum.Enum

days = 'Days'
invalid = 'Invalid'
months = 'Months'
weeks = 'Weeks'
years = 'Years'
class azure.mgmt.recoveryservicesbackup.models.RecoveryPointTierType[source]

Bases: enum.Enum

hardened_rp = 'HardenedRP'
instant_rp = 'InstantRP'
invalid = 'Invalid'
class azure.mgmt.recoveryservicesbackup.models.RecoveryPointTierStatus[source]

Bases: enum.Enum

deleted = 'Deleted'
disabled = 'Disabled'
invalid = 'Invalid'
valid = 'Valid'
class azure.mgmt.recoveryservicesbackup.models.RecoveryType[source]

Bases: enum.Enum

alternate_location = 'AlternateLocation'
invalid = 'Invalid'
original_location = 'OriginalLocation'
restore_disks = 'RestoreDisks'
class azure.mgmt.recoveryservicesbackup.models.JobStatus[source]

Bases: enum.Enum

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: enum.Enum

backup = 'Backup'
configure_backup = 'ConfigureBackup'
delete_backup_data = 'DeleteBackupData'
disable_backup = 'DisableBackup'
invalid = 'Invalid'
register = 'Register'
restore = 'Restore'
un_register = 'UnRegister'
class azure.mgmt.recoveryservicesbackup.models.DayOfWeek[source]

Bases: enum.Enum

friday = 'Friday'
monday = 'Monday'
saturday = 'Saturday'
sunday = 'Sunday'
thursday = 'Thursday'
tuesday = 'Tuesday'
wednesday = 'Wednesday'
class azure.mgmt.recoveryservicesbackup.models.RetentionScheduleFormat[source]

Bases: enum.Enum

daily = 'Daily'
invalid = 'Invalid'
weekly = 'Weekly'
class azure.mgmt.recoveryservicesbackup.models.WeekOfMonth[source]

Bases: enum.Enum

first = 'First'
fourth = 'Fourth'
last = 'Last'
second = 'Second'
third = 'Third'
class azure.mgmt.recoveryservicesbackup.models.MonthOfYear[source]

Bases: enum.Enum

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.BackupItemType[source]

Bases: enum.Enum

azure_sql_db = 'AzureSqlDb'
client = 'Client'
exchange = 'Exchange'
file_folder = 'FileFolder'
generic_data_source = 'GenericDataSource'
invalid = 'Invalid'
sharepoint = 'Sharepoint'
sqldb = 'SQLDB'
system_state = 'SystemState'
vm = 'VM'
vmware_vm = 'VMwareVM'
class azure.mgmt.recoveryservicesbackup.models.MabServerType[source]

Bases: enum.Enum

azure_backup_server_container = 'AzureBackupServerContainer'
azure_sql_container = 'AzureSqlContainer'
cluster = 'Cluster'
dpm_container = 'DPMContainer'
iaas_vm_container = 'IaasVMContainer'
iaas_vm_service_container = 'IaasVMServiceContainer'
invalid = 'Invalid'
mab_container = 'MABContainer'
unknown = 'Unknown'
vcenter = 'VCenter'
windows = 'Windows'
class azure.mgmt.recoveryservicesbackup.models.WorkloadType[source]

Bases: enum.Enum

azure_sql_db = 'AzureSqlDb'
client = 'Client'
exchange = 'Exchange'
file_folder = 'FileFolder'
generic_data_source = 'GenericDataSource'
invalid = 'Invalid'
sharepoint = 'Sharepoint'
sqldb = 'SQLDB'
system_state = 'SystemState'
vm = 'VM'
vmware_vm = 'VMwareVM'
class azure.mgmt.recoveryservicesbackup.models.OperationStatusValues[source]

Bases: enum.Enum

canceled = 'Canceled'
failed = 'Failed'
in_progress = 'InProgress'
invalid = 'Invalid'
succeeded = 'Succeeded'
class azure.mgmt.recoveryservicesbackup.models.HttpStatusCode[source]

Bases: enum.Enum

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: enum.Enum

azure_sql_db = 'AzureSqlDb'
client = 'Client'
exchange = 'Exchange'
file_folder = 'FileFolder'
generic_data_source = 'GenericDataSource'
invalid = 'Invalid'
sharepoint = 'Sharepoint'
sqldb = 'SQLDB'
system_state = 'SystemState'
vm = 'VM'
vmware_vm = 'VMwareVM'
class azure.mgmt.recoveryservicesbackup.models.HealthState[source]

Bases: enum.Enum

action_required = 'ActionRequired'
action_suggested = 'ActionSuggested'
invalid = 'Invalid'
passed = 'Passed'
class azure.mgmt.recoveryservicesbackup.models.ScheduleRunType[source]

Bases: enum.Enum

daily = 'Daily'
invalid = 'Invalid'
weekly = 'Weekly'
class azure.mgmt.recoveryservicesbackup.models.ProtectionStatus[source]

Bases: enum.Enum

invalid = 'Invalid'
not_protected = 'NotProtected'
protected = 'Protected'
protecting = 'Protecting'