azure.mgmt.dataprotection.models module¶

class azure.mgmt.dataprotection.models.AbsoluteDeleteOption(*, duration: str, **kwargs: Any)[source]¶

Bases: DeleteOption

Delete option with duration.

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

Variables:

duration (str) – Duration of deletion after given timespan. Required.
object_type (str) – Type of the specific object - used for deserializing. Required.

Keyword Arguments:

duration (str) – Duration of deletion after given timespan. Required.

class azure.mgmt.dataprotection.models.AbsoluteMarker(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

AbsoluteMarker.

ALL_BACKUP = 'AllBackup'¶

FIRST_OF_DAY = 'FirstOfDay'¶

FIRST_OF_MONTH = 'FirstOfMonth'¶

FIRST_OF_WEEK = 'FirstOfWeek'¶

FIRST_OF_YEAR = 'FirstOfYear'¶

class azure.mgmt.dataprotection.models.AdHocBackupRuleOptions(*, rule_name: str, trigger_option: _models.AdhocBackupTriggerOption, **kwargs: Any)[source]¶

Bases: Model

Adhoc backup rules.

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

Variables:

rule_name (str) – Required.
trigger_option (AdhocBackupTriggerOption) – Adhoc backup trigger option. Required.

Keyword Arguments:

rule_name (str) – Required.
trigger_option (AdhocBackupTriggerOption) – Adhoc backup trigger option. Required.

class azure.mgmt.dataprotection.models.AdhocBackupTriggerOption(*, retention_tag_override: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Adhoc backup trigger option.

Variables:: retention_tag_override (str)
Keyword Arguments:: retention_tag_override (str)

class azure.mgmt.dataprotection.models.AdhocBasedTaggingCriteria(*, tag_info: _models.RetentionTag | None = None, **kwargs: Any)[source]¶

Bases: Model

Adhoc backup tagging criteria.

Variables:: tag_info (RetentionTag) – Retention tag information.
Keyword Arguments:: tag_info (RetentionTag) – Retention tag information.

class azure.mgmt.dataprotection.models.AdhocBasedTriggerContext(*, tagging_criteria: _models.AdhocBasedTaggingCriteria, **kwargs: Any)[source]¶

Bases: TriggerContext

Adhoc trigger context.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
tagging_criteria (AdhocBasedTaggingCriteria) – Tagging Criteria containing retention tag for adhoc backup. Required.

Keyword Arguments:

tagging_criteria (AdhocBasedTaggingCriteria) – Tagging Criteria containing retention tag for adhoc backup. Required.

class azure.mgmt.dataprotection.models.AlertsState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

AlertsState.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.dataprotection.models.AuthCredentials(**kwargs: Any)[source]¶

Bases: Model

Base class for different types of authentication credentials.

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

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.AzureBackupDiscreteRecoveryPoint(*, recovery_point_time: datetime, friendly_name: str | None = None, recovery_point_data_stores_details: List[_models.RecoveryPointDataStoreDetails] | None = None, policy_name: str | None = None, policy_version: str | None = None, recovery_point_id: str | None = None, recovery_point_type: str | None = None, retention_tag_name: str | None = None, retention_tag_version: str | None = None, recovery_point_state: str | _models.RecoveryPointCompletionState | None = None, **kwargs: Any)[source]¶

Bases: AzureBackupRecoveryPoint

Azure backup discrete RecoveryPoint.

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

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

Variables:

object_type (str) – Required.
friendly_name (str)
recovery_point_data_stores_details (list[RecoveryPointDataStoreDetails])
recovery_point_time (datetime) – Required.
policy_name (str)
policy_version (str)
recovery_point_id (str)
recovery_point_type (str)
retention_tag_name (str)
retention_tag_version (str)
expiry_time (datetime)
recovery_point_state (str or RecoveryPointCompletionState) – Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up). Known values are: “Completed” and “Partial”.

Keyword Arguments:

friendly_name (str)
recovery_point_data_stores_details (list[RecoveryPointDataStoreDetails])
recovery_point_time (datetime) – Required.
policy_name (str)
policy_version (str)
recovery_point_id (str)
recovery_point_type (str)
retention_tag_name (str)
retention_tag_version (str)
recovery_point_state (str or RecoveryPointCompletionState) – Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up). Known values are: “Completed” and “Partial”.

class azure.mgmt.dataprotection.models.AzureBackupFindRestorableTimeRangesRequest(*, source_data_store_type: str | _models.RestoreSourceDataStoreType, start_time: str | None = None, end_time: str | None = None, **kwargs: Any)[source]¶

Bases: Model

List Restore Ranges Request.

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

Variables:

source_data_store_type (str or RestoreSourceDataStoreType) – Gets or sets the type of the source data store. Required. Known values are: “OperationalStore”, “VaultStore”, and “ArchiveStore”.
start_time (str) – Start time for the List Restore Ranges request. ISO 8601 format.
end_time (str) – End time for the List Restore Ranges request. ISO 8601 format.

Keyword Arguments:

source_data_store_type (str or RestoreSourceDataStoreType) – Gets or sets the type of the source data store. Required. Known values are: “OperationalStore”, “VaultStore”, and “ArchiveStore”.
start_time (str) – Start time for the List Restore Ranges request. ISO 8601 format.
end_time (str) – End time for the List Restore Ranges request. ISO 8601 format.

class azure.mgmt.dataprotection.models.AzureBackupFindRestorableTimeRangesRequestResource(*, subscription_id: str | None = None, uri: str | None = None, headers: Dict[str, List[str]] | None = None, supported_group_versions: List[str] | None = None, culture_info: str | None = None, parameters: Dict[str, str] | None = None, http_method: str | None = None, content: _models.AzureBackupFindRestorableTimeRangesRequest | None = None, **kwargs: Any)[source]¶

Bases: DppWorkerRequest

List Restore Ranges Request.

Variables:

subscription_id (str)
uri (str)
headers (dict[str, list[str]]) – Dictionary of <components·ikn5y4·schemas·dppworkerrequest·properties·headers·additionalproperties>.
supported_group_versions (list[str])
culture_info (str)
parameters (dict[str, str]) – Dictionary of <string>.
http_method (str)
content (AzureBackupFindRestorableTimeRangesRequest) – AzureBackupFindRestorableTimeRangesRequestResource content.

Keyword Arguments:

subscription_id (str)
uri (str)
headers (dict[str, list[str]]) – Dictionary of <components·ikn5y4·schemas·dppworkerrequest·properties·headers·additionalproperties>.
supported_group_versions (list[str])
culture_info (str)
parameters (dict[str, str]) – Dictionary of <string>.
http_method (str)
content (AzureBackupFindRestorableTimeRangesRequest) – AzureBackupFindRestorableTimeRangesRequestResource content.

class azure.mgmt.dataprotection.models.AzureBackupFindRestorableTimeRangesResponse(*, restorable_time_ranges: List[_models.RestorableTimeRange] | None = None, object_type: str | None = None, **kwargs: Any)[source]¶

Bases: Model

List Restore Ranges Response.

Variables:

restorable_time_ranges (list[RestorableTimeRange]) – Returns the Restore Ranges available on the Backup Instance.
object_type (str)

Keyword Arguments:

restorable_time_ranges (list[RestorableTimeRange]) – Returns the Restore Ranges available on the Backup Instance.
object_type (str)

class azure.mgmt.dataprotection.models.AzureBackupFindRestorableTimeRangesResponseResource(*, properties: _models.AzureBackupFindRestorableTimeRangesResponse | None = None, **kwargs: Any)[source]¶

Bases: DppResource

List Restore Ranges Response.

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/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
properties (AzureBackupFindRestorableTimeRangesResponse) – AzureBackupFindRestorableTimeRangesResponseResource properties.

Keyword Arguments:

properties (AzureBackupFindRestorableTimeRangesResponse) – AzureBackupFindRestorableTimeRangesResponseResource properties.

class azure.mgmt.dataprotection.models.AzureBackupJob(*, activity_id: str, backup_instance_friendly_name: str, data_source_id: str, data_source_location: str, data_source_name: str, data_source_type: str, is_user_triggered: bool, operation: str, operation_category: str, progress_enabled: bool, source_resource_group: str, source_subscription_id: str, start_time: datetime, status: str, subscription_id: str, supported_actions: List[str], vault_name: str, data_source_set_name: str | None = None, duration: str | None = None, etag: str | None = None, source_data_store_name: str | None = None, destination_data_store_name: str | None = None, **kwargs: Any)[source]¶

Bases: Model

AzureBackup Job Class.

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

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

Variables:

activity_id (str) – Job Activity Id. Required.
backup_instance_friendly_name (str) – Name of the Backup Instance. Required.
backup_instance_id (str) – ARM ID of the Backup Instance.
data_source_id (str) – ARM ID of the DataSource. Required.
data_source_location (str) – Location of the DataSource. Required.
data_source_name (str) – User Friendly Name of the DataSource. Required.
data_source_set_name (str) – Data Source Set Name of the DataSource.
data_source_type (str) – Type of DataSource. Required.
duration (str) – Total run time of the job. ISO 8601 format.
end_time (datetime) – EndTime of the job(in UTC).
error_details (list[UserFacingError]) – A List, detailing the errors related to the job.
extended_info (JobExtendedInfo) – Extended Information about the job.
is_user_triggered (bool) – Indicated that whether the job is adhoc(true) or scheduled(false). Required.
operation (str) – It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure. Required.
operation_category (str) – It indicates the type of Job i.e. Backup/Restore/Tiering/Management. Required.
policy_id (str) – ARM ID of the policy.
policy_name (str) – Name of the policy.
progress_enabled (bool) – Indicated whether progress is enabled for the job. Required.
progress_url (str) – Url which contains job’s progress.
rehydration_priority (str) – Priority to be used for rehydration.
restore_type (str) – It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR.
source_resource_group (str) – Resource Group Name of the Datasource. Required.
source_subscription_id (str) – SubscriptionId corresponding to the DataSource. Required.
start_time (datetime) – StartTime of the job(in UTC). Required.
status (str) – Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning. Required.
subscription_id (str) – Subscription Id of the corresponding backup vault. Required.
supported_actions (list[str]) – List of supported actions. Required.
vault_name (str) – Name of the vault. Required.
etag (str)
source_data_store_name (str)
destination_data_store_name (str)

Keyword Arguments:

activity_id (str) – Job Activity Id. Required.
backup_instance_friendly_name (str) – Name of the Backup Instance. Required.
data_source_id (str) – ARM ID of the DataSource. Required.
data_source_location (str) – Location of the DataSource. Required.
data_source_name (str) – User Friendly Name of the DataSource. Required.
data_source_set_name (str) – Data Source Set Name of the DataSource.
data_source_type (str) – Type of DataSource. Required.
duration (str) – Total run time of the job. ISO 8601 format.
is_user_triggered (bool) – Indicated that whether the job is adhoc(true) or scheduled(false). Required.
operation (str) – It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure. Required.
operation_category (str) – It indicates the type of Job i.e. Backup/Restore/Tiering/Management. Required.
progress_enabled (bool) – Indicated whether progress is enabled for the job. Required.
source_resource_group (str) – Resource Group Name of the Datasource. Required.
source_subscription_id (str) – SubscriptionId corresponding to the DataSource. Required.
start_time (datetime) – StartTime of the job(in UTC). Required.
status (str) – Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning. Required.
subscription_id (str) – Subscription Id of the corresponding backup vault. Required.
supported_actions (list[str]) – List of supported actions. Required.
vault_name (str) – Name of the vault. Required.
etag (str)
source_data_store_name (str)
destination_data_store_name (str)

class azure.mgmt.dataprotection.models.AzureBackupJobResource(*, properties: _models.AzureBackupJob | None = None, **kwargs: Any)[source]¶

Bases: DppResource

AzureBackup Job Resource 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/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
properties (AzureBackupJob) – AzureBackupJobResource properties.

Keyword Arguments:

properties (AzureBackupJob) – AzureBackupJobResource properties.

class azure.mgmt.dataprotection.models.AzureBackupJobResourceList(*, next_link: str | None = None, value: List[_models.AzureBackupJobResource] | None = None, **kwargs: Any)[source]¶

Bases: DppResourceList

List of AzureBackup Job resources.

Variables:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[AzureBackupJobResource]) – List of resources.

Keyword Arguments:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[AzureBackupJobResource]) – List of resources.

class azure.mgmt.dataprotection.models.AzureBackupParams(*, backup_type: str, **kwargs: Any)[source]¶

Bases: BackupParameters

Azure backup parameters.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
backup_type (str) – BackupType ; Full/Incremental etc. Required.

Keyword Arguments:

backup_type (str) – BackupType ; Full/Incremental etc. Required.

class azure.mgmt.dataprotection.models.AzureBackupRecoveryPoint(**kwargs: Any)[source]¶

Bases: Model

Azure backup recoveryPoint.

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

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

Variables:: object_type (str) – Required.

class azure.mgmt.dataprotection.models.AzureBackupRecoveryPointBasedRestoreRequest(*, restore_target_info: _models.RestoreTargetInfoBase, source_data_store_type: str | _models.SourceDataStoreType, recovery_point_id: str, source_resource_id: str | None = None, resource_guard_operation_requests: List[str] | None = None, identity_details: _models.IdentityDetails | None = None, **kwargs: Any)[source]¶

Bases: AzureBackupRestoreRequest

Azure backup recoveryPoint based restore request.

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

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

Variables:

object_type (str) – Required.
restore_target_info (RestoreTargetInfoBase) – Gets or sets the restore target information. Required.
source_data_store_type (str or SourceDataStoreType) – Gets or sets the type of the source data store. Required. Known values are: “ArchiveStore”, “SnapshotStore”, “OperationalStore”, and “VaultStore”.
source_resource_id (str) – Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
recovery_point_id (str) – Required.

Keyword Arguments:

restore_target_info (RestoreTargetInfoBase) – Gets or sets the restore target information. Required.
source_data_store_type (str or SourceDataStoreType) – Gets or sets the type of the source data store. Required. Known values are: “ArchiveStore”, “SnapshotStore”, “OperationalStore”, and “VaultStore”.
source_resource_id (str) – Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
recovery_point_id (str) – Required.

class azure.mgmt.dataprotection.models.AzureBackupRecoveryPointResource(*, properties: _models.AzureBackupRecoveryPoint | None = None, **kwargs: Any)[source]¶

Bases: DppResource

Azure backup recoveryPoint 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/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
properties (AzureBackupRecoveryPoint) – AzureBackupRecoveryPointResource properties.

Keyword Arguments:

properties (AzureBackupRecoveryPoint) – AzureBackupRecoveryPointResource properties.

class azure.mgmt.dataprotection.models.AzureBackupRecoveryPointResourceList(*, next_link: str | None = None, value: List[_models.AzureBackupRecoveryPointResource] | None = None, **kwargs: Any)[source]¶

Bases: DppResourceList

Azure backup recoveryPoint resource list.

Variables:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[AzureBackupRecoveryPointResource]) – List of resources.

Keyword Arguments:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[AzureBackupRecoveryPointResource]) – List of resources.

class azure.mgmt.dataprotection.models.AzureBackupRecoveryTimeBasedRestoreRequest(*, restore_target_info: _models.RestoreTargetInfoBase, source_data_store_type: str | _models.SourceDataStoreType, recovery_point_time: str, source_resource_id: str | None = None, resource_guard_operation_requests: List[str] | None = None, identity_details: _models.IdentityDetails | None = None, **kwargs: Any)[source]¶

Bases: AzureBackupRestoreRequest

AzureBackup RecoveryPointTime Based Restore Request.

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

Variables:

object_type (str) – Required.
restore_target_info (RestoreTargetInfoBase) – Gets or sets the restore target information. Required.
source_data_store_type (str or SourceDataStoreType) – Gets or sets the type of the source data store. Required. Known values are: “ArchiveStore”, “SnapshotStore”, “OperationalStore”, and “VaultStore”.
source_resource_id (str) – Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
recovery_point_time (str) – The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z. Required.

Keyword Arguments:

restore_target_info (RestoreTargetInfoBase) – Gets or sets the restore target information. Required.
source_data_store_type (str or SourceDataStoreType) – Gets or sets the type of the source data store. Required. Known values are: “ArchiveStore”, “SnapshotStore”, “OperationalStore”, and “VaultStore”.
source_resource_id (str) – Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
recovery_point_time (str) – The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z. Required.

class azure.mgmt.dataprotection.models.AzureBackupRehydrationRequest(*, recovery_point_id: str, rehydration_retention_duration: str, rehydration_priority: str | _models.RehydrationPriority | None = None, **kwargs: Any)[source]¶

Bases: Model

Azure Backup Rehydrate Request.

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

Variables:

recovery_point_id (str) – Id of the recovery point to be recovered. Required.
rehydration_priority (str or RehydrationPriority) – Priority to be used for rehydration. Values High or Standard. Known values are: “Invalid”, “High”, and “Standard”.
rehydration_retention_duration (str) – Retention duration in ISO 8601 format i.e P10D . Required.

Keyword Arguments:

recovery_point_id (str) – Id of the recovery point to be recovered. Required.
rehydration_priority (str or RehydrationPriority) – Priority to be used for rehydration. Values High or Standard. Known values are: “Invalid”, “High”, and “Standard”.
rehydration_retention_duration (str) – Retention duration in ISO 8601 format i.e P10D . Required.

class azure.mgmt.dataprotection.models.AzureBackupRestoreRequest(*, restore_target_info: _models.RestoreTargetInfoBase, source_data_store_type: str | _models.SourceDataStoreType, source_resource_id: str | None = None, resource_guard_operation_requests: List[str] | None = None, identity_details: _models.IdentityDetails | None = None, **kwargs: Any)[source]¶

Bases: Model

Azure backup restore request.

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

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

Variables:

object_type (str) – Required.
restore_target_info (RestoreTargetInfoBase) – Gets or sets the restore target information. Required.
source_data_store_type (str or SourceDataStoreType) – Gets or sets the type of the source data store. Required. Known values are: “ArchiveStore”, “SnapshotStore”, “OperationalStore”, and “VaultStore”.
source_resource_id (str) – Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.

Keyword Arguments:

restore_target_info (RestoreTargetInfoBase) – Gets or sets the restore target information. Required.
source_data_store_type (str or SourceDataStoreType) – Gets or sets the type of the source data store. Required. Known values are: “ArchiveStore”, “SnapshotStore”, “OperationalStore”, and “VaultStore”.
source_resource_id (str) – Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.

class azure.mgmt.dataprotection.models.AzureBackupRestoreWithRehydrationRequest(*, restore_target_info: _models.RestoreTargetInfoBase, source_data_store_type: str | _models.SourceDataStoreType, recovery_point_id: str, rehydration_priority: str | _models.RehydrationPriority, rehydration_retention_duration: str, source_resource_id: str | None = None, resource_guard_operation_requests: List[str] | None = None, identity_details: _models.IdentityDetails | None = None, **kwargs: Any)[source]¶

Bases: AzureBackupRecoveryPointBasedRestoreRequest

AzureBackup Restore with Rehydration Request.

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

Variables:

object_type (str) – Required.
restore_target_info (RestoreTargetInfoBase) – Gets or sets the restore target information. Required.
source_data_store_type (str or SourceDataStoreType) – Gets or sets the type of the source data store. Required. Known values are: “ArchiveStore”, “SnapshotStore”, “OperationalStore”, and “VaultStore”.
source_resource_id (str) – Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
recovery_point_id (str) – Required.
rehydration_priority (str or RehydrationPriority) – Priority to be used for rehydration. Values High or Standard. Required. Known values are: “Invalid”, “High”, and “Standard”.
rehydration_retention_duration (str) – Retention duration in ISO 8601 format i.e P10D . Required.

Keyword Arguments:

restore_target_info (RestoreTargetInfoBase) – Gets or sets the restore target information. Required.
source_data_store_type (str or SourceDataStoreType) – Gets or sets the type of the source data store. Required. Known values are: “ArchiveStore”, “SnapshotStore”, “OperationalStore”, and “VaultStore”.
source_resource_id (str) – Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
recovery_point_id (str) – Required.
rehydration_priority (str or RehydrationPriority) – Priority to be used for rehydration. Values High or Standard. Required. Known values are: “Invalid”, “High”, and “Standard”.
rehydration_retention_duration (str) – Retention duration in ISO 8601 format i.e P10D . Required.

class azure.mgmt.dataprotection.models.AzureBackupRule(*, name: str, data_store: _models.DataStoreInfoBase, trigger: _models.TriggerContext, backup_parameters: _models.BackupParameters | None = None, **kwargs: Any)[source]¶

Bases: BasePolicyRule

Azure backup rule.

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

Variables:

name (str) – Required.
object_type (str) – Required.
backup_parameters (BackupParameters) – BackupParameters base.
data_store (DataStoreInfoBase) – DataStoreInfo base. Required.
trigger (TriggerContext) – Trigger context. Required.

Keyword Arguments:

name (str) – Required.
backup_parameters (BackupParameters) – BackupParameters base.
data_store (DataStoreInfoBase) – DataStoreInfo base. Required.
trigger (TriggerContext) – Trigger context. Required.

class azure.mgmt.dataprotection.models.AzureMonitorAlertSettings(*, alerts_for_all_job_failures: str | _models.AlertsState | None = None, **kwargs: Any)[source]¶

Bases: Model

Settings for Azure Monitor based alerts.

Variables:: alerts_for_all_job_failures (str or AlertsState) – Known values are: “Enabled” and “Disabled”.
Keyword Arguments:: alerts_for_all_job_failures (str or AlertsState) – Known values are: “Enabled” and “Disabled”.

class azure.mgmt.dataprotection.models.AzureOperationalStoreParameters(*, data_store_type: str | _models.DataStoreTypes, resource_group_id: str | None = None, **kwargs: Any)[source]¶

Bases: DataStoreParameters

Parameters for Operational-Tier DataStore.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
data_store_type (str or DataStoreTypes) – type of datastore; Operational/Vault/Archive. Required. Known values are: “OperationalStore”, “VaultStore”, and “ArchiveStore”.
resource_group_id (str) – Gets or sets the Snapshot Resource Group Uri.

Keyword Arguments:

data_store_type (str or DataStoreTypes) – type of datastore; Operational/Vault/Archive. Required. Known values are: “OperationalStore”, “VaultStore”, and “ArchiveStore”.
resource_group_id (str) – Gets or sets the Snapshot Resource Group Uri.

class azure.mgmt.dataprotection.models.AzureRetentionRule(*, name: str, lifecycles: List[_models.SourceLifeCycle], is_default: bool | None = None, **kwargs: Any)[source]¶

Bases: BasePolicyRule

Azure retention rule.

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

Variables:

name (str) – Required.
object_type (str) – Required.
is_default (bool)
lifecycles (list[SourceLifeCycle]) – Required.

Keyword Arguments:

name (str) – Required.
is_default (bool)
lifecycles (list[SourceLifeCycle]) – Required.

class azure.mgmt.dataprotection.models.BCDRSecurityLevel(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Security Level of Backup Vault.

EXCELLENT = 'Excellent'¶

FAIR = 'Fair'¶

GOOD = 'Good'¶

NOT_SUPPORTED = 'NotSupported'¶

POOR = 'Poor'¶

class azure.mgmt.dataprotection.models.BackupCriteria(**kwargs: Any)[source]¶

Bases: Model

BackupCriteria base class.

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

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.BackupDatasourceParameters(**kwargs: Any)[source]¶

Bases: Model

Parameters for Backup Datasource.

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

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.BackupInstance(*, data_source_info: _models.Datasource, policy_info: _models.PolicyInfo, object_type: str, friendly_name: str | None = None, data_source_set_info: _models.DatasourceSet | None = None, resource_guard_operation_requests: List[str] | None = None, datasource_auth_credentials: _models.AuthCredentials | None = None, validation_type: str | _models.ValidationType | None = None, identity_details: _models.IdentityDetails | None = None, **kwargs: Any)[source]¶

Bases: Model

Backup Instance.

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

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

Variables:

friendly_name (str) – Gets or sets the Backup Instance friendly name.
data_source_info (Datasource) – Gets or sets the data source information. Required.
data_source_set_info (DatasourceSet) – Gets or sets the data source set information.
policy_info (PolicyInfo) – Gets or sets the policy information. Required.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
protection_status (ProtectionStatusDetails) – Specifies the protection status of the resource.
current_protection_state (str or CurrentProtectionState) – Specifies the current protection state of the resource. Known values are: “Invalid”, “NotProtected”, “ConfiguringProtection”, “ProtectionConfigured”, “BackupSchedulesSuspended”, “RetentionSchedulesSuspended”, “ProtectionStopped”, “ProtectionError”, “ConfiguringProtectionFailed”, “SoftDeleting”, “SoftDeleted”, and “UpdatingProtection”.
protection_error_details (UserFacingError) – Specifies the protection error of the resource.
provisioning_state (str) – Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed.
datasource_auth_credentials (AuthCredentials) – Credentials to use to authenticate with data source provider.
validation_type (str or ValidationType) – Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. Known values are: “ShallowValidation” and “DeepValidation”.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
object_type (str) – Required.

Keyword Arguments:

friendly_name (str) – Gets or sets the Backup Instance friendly name.
data_source_info (Datasource) – Gets or sets the data source information. Required.
data_source_set_info (DatasourceSet) – Gets or sets the data source set information.
policy_info (PolicyInfo) – Gets or sets the policy information. Required.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
datasource_auth_credentials (AuthCredentials) – Credentials to use to authenticate with data source provider.
validation_type (str or ValidationType) – Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. Known values are: “ShallowValidation” and “DeepValidation”.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
object_type (str) – Required.

class azure.mgmt.dataprotection.models.BackupInstanceResource(*, tags: Dict[str, str] | None = None, properties: _models.BackupInstance | None = None, **kwargs: Any)[source]¶

Bases: DppProxyResource

BackupInstance Resource.

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

Variables:

id (str) – Proxy Resource Id represents the complete path to the resource.
name (str) – Proxy Resource name associated with the resource.
type (str) – Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
tags (dict[str, str]) – Proxy Resource tags.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
properties (BackupInstance) – BackupInstanceResource properties.

Keyword Arguments:

tags (dict[str, str]) – Proxy Resource tags.
properties (BackupInstance) – BackupInstanceResource properties.

class azure.mgmt.dataprotection.models.BackupInstanceResourceList(*, next_link: str | None = None, value: List[_models.BackupInstanceResource] | None = None, **kwargs: Any)[source]¶

Bases: DppResourceList

BackupInstance Resource list response.

Variables:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[BackupInstanceResource]) – List of resources.

Keyword Arguments:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[BackupInstanceResource]) – List of resources.

class azure.mgmt.dataprotection.models.BackupParameters(**kwargs: Any)[source]¶

Bases: Model

BackupParameters base.

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

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.BackupPolicy(*, datasource_types: List[str], policy_rules: List[_models.BasePolicyRule], **kwargs: Any)[source]¶

Bases: BaseBackupPolicy

Rule based backup policy.

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

Variables:

datasource_types (list[str]) – Type of datasource for the backup management. Required.
object_type (str) – Required.
policy_rules (list[BasePolicyRule]) – Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc. Required.

Keyword Arguments:

datasource_types (list[str]) – Type of datasource for the backup management. Required.
policy_rules (list[BasePolicyRule]) – Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc. Required.

class azure.mgmt.dataprotection.models.BackupSchedule(*, repeating_time_intervals: List[str], time_zone: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Schedule for backup.

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

Variables:

repeating_time_intervals (list[str]) – ISO 8601 repeating time interval format. Required.
time_zone (str) – Time zone for a schedule. Example: Pacific Standard Time.

Keyword Arguments:

repeating_time_intervals (list[str]) – ISO 8601 repeating time interval format. Required.
time_zone (str) – Time zone for a schedule. Example: Pacific Standard Time.

class azure.mgmt.dataprotection.models.BackupVault(*, storage_settings: List[_models.StorageSetting], monitoring_settings: _models.MonitoringSettings | None = None, security_settings: _models.SecuritySettings | None = None, feature_settings: _models.FeatureSettings | None = None, resource_guard_operation_requests: List[str] | None = None, replicated_regions: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Backup Vault.

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

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

Variables:

monitoring_settings (MonitoringSettings) – Monitoring Settings.
provisioning_state (str or ProvisioningState) – Provisioning state of the BackupVault resource. Known values are: “Failed”, “Provisioning”, “Succeeded”, “Unknown”, and “Updating”.
resource_move_state (str or ResourceMoveState) – Resource move state for backup vault. Known values are: “Unknown”, “InProgress”, “PrepareFailed”, “CommitFailed”, “Failed”, “PrepareTimedout”, “CommitTimedout”, “CriticalFailure”, “PartialSuccess”, and “MoveSucceeded”.
resource_move_details (ResourceMoveDetails) – Resource move details for backup vault.
security_settings (SecuritySettings) – Security Settings.
storage_settings (list[StorageSetting]) – Storage Settings. Required.
is_vault_protected_by_resource_guard (bool) – Is vault protected by resource guard.
feature_settings (FeatureSettings) – Feature Settings.
secure_score (str or SecureScoreLevel) – Secure Score of Backup Vault. Known values are: “None”, “Minimum”, “Adequate”, “Maximum”, and “NotSupported”.
bcdr_security_level (str or BCDRSecurityLevel) – Security Level of Backup Vault. Known values are: “Poor”, “Fair”, “Good”, “Excellent”, and “NotSupported”.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
replicated_regions (list[str]) – List of replicated regions for Backup Vault.

Keyword Arguments:

monitoring_settings (MonitoringSettings) – Monitoring Settings.
security_settings (SecuritySettings) – Security Settings.
storage_settings (list[StorageSetting]) – Storage Settings. Required.
feature_settings (FeatureSettings) – Feature Settings.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
replicated_regions (list[str]) – List of replicated regions for Backup Vault.

class azure.mgmt.dataprotection.models.BackupVaultResource(*, properties: _models.BackupVault, e_tag: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, identity: _models.DppIdentityDetails | None = None, **kwargs: Any)[source]¶

Bases: DppTrackedResource

Backup Vault Resource.

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

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

Variables:

e_tag (str) – Optional ETag.
id (str) – Resource Id represents the complete path to the resource.
location (str) – Resource location.
name (str) – Resource name associated with the resource.
tags (dict[str, str]) – Resource tags.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
identity (DppIdentityDetails) – Input Managed Identity Details.
properties (BackupVault) – BackupVaultResource properties. Required.

Keyword Arguments:

e_tag (str) – Optional ETag.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
identity (DppIdentityDetails) – Input Managed Identity Details.
properties (BackupVault) – BackupVaultResource properties. Required.

class azure.mgmt.dataprotection.models.BackupVaultResourceList(*, next_link: str | None = None, value: List[_models.BackupVaultResource] | None = None, **kwargs: Any)[source]¶

Bases: DppResourceList

List of BackupVault resources.

Variables:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[BackupVaultResource]) – List of resources.

Keyword Arguments:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[BackupVaultResource]) – List of resources.

class azure.mgmt.dataprotection.models.BaseBackupPolicy(*, datasource_types: List[str], **kwargs: Any)[source]¶

Bases: Model

BackupPolicy base.

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

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

Variables:

datasource_types (list[str]) – Type of datasource for the backup management. Required.
object_type (str) – Required.

Keyword Arguments:

datasource_types (list[str]) – Type of datasource for the backup management. Required.

class azure.mgmt.dataprotection.models.BaseBackupPolicyResource(*, properties: _models.BaseBackupPolicy | None = None, **kwargs: Any)[source]¶

Bases: DppResource

BaseBackupPolicy 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/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
properties (BaseBackupPolicy) – BaseBackupPolicyResource properties.

Keyword Arguments:

properties (BaseBackupPolicy) – BaseBackupPolicyResource properties.

class azure.mgmt.dataprotection.models.BaseBackupPolicyResourceList(*, next_link: str | None = None, value: List[_models.BaseBackupPolicyResource] | None = None, **kwargs: Any)[source]¶

Bases: DppResourceList

List of BaseBackupPolicy resources.

Variables:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[BaseBackupPolicyResource]) – List of resources.

Keyword Arguments:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[BaseBackupPolicyResource]) – List of resources.

class azure.mgmt.dataprotection.models.BasePolicyRule(*, name: str, **kwargs: Any)[source]¶

Bases: Model

BasePolicy Rule.

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

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

Variables:

name (str) – Required.
object_type (str) – Required.

Keyword Arguments:

name (str) – Required.

class azure.mgmt.dataprotection.models.BaseResourceProperties(**kwargs: Any)[source]¶

Bases: Model

Properties which are specific to datasource/datasourceSets.

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

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

Variables:: object_type (str or ResourcePropertiesObjectType) – Type of the specific object - used for deserializing. Required. “DefaultResourceProperties”

class azure.mgmt.dataprotection.models.BlobBackupDatasourceParameters(*, containers_list: List[str], **kwargs: Any)[source]¶

Bases: BackupDatasourceParameters

Parameters to be used during configuration of backup of blobs.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
containers_list (list[str]) – List of containers to be backed up during configuration of backup of blobs. Required.

Keyword Arguments:

containers_list (list[str]) – List of containers to be backed up during configuration of backup of blobs. Required.

class azure.mgmt.dataprotection.models.CheckNameAvailabilityRequest(*, name: str | None = None, type: str | None = None, **kwargs: Any)[source]¶

Bases: Model

CheckNameAvailability Request.

Variables:

name (str) – Resource name for which availability needs to be checked.
type (str) – Describes the Resource type: Microsoft.DataProtection/BackupVaults.

Keyword Arguments:

name (str) – Resource name for which availability needs to be checked.
type (str) – Describes the Resource type: Microsoft.DataProtection/BackupVaults.

class azure.mgmt.dataprotection.models.CheckNameAvailabilityResult(*, message: str | None = None, name_available: bool | None = None, reason: str | None = None, **kwargs: Any)[source]¶

Bases: Model

CheckNameAvailability Result.

Variables:

message (str) – Gets or sets the message.
name_available (bool) – Gets or sets a value indicating whether [name available].
reason (str) – Gets or sets the reason.

Keyword Arguments:

message (str) – Gets or sets the message.
name_available (bool) – Gets or sets a value indicating whether [name available].
reason (str) – Gets or sets the reason.

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

Bases: Model

Localized display information of an operation.

Variables:

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

Keyword Arguments:

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

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

Bases: Model

Class to represent shoebox log specification in json client discovery.

Variables:

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

Keyword Arguments:

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

class azure.mgmt.dataprotection.models.ClientDiscoveryForProperties(*, service_specification: _models.ClientDiscoveryForServiceSpecification | None = None, **kwargs: Any)[source]¶

Bases: Model

Class to represent shoebox properties in json client discovery.

Variables:: service_specification (ClientDiscoveryForServiceSpecification) – Operation properties.
Keyword Arguments:: service_specification (ClientDiscoveryForServiceSpecification) – Operation properties.

class azure.mgmt.dataprotection.models.ClientDiscoveryForServiceSpecification(*, log_specifications: List[_models.ClientDiscoveryForLogSpecification] | None = None, **kwargs: Any)[source]¶

Bases: Model

Class to represent shoebox service specification in json client discovery.

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

class azure.mgmt.dataprotection.models.ClientDiscoveryResponse(*, next_link: str | None = None, value: List[_models.ClientDiscoveryValueForSingleApi] | None = None, **kwargs: Any)[source]¶

Bases: Model

Operations List response which contains list of available APIs.

Variables:

next_link (str) – Link to the next chunk of Response.
value (list[ClientDiscoveryValueForSingleApi]) – List of available operations.

Keyword Arguments:

next_link (str) – Link to the next chunk of Response.
value (list[ClientDiscoveryValueForSingleApi]) – List of available operations.

class azure.mgmt.dataprotection.models.ClientDiscoveryValueForSingleApi(*, display: _models.ClientDiscoveryDisplay | None = None, name: str | None = None, is_data_action: bool | None = None, origin: str | None = None, properties: _models.ClientDiscoveryForProperties | None = None, **kwargs: Any)[source]¶

Bases: Model

Available operation details.

Variables:

display (ClientDiscoveryDisplay) – Contains the localized display information for this particular operation.
name (str) – Name of the Operation.
is_data_action (bool) – Indicates whether the operation is a data action.
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 for the given operation.

Keyword Arguments:

display (ClientDiscoveryDisplay) – Contains the localized display information for this particular operation.
name (str) – Name of the Operation.
is_data_action (bool) – Indicates whether the operation is a data action.
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 for the given operation.

class azure.mgmt.dataprotection.models.CmkKekIdentity(*, identity_type: str | _models.IdentityType | None = None, identity_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The details of the managed identity used for CMK.

Variables:

identity_type (str or IdentityType) – The identity type. ‘SystemAssigned’ and ‘UserAssigned’ are mutually exclusive. ‘SystemAssigned’ will use implicitly created managed identity. Known values are: “SystemAssigned” and “UserAssigned”.
identity_id (str) – The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: ‘UserAssigned’ only.

Keyword Arguments:

identity_type (str or IdentityType) – The identity type. ‘SystemAssigned’ and ‘UserAssigned’ are mutually exclusive. ‘SystemAssigned’ will use implicitly created managed identity. Known values are: “SystemAssigned” and “UserAssigned”.
identity_id (str) – The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: ‘UserAssigned’ only.

class azure.mgmt.dataprotection.models.CmkKeyVaultProperties(*, key_uri: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The properties of the Key Vault which hosts CMK.

Variables:: key_uri (str) – The key uri of the Customer Managed Key.
Keyword Arguments:: key_uri (str) – The key uri of the Customer Managed Key.

class azure.mgmt.dataprotection.models.CopyOnExpiryOption(**kwargs: Any)[source]¶

Bases: CopyOption

Copy on Expiry Option.

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.CopyOption(**kwargs: Any)[source]¶

Bases: Model

Options to copy.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CopyOnExpiryOption, CustomCopyOption, ImmediateCopyOption

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.dataprotection.models.CrossRegionRestoreDetails(*, source_region: str, source_backup_instance_id: str, **kwargs: Any)[source]¶

Bases: Model

Cross Region Restore details.

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

Variables:

source_region (str) – Required.
source_backup_instance_id (str) – Required.

Keyword Arguments:

source_region (str) – Required.
source_backup_instance_id (str) – Required.

class azure.mgmt.dataprotection.models.CrossRegionRestoreJobRequest(*, source_region: str, source_backup_vault_id: str, job_id: str, **kwargs: Any)[source]¶

Bases: Model

Details of CRR Job to be fetched.

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

Variables:

source_region (str) – Required.
source_backup_vault_id (str) – Required.
job_id (str) – Required.

Keyword Arguments:

source_region (str) – Required.
source_backup_vault_id (str) – Required.
job_id (str) – Required.

class azure.mgmt.dataprotection.models.CrossRegionRestoreJobsRequest(*, source_region: str, source_backup_vault_id: str, **kwargs: Any)[source]¶

Bases: Model

Details of Backup Vault for which CRR Jobs are to be fetched.

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

Variables:

source_region (str) – Required.
source_backup_vault_id (str) – Required.

Keyword Arguments:

source_region (str) – Required.
source_backup_vault_id (str) – Required.

class azure.mgmt.dataprotection.models.CrossRegionRestoreRequestObject(*, restore_request_object: _models.AzureBackupRestoreRequest, cross_region_restore_details: _models.CrossRegionRestoreDetails, **kwargs: Any)[source]¶

Bases: Model

Cross Region Restore Request Object.

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

Variables:

restore_request_object (AzureBackupRestoreRequest) – Gets or sets the restore request object. Required.
cross_region_restore_details (CrossRegionRestoreDetails) – Cross region restore details. Required.

Keyword Arguments:

restore_request_object (AzureBackupRestoreRequest) – Gets or sets the restore request object. Required.
cross_region_restore_details (CrossRegionRestoreDetails) – Cross region restore details. Required.

class azure.mgmt.dataprotection.models.CrossRegionRestoreSettings(*, state: str | _models.CrossRegionRestoreState | None = None, **kwargs: Any)[source]¶

Bases: Model

CrossRegionRestoreSettings.

Variables:: state (str or CrossRegionRestoreState) – CrossRegionRestore state. Known values are: “Disabled” and “Enabled”.
Keyword Arguments:: state (str or CrossRegionRestoreState) – CrossRegionRestore state. Known values are: “Disabled” and “Enabled”.

class azure.mgmt.dataprotection.models.CrossRegionRestoreState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

CrossRegionRestore state.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.dataprotection.models.CrossSubscriptionRestoreSettings(*, state: str | _models.CrossSubscriptionRestoreState | None = None, **kwargs: Any)[source]¶

Bases: Model

CrossSubscriptionRestore Settings.

Variables:: state (str or CrossSubscriptionRestoreState) – CrossSubscriptionRestore state. Known values are: “Disabled”, “PermanentlyDisabled”, and “Enabled”.
Keyword Arguments:: state (str or CrossSubscriptionRestoreState) – CrossSubscriptionRestore state. Known values are: “Disabled”, “PermanentlyDisabled”, and “Enabled”.

class azure.mgmt.dataprotection.models.CrossSubscriptionRestoreState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

CrossSubscriptionRestore state.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

PERMANENTLY_DISABLED = 'PermanentlyDisabled'¶

class azure.mgmt.dataprotection.models.CurrentProtectionState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the current protection state of the resource.

BACKUP_SCHEDULES_SUSPENDED = 'BackupSchedulesSuspended'¶

CONFIGURING_PROTECTION = 'ConfiguringProtection'¶

CONFIGURING_PROTECTION_FAILED = 'ConfiguringProtectionFailed'¶

INVALID = 'Invalid'¶

NOT_PROTECTED = 'NotProtected'¶

PROTECTION_CONFIGURED = 'ProtectionConfigured'¶

PROTECTION_ERROR = 'ProtectionError'¶

PROTECTION_STOPPED = 'ProtectionStopped'¶

RETENTION_SCHEDULES_SUSPENDED = 'RetentionSchedulesSuspended'¶

SOFT_DELETED = 'SoftDeleted'¶

SOFT_DELETING = 'SoftDeleting'¶

UPDATING_PROTECTION = 'UpdatingProtection'¶

class azure.mgmt.dataprotection.models.CustomCopyOption(*, duration: str | None = None, **kwargs: Any)[source]¶

Bases: CopyOption

Duration based custom options to copy.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
duration (str) – Data copied after given timespan.

Keyword Arguments:

duration (str) – Data copied after given timespan.

class azure.mgmt.dataprotection.models.DataStoreInfoBase(*, data_store_type: str | _models.DataStoreTypes, object_type: str, **kwargs: Any)[source]¶

Bases: Model

DataStoreInfo base.

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

Variables:

data_store_type (str or DataStoreTypes) – type of datastore; Operational/Vault/Archive. Required. Known values are: “OperationalStore”, “VaultStore”, and “ArchiveStore”.
object_type (str) – Type of Datasource object, used to initialize the right inherited type. Required.

Keyword Arguments:

data_store_type (str or DataStoreTypes) – type of datastore; Operational/Vault/Archive. Required. Known values are: “OperationalStore”, “VaultStore”, and “ArchiveStore”.
object_type (str) – Type of Datasource object, used to initialize the right inherited type. Required.

class azure.mgmt.dataprotection.models.DataStoreParameters(*, data_store_type: str | _models.DataStoreTypes, **kwargs: Any)[source]¶

Bases: Model

Parameters for DataStore.

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

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
data_store_type (str or DataStoreTypes) – type of datastore; Operational/Vault/Archive. Required. Known values are: “OperationalStore”, “VaultStore”, and “ArchiveStore”.

Keyword Arguments:

data_store_type (str or DataStoreTypes) – type of datastore; Operational/Vault/Archive. Required. Known values are: “OperationalStore”, “VaultStore”, and “ArchiveStore”.

class azure.mgmt.dataprotection.models.DataStoreTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

type of datastore; Operational/Vault/Archive.

ARCHIVE_STORE = 'ArchiveStore'¶

OPERATIONAL_STORE = 'OperationalStore'¶

VAULT_STORE = 'VaultStore'¶

class azure.mgmt.dataprotection.models.Datasource(*, resource_id: str, datasource_type: str | None = None, object_type: str | None = None, resource_location: str | None = None, resource_name: str | None = None, resource_type: str | None = None, resource_uri: str | None = None, resource_properties: _models.BaseResourceProperties | None = None, **kwargs: Any)[source]¶

Bases: Model

Datasource to be backed up.

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

Variables:

datasource_type (str) – DatasourceType of the resource.
object_type (str) – Type of Datasource object, used to initialize the right inherited type.
resource_id (str) – Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. Required.
resource_location (str) – Location of datasource.
resource_name (str) – Unique identifier of the resource in the context of parent.
resource_type (str) – Resource Type of Datasource.
resource_uri (str) – Uri of the resource.
resource_properties (BaseResourceProperties) – Properties specific to data source.

Keyword Arguments:

datasource_type (str) – DatasourceType of the resource.
object_type (str) – Type of Datasource object, used to initialize the right inherited type.
resource_id (str) – Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. Required.
resource_location (str) – Location of datasource.
resource_name (str) – Unique identifier of the resource in the context of parent.
resource_type (str) – Resource Type of Datasource.
resource_uri (str) – Uri of the resource.
resource_properties (BaseResourceProperties) – Properties specific to data source.

class azure.mgmt.dataprotection.models.DatasourceSet(*, resource_id: str, datasource_type: str | None = None, object_type: str | None = None, resource_location: str | None = None, resource_name: str | None = None, resource_type: str | None = None, resource_uri: str | None = None, resource_properties: _models.BaseResourceProperties | None = None, **kwargs: Any)[source]¶

Bases: Model

DatasourceSet details of datasource to be backed up.

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

Variables:

datasource_type (str) – DatasourceType of the resource.
object_type (str) – Type of Datasource object, used to initialize the right inherited type.
resource_id (str) – Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. Required.
resource_location (str) – Location of datasource.
resource_name (str) – Unique identifier of the resource in the context of parent.
resource_type (str) – Resource Type of Datasource.
resource_uri (str) – Uri of the resource.
resource_properties (BaseResourceProperties) – Properties specific to data source set.

Keyword Arguments:

datasource_type (str) – DatasourceType of the resource.
object_type (str) – Type of Datasource object, used to initialize the right inherited type.
resource_id (str) – Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. Required.
resource_location (str) – Location of datasource.
resource_name (str) – Unique identifier of the resource in the context of parent.
resource_type (str) – Resource Type of Datasource.
resource_uri (str) – Uri of the resource.
resource_properties (BaseResourceProperties) – Properties specific to data source set.

class azure.mgmt.dataprotection.models.Day(*, date: int | None = None, is_last: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Day of the week.

Variables:

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

Keyword Arguments:

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

class azure.mgmt.dataprotection.models.DayOfWeek(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

DayOfWeek.

FRIDAY = 'Friday'¶

MONDAY = 'Monday'¶

SATURDAY = 'Saturday'¶

SUNDAY = 'Sunday'¶

THURSDAY = 'Thursday'¶

TUESDAY = 'Tuesday'¶

WEDNESDAY = 'Wednesday'¶

class azure.mgmt.dataprotection.models.DefaultResourceProperties(**kwargs: Any)[source]¶

Bases: BaseResourceProperties

Default source properties.

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

Variables:: object_type (str or ResourcePropertiesObjectType) – Type of the specific object - used for deserializing. Required. “DefaultResourceProperties”

class azure.mgmt.dataprotection.models.DeleteOption(*, duration: str, **kwargs: Any)[source]¶

Bases: Model

Delete Option.

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

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

Variables:

duration (str) – Duration of deletion after given timespan. Required.
object_type (str) – Type of the specific object - used for deserializing. Required.

Keyword Arguments:

duration (str) – Duration of deletion after given timespan. Required.

class azure.mgmt.dataprotection.models.DeletedBackupInstance(*, data_source_info: _models.Datasource, policy_info: _models.PolicyInfo, object_type: str, friendly_name: str | None = None, data_source_set_info: _models.DatasourceSet | None = None, resource_guard_operation_requests: List[str] | None = None, datasource_auth_credentials: _models.AuthCredentials | None = None, validation_type: str | _models.ValidationType | None = None, identity_details: _models.IdentityDetails | None = None, **kwargs: Any)[source]¶

Bases: BackupInstance

Deleted Backup Instance.

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

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

Variables:

friendly_name (str) – Gets or sets the Backup Instance friendly name.
data_source_info (Datasource) – Gets or sets the data source information. Required.
data_source_set_info (DatasourceSet) – Gets or sets the data source set information.
policy_info (PolicyInfo) – Gets or sets the policy information. Required.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
protection_status (ProtectionStatusDetails) – Specifies the protection status of the resource.
current_protection_state (str or CurrentProtectionState) – Specifies the current protection state of the resource. Known values are: “Invalid”, “NotProtected”, “ConfiguringProtection”, “ProtectionConfigured”, “BackupSchedulesSuspended”, “RetentionSchedulesSuspended”, “ProtectionStopped”, “ProtectionError”, “ConfiguringProtectionFailed”, “SoftDeleting”, “SoftDeleted”, and “UpdatingProtection”.
protection_error_details (UserFacingError) – Specifies the protection error of the resource.
provisioning_state (str) – Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed.
datasource_auth_credentials (AuthCredentials) – Credentials to use to authenticate with data source provider.
validation_type (str or ValidationType) – Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. Known values are: “ShallowValidation” and “DeepValidation”.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
object_type (str) – Required.
deletion_info (DeletionInfo) – Deletion info of Backup Instance.

Keyword Arguments:

friendly_name (str) – Gets or sets the Backup Instance friendly name.
data_source_info (Datasource) – Gets or sets the data source information. Required.
data_source_set_info (DatasourceSet) – Gets or sets the data source set information.
policy_info (PolicyInfo) – Gets or sets the policy information. Required.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
datasource_auth_credentials (AuthCredentials) – Credentials to use to authenticate with data source provider.
validation_type (str or ValidationType) – Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. Known values are: “ShallowValidation” and “DeepValidation”.
identity_details (IdentityDetails) – Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
object_type (str) – Required.

class azure.mgmt.dataprotection.models.DeletedBackupInstanceResource(*, properties: _models.DeletedBackupInstance | None = None, **kwargs: Any)[source]¶

Bases: DppResource

Deleted Backup Instance.

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/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
properties (DeletedBackupInstance) – DeletedBackupInstanceResource properties.

Keyword Arguments:

properties (DeletedBackupInstance) – DeletedBackupInstanceResource properties.

class azure.mgmt.dataprotection.models.DeletedBackupInstanceResourceList(*, next_link: str | None = None, value: List[_models.DeletedBackupInstanceResource] | None = None, **kwargs: Any)[source]¶

Bases: DppResourceList

List of DeletedBackupInstance resources.

Variables:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[DeletedBackupInstanceResource]) – List of resources.

Keyword Arguments:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[DeletedBackupInstanceResource]) – List of resources.

class azure.mgmt.dataprotection.models.DeletionInfo(**kwargs: Any)[source]¶

Bases: Model

Deletion Info.

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

Variables:

deletion_time (str) – Specifies time of deletion.
billing_end_date (str) – Specifies billing end date.
scheduled_purge_time (str) – Specifies purge time.
delete_activity_id (str) – Delete activity ID for troubleshooting purpose.

class azure.mgmt.dataprotection.models.DppBaseResource(**kwargs: Any)[source]¶

Bases: Model

Base resource under Microsoft.DataProtection provider namespace.

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/…

class azure.mgmt.dataprotection.models.DppBaseResourceList(*, value: List[_models.DppBaseResource] | None = None, next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Base for all lists of V2 resources.

Variables:

value (list[DppBaseResource]) – List of Dpp resources.
next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.

Keyword Arguments:

value (list[DppBaseResource]) – List of Dpp resources.
next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.

class azure.mgmt.dataprotection.models.DppBaseTrackedResource(*, e_tag: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

DppBaseTrackedResource.

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

Variables:

e_tag (str) – Optional ETag.
id (str) – Resource Id represents the complete path to the resource.
location (str) – Resource location.
name (str) – Resource name associated with the resource.
tags (dict[str, str]) – Resource tags.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments:

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

class azure.mgmt.dataprotection.models.DppIdentityDetails(*, type: str | None = None, user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None = None, **kwargs: Any)[source]¶

Bases: Model

Identity details.

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

Variables:

principal_id (str) – The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.
tenant_id (str) – A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.
type (str) – The identityType which can be either SystemAssigned, UserAssigned, ‘SystemAssigned,UserAssigned’ or None.
user_assigned_identities (dict[str, UserAssignedIdentity]) – Gets or sets the user assigned identities.

Keyword Arguments:

type (str) – The identityType which can be either SystemAssigned, UserAssigned, ‘SystemAssigned,UserAssigned’ or None.
user_assigned_identities (dict[str, UserAssignedIdentity]) – Gets or sets the user assigned identities.

class azure.mgmt.dataprotection.models.DppProxyResource(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

DppProxyResource.

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

Variables:

id (str) – Proxy Resource Id represents the complete path to the resource.
name (str) – Proxy Resource name associated with the resource.
type (str) – Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
tags (dict[str, str]) – Proxy Resource tags.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments:

tags (dict[str, str]) – Proxy Resource tags.

class azure.mgmt.dataprotection.models.DppResource(**kwargs: Any)[source]¶

Bases: Model

Resource 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/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

class azure.mgmt.dataprotection.models.DppResourceList(*, next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

ListResource.

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

class azure.mgmt.dataprotection.models.DppTrackedResource(*, e_tag: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, identity: _models.DppIdentityDetails | None = None, **kwargs: Any)[source]¶

Bases: DppBaseTrackedResource

DppTrackedResource.

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

Variables:

e_tag (str) – Optional ETag.
id (str) – Resource Id represents the complete path to the resource.
location (str) – Resource location.
name (str) – Resource name associated with the resource.
tags (dict[str, str]) – Resource tags.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
identity (DppIdentityDetails) – Input Managed Identity Details.

Keyword Arguments:

e_tag (str) – Optional ETag.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
identity (DppIdentityDetails) – Input Managed Identity Details.

class azure.mgmt.dataprotection.models.DppTrackedResourceList(*, next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

DppTrackedResourceList.

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

class azure.mgmt.dataprotection.models.DppWorkerRequest(*, subscription_id: str | None = None, uri: str | None = None, headers: Dict[str, List[str]] | None = None, supported_group_versions: List[str] | None = None, culture_info: str | None = None, parameters: Dict[str, str] | None = None, http_method: str | None = None, **kwargs: Any)[source]¶

Bases: Model

DppWorkerRequest.

Variables:

subscription_id (str)
uri (str)
headers (dict[str, list[str]]) – Dictionary of <components·ikn5y4·schemas·dppworkerrequest·properties·headers·additionalproperties>.
supported_group_versions (list[str])
culture_info (str)
parameters (dict[str, str]) – Dictionary of <string>.
http_method (str)

Keyword Arguments:

subscription_id (str)
uri (str)
headers (dict[str, list[str]]) – Dictionary of <components·ikn5y4·schemas·dppworkerrequest·properties·headers·additionalproperties>.
supported_group_versions (list[str])
culture_info (str)
parameters (dict[str, str]) – Dictionary of <string>.
http_method (str)

class azure.mgmt.dataprotection.models.EncryptionSettings(*, state: str | _models.EncryptionState | None = None, key_vault_properties: _models.CmkKeyVaultProperties | None = None, kek_identity: _models.CmkKekIdentity | None = None, infrastructure_encryption: str | _models.InfrastructureEncryptionState | None = None, **kwargs: Any)[source]¶

Bases: Model

Customer Managed Key details of the resource.

Variables:

state (str or EncryptionState) – Encryption state of the Backup Vault. Known values are: “Enabled”, “Disabled”, and “Inconsistent”.
key_vault_properties (CmkKeyVaultProperties) – The properties of the Key Vault which hosts CMK.
kek_identity (CmkKekIdentity) – The details of the managed identity used for CMK.
infrastructure_encryption (str or InfrastructureEncryptionState) – Enabling/Disabling the Double Encryption state. Known values are: “Enabled” and “Disabled”.

Keyword Arguments:

state (str or EncryptionState) – Encryption state of the Backup Vault. Known values are: “Enabled”, “Disabled”, and “Inconsistent”.
key_vault_properties (CmkKeyVaultProperties) – The properties of the Key Vault which hosts CMK.
kek_identity (CmkKekIdentity) – The details of the managed identity used for CMK.
infrastructure_encryption (str or InfrastructureEncryptionState) – Enabling/Disabling the Double Encryption state. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.dataprotection.models.EncryptionState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Encryption state of the Backup Vault.

DISABLED = 'Disabled'¶: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is ‘Enabled’.

ENABLED = 'Enabled'¶: CMK encryption is enabled on the Backup Vault

INCONSISTENT = 'Inconsistent'¶: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state.

class azure.mgmt.dataprotection.models.Error(**kwargs: Any)[source]¶

Bases: Model

The resource management error response.

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

Variables:

additional_info (list[ErrorAdditionalInfo]) – The error additional info.
code (str) – The error code.
details (list[Error]) – The error details.
message (str) – The error message.
target (str) – The error target.

class azure.mgmt.dataprotection.models.ErrorAdditionalInfo(**kwargs: Any)[source]¶

Bases: Model

The resource management error additional info.

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

Variables:

info (JSON) – The additional info.
type (str) – The additional info type.

class azure.mgmt.dataprotection.models.ErrorDetail(**kwargs: Any)[source]¶

Bases: Model

The error detail.

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

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.dataprotection.models.ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]¶

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:: error (ErrorDetail) – The error object.
Keyword Arguments:: error (ErrorDetail) – The error object.

class azure.mgmt.dataprotection.models.ExistingResourcePolicy(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore.

PATCH = 'Patch'¶

SKIP = 'Skip'¶

class azure.mgmt.dataprotection.models.ExportJobsResult(**kwargs: Any)[source]¶

Bases: Model

The result for export jobs containing blob details.

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

Variables:

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.
excel_file_blob_url (str) – URL of the blob into which the ExcelFile is uploaded.
excel_file_blob_sas_key (str) – SAS key to access the ExcelFile blob.

class azure.mgmt.dataprotection.models.FeatureSettings(*, cross_subscription_restore_settings: _models.CrossSubscriptionRestoreSettings | None = None, cross_region_restore_settings: _models.CrossRegionRestoreSettings | None = None, **kwargs: Any)[source]¶

Bases: Model

Class containing feature settings of vault.

Variables:

cross_subscription_restore_settings (CrossSubscriptionRestoreSettings) – CrossSubscriptionRestore Settings.
cross_region_restore_settings (CrossRegionRestoreSettings)

Keyword Arguments:

cross_subscription_restore_settings (CrossSubscriptionRestoreSettings) – CrossSubscriptionRestore Settings.
cross_region_restore_settings (CrossRegionRestoreSettings)

class azure.mgmt.dataprotection.models.FeatureSupportStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

feature support status.

ALPHA_PREVIEW = 'AlphaPreview'¶

GENERALLY_AVAILABLE = 'GenerallyAvailable'¶

INVALID = 'Invalid'¶

NOT_SUPPORTED = 'NotSupported'¶

PRIVATE_PREVIEW = 'PrivatePreview'¶

PUBLIC_PREVIEW = 'PublicPreview'¶

class azure.mgmt.dataprotection.models.FeatureType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

backup support feature type.

DATA_SOURCE_TYPE = 'DataSourceType'¶

INVALID = 'Invalid'¶

class azure.mgmt.dataprotection.models.FeatureValidationRequest(*, feature_type: str | _models.FeatureType | None = None, feature_name: str | None = None, **kwargs: Any)[source]¶

Bases: FeatureValidationRequestBase

Base class for feature object.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
feature_type (str or FeatureType) – backup support feature type. Known values are: “Invalid” and “DataSourceType”.
feature_name (str) – backup support feature name.

Keyword Arguments:

feature_type (str or FeatureType) – backup support feature type. Known values are: “Invalid” and “DataSourceType”.
feature_name (str) – backup support feature name.

class azure.mgmt.dataprotection.models.FeatureValidationRequestBase(**kwargs: Any)[source]¶

Bases: Model

Base class for Backup Feature support.

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

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.FeatureValidationResponse(*, feature_type: str | _models.FeatureType | None = None, features: List[_models.SupportedFeature] | None = None, **kwargs: Any)[source]¶

Bases: FeatureValidationResponseBase

Feature Validation Response.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
feature_type (str or FeatureType) – backup support feature type. Known values are: “Invalid” and “DataSourceType”.
features (list[SupportedFeature]) – Response features.

Keyword Arguments:

feature_type (str or FeatureType) – backup support feature type. Known values are: “Invalid” and “DataSourceType”.
features (list[SupportedFeature]) – Response features.

class azure.mgmt.dataprotection.models.FeatureValidationResponseBase(**kwargs: Any)[source]¶

Bases: Model

Base class for Backup Feature support.

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

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.FetchSecondaryRPsRequestParameters(*, source_region: str | None = None, source_backup_instance_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Information about BI whose secondary RecoveryPoints are requested Source region and BI ARM path.

Variables:

source_region (str) – Source region in which BackupInstance is located.
source_backup_instance_id (str) – ARM Path of BackupInstance.

Keyword Arguments:

source_region (str) – Source region in which BackupInstance is located.
source_backup_instance_id (str) – ARM Path of BackupInstance.

class azure.mgmt.dataprotection.models.IdentityDetails(*, use_system_assigned_identity: bool | None = None, user_assigned_identity_arm_url: str | None = None, **kwargs: Any)[source]¶

Bases: Model

IdentityDetails.

Variables:

use_system_assigned_identity (bool) – Specifies if the BI is protected by System Identity.
user_assigned_identity_arm_url (str) – ARM URL for User Assigned Identity.

Keyword Arguments:

use_system_assigned_identity (bool) – Specifies if the BI is protected by System Identity.
user_assigned_identity_arm_url (str) – ARM URL for User Assigned Identity.

class azure.mgmt.dataprotection.models.IdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The identity type. ‘SystemAssigned’ and ‘UserAssigned’ are mutually exclusive. ‘SystemAssigned’ will use implicitly created managed identity.

SYSTEM_ASSIGNED = 'SystemAssigned'¶

USER_ASSIGNED = 'UserAssigned'¶

class azure.mgmt.dataprotection.models.ImmediateCopyOption(**kwargs: Any)[source]¶

Bases: CopyOption

Immediate copy Option.

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.ImmutabilitySettings(*, state: str | _models.ImmutabilityState | None = None, **kwargs: Any)[source]¶

Bases: Model

Immutability Settings at vault level.

Variables:: state (str or ImmutabilityState) – Immutability state. Known values are: “Disabled”, “Unlocked”, and “Locked”.
Keyword Arguments:: state (str or ImmutabilityState) – Immutability state. Known values are: “Disabled”, “Unlocked”, and “Locked”.

class azure.mgmt.dataprotection.models.ImmutabilityState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Immutability state.

DISABLED = 'Disabled'¶

LOCKED = 'Locked'¶

UNLOCKED = 'Unlocked'¶

class azure.mgmt.dataprotection.models.InfrastructureEncryptionState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Enabling/Disabling the Double Encryption state.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.dataprotection.models.InnerError(*, additional_info: Dict[str, str] | None = None, code: str | None = None, embedded_inner_error: _models.InnerError | None = None, **kwargs: Any)[source]¶

Bases: Model

Inner Error.

Variables:

additional_info (dict[str, str]) – Any Key value pairs that can be provided to the client for additional verbose information.
code (str) – Unique code for this error.
embedded_inner_error (InnerError) – Child Inner Error, to allow Nesting.

Keyword Arguments:

additional_info (dict[str, str]) – Any Key value pairs that can be provided to the client for additional verbose information.
code (str) – Unique code for this error.
embedded_inner_error (InnerError) – Child Inner Error, to allow Nesting.

class azure.mgmt.dataprotection.models.ItemLevelRestoreCriteria(**kwargs: Any)[source]¶

Bases: Model

Class to contain criteria for item level restore.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ItemPathBasedRestoreCriteria, KubernetesClusterRestoreCriteria, KubernetesClusterVaultTierRestoreCriteria, KubernetesPVRestoreCriteria, KubernetesStorageClassRestoreCriteria, RangeBasedItemLevelRestoreCriteria

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.ItemLevelRestoreTargetInfo(*, recovery_option: str | _models.RecoveryOption, restore_criteria: List[_models.ItemLevelRestoreCriteria], datasource_info: _models.Datasource, restore_location: str | None = None, datasource_set_info: _models.DatasourceSet | None = None, datasource_auth_credentials: _models.AuthCredentials | None = None, **kwargs: Any)[source]¶

Bases: RestoreTargetInfoBase

Restore target info for Item level restore operation.

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

Variables:

object_type (str) – Type of Datasource object, used to initialize the right inherited type. Required.
recovery_option (str or RecoveryOption) – Recovery Option. Required. “FailIfExists”
restore_location (str) – Target Restore region.
restore_criteria (list[ItemLevelRestoreCriteria]) – Restore Criteria. Required.
datasource_info (Datasource) – Information of target DS. Required.
datasource_set_info (DatasourceSet) – Information of target DS Set.
datasource_auth_credentials (AuthCredentials) – Credentials to use to authenticate with data source provider.

Keyword Arguments:

recovery_option (str or RecoveryOption) – Recovery Option. Required. “FailIfExists”
restore_location (str) – Target Restore region.
restore_criteria (list[ItemLevelRestoreCriteria]) – Restore Criteria. Required.
datasource_info (Datasource) – Information of target DS. Required.
datasource_set_info (DatasourceSet) – Information of target DS Set.
datasource_auth_credentials (AuthCredentials) – Credentials to use to authenticate with data source provider.

class azure.mgmt.dataprotection.models.ItemPathBasedRestoreCriteria(*, item_path: str, is_path_relative_to_backup_item: bool, sub_item_path_prefix: List[str] | None = None, **kwargs: Any)[source]¶

Bases: ItemLevelRestoreCriteria

Prefix criteria to be used to during restore.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
item_path (str) – The path of the item to be restored. It could be the full path of the item or the path relative to the backup item. Required.
is_path_relative_to_backup_item (bool) – Flag to specify if the path is relative to backup item or full path. Required.
sub_item_path_prefix (list[str]) – The list of prefix strings to be used as filter criteria during restore. These are relative to the item path specified.

Keyword Arguments:

item_path (str) – The path of the item to be restored. It could be the full path of the item or the path relative to the backup item. Required.
is_path_relative_to_backup_item (bool) – Flag to specify if the path is relative to backup item or full path. Required.
sub_item_path_prefix (list[str]) – The list of prefix strings to be used as filter criteria during restore. These are relative to the item path specified.

class azure.mgmt.dataprotection.models.JobExtendedInfo(*, additional_details: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Extended Information about the job.

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

Variables:

additional_details (dict[str, str]) – Job’s Additional Details.
backup_instance_state (str) – State of the Backup Instance.
data_transferred_in_bytes (float) – Number of bytes transferred.
recovery_destination (str) – Destination where restore is done.
source_recover_point (RestoreJobRecoveryPointDetails) – Details of the Source Recovery Point.
sub_tasks (list[JobSubTask]) – List of Sub Tasks of the job.
target_recover_point (RestoreJobRecoveryPointDetails) – Details of the Target Recovery Point.
warning_details (list[UserFacingWarningDetail]) – A List, detailing the warnings related to the job.

Keyword Arguments:

additional_details (dict[str, str]) – Job’s Additional Details.

class azure.mgmt.dataprotection.models.JobSubTask(*, task_id: int, task_name: str, task_status: str, additional_details: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Details of Job’s Sub Task.

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

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

Variables:

additional_details (dict[str, str]) – Additional details of Sub Tasks.
task_id (int) – Task Id of the Sub Task. Required.
task_name (str) – Name of the Sub Task. Required.
task_progress (str) – Progress of the Sub Task.
task_status (str) – Status of the Sub Task. Required.

Keyword Arguments:

additional_details (dict[str, str]) – Additional details of Sub Tasks.
task_id (int) – Task Id of the Sub Task. Required.
task_name (str) – Name of the Sub Task. Required.
task_status (str) – Status of the Sub Task. Required.

class azure.mgmt.dataprotection.models.KubernetesClusterBackupDatasourceParameters(*, snapshot_volumes: bool, include_cluster_scope_resources: bool, included_namespaces: List[str] | None = None, excluded_namespaces: List[str] | None = None, included_resource_types: List[str] | None = None, excluded_resource_types: List[str] | None = None, label_selectors: List[str] | None = None, backup_hook_references: List[_models.NamespacedNameResource] | None = None, **kwargs: Any)[source]¶

Bases: BackupDatasourceParameters

Parameters for Kubernetes Cluster Backup Datasource.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
snapshot_volumes (bool) – Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup. Required.
include_cluster_scope_resources (bool) – Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup. Required.
included_namespaces (list[str]) – Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.
excluded_namespaces (list[str]) – Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.
included_resource_types (list[str]) – Gets or sets the include resource types property. This property sets the resource types to be included during backup.
excluded_resource_types (list[str]) – Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.
label_selectors (list[str]) – Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.
backup_hook_references (list[NamespacedNameResource]) – Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.

Keyword Arguments:

snapshot_volumes (bool) – Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup. Required.
include_cluster_scope_resources (bool) – Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup. Required.
included_namespaces (list[str]) – Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.
excluded_namespaces (list[str]) – Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.
included_resource_types (list[str]) – Gets or sets the include resource types property. This property sets the resource types to be included during backup.
excluded_resource_types (list[str]) – Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.
label_selectors (list[str]) – Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.
backup_hook_references (list[NamespacedNameResource]) – Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.

class azure.mgmt.dataprotection.models.KubernetesClusterRestoreCriteria(*, include_cluster_scope_resources: bool, included_namespaces: List[str] | None = None, excluded_namespaces: List[str] | None = None, included_resource_types: List[str] | None = None, excluded_resource_types: List[str] | None = None, label_selectors: List[str] | None = None, persistent_volume_restore_mode: str | _models.PersistentVolumeRestoreMode | None = None, conflict_policy: str | _models.ExistingResourcePolicy | None = None, namespace_mappings: Dict[str, str] | None = None, restore_hook_references: List[_models.NamespacedNameResource] | None = None, resource_modifier_reference: _models.NamespacedNameResource | None = None, **kwargs: Any)[source]¶

Bases: ItemLevelRestoreCriteria

kubernetes Cluster Backup target info for restore operation.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
include_cluster_scope_resources (bool) – Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore. Required.
included_namespaces (list[str]) – Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.
excluded_namespaces (list[str]) – Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.
included_resource_types (list[str]) – Gets or sets the include resource types property. This property sets the resource types to be included during restore.
excluded_resource_types (list[str]) – Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.
label_selectors (list[str]) – Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore.
persistent_volume_restore_mode (str or PersistentVolumeRestoreMode) – Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored. Known values are: “RestoreWithVolumeData” and “RestoreWithoutVolumeData”.
conflict_policy (str or ExistingResourcePolicy) – Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore. Known values are: “Skip” and “Patch”.
namespace_mappings (dict[str, str]) – Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore.
restore_hook_references (list[NamespacedNameResource]) – Gets or sets the restore hook references. This property sets the hook reference to be executed during restore.
resource_modifier_reference (NamespacedNameResource) – Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore.

Keyword Arguments:

include_cluster_scope_resources (bool) – Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore. Required.
included_namespaces (list[str]) – Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.
excluded_namespaces (list[str]) – Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.
included_resource_types (list[str]) – Gets or sets the include resource types property. This property sets the resource types to be included during restore.
excluded_resource_types (list[str]) – Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.
label_selectors (list[str]) – Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore.
persistent_volume_restore_mode (str or PersistentVolumeRestoreMode) – Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored. Known values are: “RestoreWithVolumeData” and “RestoreWithoutVolumeData”.
conflict_policy (str or ExistingResourcePolicy) – Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore. Known values are: “Skip” and “Patch”.
namespace_mappings (dict[str, str]) – Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore.
restore_hook_references (list[NamespacedNameResource]) – Gets or sets the restore hook references. This property sets the hook reference to be executed during restore.
resource_modifier_reference (NamespacedNameResource) – Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore.

class azure.mgmt.dataprotection.models.KubernetesClusterVaultTierRestoreCriteria(*, include_cluster_scope_resources: bool, included_namespaces: List[str] | None = None, excluded_namespaces: List[str] | None = None, included_resource_types: List[str] | None = None, excluded_resource_types: List[str] | None = None, label_selectors: List[str] | None = None, persistent_volume_restore_mode: str | _models.PersistentVolumeRestoreMode | None = None, conflict_policy: str | _models.ExistingResourcePolicy | None = None, namespace_mappings: Dict[str, str] | None = None, restore_hook_references: List[_models.NamespacedNameResource] | None = None, staging_resource_group_id: str | None = None, staging_storage_account_id: str | None = None, resource_modifier_reference: _models.NamespacedNameResource | None = None, **kwargs: Any)[source]¶

Bases: ItemLevelRestoreCriteria

kubernetes Cluster Backup target info for restore operation from vault.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
include_cluster_scope_resources (bool) – Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore from vault. Required.
included_namespaces (list[str]) – Gets or sets the include namespaces property. This property sets the namespaces to be included during restore from vault.
excluded_namespaces (list[str]) – Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore from vault.
included_resource_types (list[str]) – Gets or sets the include resource types property. This property sets the resource types to be included during restore from vault.
excluded_resource_types (list[str]) – Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore from vault.
label_selectors (list[str]) – Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore from vault.
persistent_volume_restore_mode (str or PersistentVolumeRestoreMode) – Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored from vault. Known values are: “RestoreWithVolumeData” and “RestoreWithoutVolumeData”.
conflict_policy (str or ExistingResourcePolicy) – Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore from vault. Known values are: “Skip” and “Patch”.
namespace_mappings (dict[str, str]) – Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore from vault.
restore_hook_references (list[NamespacedNameResource]) – Gets or sets the restore hook references. This property sets the hook reference to be executed during restore from vault.
staging_resource_group_id (str) – Gets or sets the staging RG Id for creating staging disks and snapshots during restore from vault.
staging_storage_account_id (str) – Gets or sets the staging Storage Account Id for creating backup extension object store data during restore from vault.
resource_modifier_reference (NamespacedNameResource) – Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore.

Keyword Arguments:

include_cluster_scope_resources (bool) – Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore from vault. Required.
included_namespaces (list[str]) – Gets or sets the include namespaces property. This property sets the namespaces to be included during restore from vault.
excluded_namespaces (list[str]) – Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore from vault.
included_resource_types (list[str]) – Gets or sets the include resource types property. This property sets the resource types to be included during restore from vault.
excluded_resource_types (list[str]) – Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore from vault.
label_selectors (list[str]) – Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore from vault.
persistent_volume_restore_mode (str or PersistentVolumeRestoreMode) – Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored from vault. Known values are: “RestoreWithVolumeData” and “RestoreWithoutVolumeData”.
conflict_policy (str or ExistingResourcePolicy) – Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore from vault. Known values are: “Skip” and “Patch”.
namespace_mappings (dict[str, str]) – Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore from vault.
restore_hook_references (list[NamespacedNameResource]) – Gets or sets the restore hook references. This property sets the hook reference to be executed during restore from vault.
staging_resource_group_id (str) – Gets or sets the staging RG Id for creating staging disks and snapshots during restore from vault.
staging_storage_account_id (str) – Gets or sets the staging Storage Account Id for creating backup extension object store data during restore from vault.
resource_modifier_reference (NamespacedNameResource) – Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore.

class azure.mgmt.dataprotection.models.KubernetesPVRestoreCriteria(*, name: str | None = None, storage_class_name: str | None = None, **kwargs: Any)[source]¶

Bases: ItemLevelRestoreCriteria

Item Level kubernetes persistent volume target info for restore operation.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
name (str) – Selected persistent volume claim name.
storage_class_name (str) – Selected storage class name for restore operation.

Keyword Arguments:

name (str) – Selected persistent volume claim name.
storage_class_name (str) – Selected storage class name for restore operation.

class azure.mgmt.dataprotection.models.KubernetesStorageClassRestoreCriteria(*, selected_storage_class_name: str | None = None, provisioner: str | None = None, **kwargs: Any)[source]¶

Bases: ItemLevelRestoreCriteria

Item Level kubernetes storage class target info for restore operation.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
selected_storage_class_name (str) – Selected storage class name.
provisioner (str) – Provisioner of the storage class.

Keyword Arguments:

selected_storage_class_name (str) – Selected storage class name.
provisioner (str) – Provisioner of the storage class.

class azure.mgmt.dataprotection.models.MonitoringSettings(*, azure_monitor_alert_settings: _models.AzureMonitorAlertSettings | None = None, **kwargs: Any)[source]¶

Bases: Model

Monitoring Settings.

Variables:: azure_monitor_alert_settings (AzureMonitorAlertSettings) – Settings for Azure Monitor based alerts.
Keyword Arguments:: azure_monitor_alert_settings (AzureMonitorAlertSettings) – Settings for Azure Monitor based alerts.

class azure.mgmt.dataprotection.models.Month(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Month.

APRIL = 'April'¶

AUGUST = 'August'¶

DECEMBER = 'December'¶

FEBRUARY = 'February'¶

JANUARY = 'January'¶

JULY = 'July'¶

JUNE = 'June'¶

MARCH = 'March'¶

MAY = 'May'¶

NOVEMBER = 'November'¶

OCTOBER = 'October'¶

SEPTEMBER = 'September'¶

class azure.mgmt.dataprotection.models.NamespacedNameResource(*, name: str | None = None, namespace: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Class to refer resources which contains namespace and name.

Variables:

name (str) – Name of the resource.
namespace (str) – Namespace in which the resource exists.

Keyword Arguments:

name (str) – Name of the resource.
namespace (str) – Namespace in which the resource exists.

class azure.mgmt.dataprotection.models.OperationExtendedInfo(**kwargs: Any)[source]¶

Bases: Model

Operation Extended Info.

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

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

Variables:: object_type (str) – This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. Required.

class azure.mgmt.dataprotection.models.OperationJobExtendedInfo(*, job_id: str | None = None, **kwargs: Any)[source]¶

Bases: OperationExtendedInfo

Operation Job Extended Info.

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

Variables:

object_type (str) – This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. Required.
job_id (str) – Name or Arm Id of the job created for this operation.

Keyword Arguments:

job_id (str) – Name or Arm Id of the job created for this operation.

Bases: Model

Operation Resource.

Variables:

end_time (datetime) – End time of the operation.
error (Error) – Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines. The full set of optional properties (e.g. inner errors / details) can be found in the “Error Response” section.
id (str) – It should match what is used to GET the operation result.
name (str) – It must match the last segment of the “id” field, and will typically be a GUID / system generated value.
properties (OperationExtendedInfo) – End time of the operation.
start_time (datetime) – Start time of the operation.
status (str)

Keyword Arguments:

end_time (datetime) – End time of the operation.
error (Error) – Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines. The full set of optional properties (e.g. inner errors / details) can be found in the “Error Response” section.
id (str) – It should match what is used to GET the operation result.
name (str) – It must match the last segment of the “id” field, and will typically be a GUID / system generated value.
properties (OperationExtendedInfo) – End time of the operation.
start_time (datetime) – Start time of the operation.
status (str)

class azure.mgmt.dataprotection.models.PatchBackupVaultInput(*, monitoring_settings: _models.MonitoringSettings | None = None, security_settings: _models.SecuritySettings | None = None, feature_settings: _models.FeatureSettings | None = None, resource_guard_operation_requests: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Backup Vault Contract for Patch Backup Vault API.

Variables:

monitoring_settings (MonitoringSettings) – Monitoring Settings.
security_settings (SecuritySettings) – Security Settings.
feature_settings (FeatureSettings) – Feature Settings.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.

Keyword Arguments:

monitoring_settings (MonitoringSettings) – Monitoring Settings.
security_settings (SecuritySettings) – Security Settings.
feature_settings (FeatureSettings) – Feature Settings.
resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.

class azure.mgmt.dataprotection.models.PatchResourceGuardInput(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Patch Request content for Microsoft.DataProtection Resource Guard resources.

Variables:: tags (dict[str, str]) – Resource Guard tags.
Keyword Arguments:: tags (dict[str, str]) – Resource Guard tags.

class azure.mgmt.dataprotection.models.PatchResourceRequestInput(*, identity: _models.DppIdentityDetails | None = None, properties: _models.PatchBackupVaultInput | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Patch Request content for Microsoft.DataProtection resources.

Variables:

identity (DppIdentityDetails) – Input Managed Identity Details.
properties (PatchBackupVaultInput) – Resource properties.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

identity (DppIdentityDetails) – Input Managed Identity Details.
properties (PatchBackupVaultInput) – Resource properties.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.dataprotection.models.PersistentVolumeRestoreMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored.

RESTORE_WITHOUT_VOLUME_DATA = 'RestoreWithoutVolumeData'¶

RESTORE_WITH_VOLUME_DATA = 'RestoreWithVolumeData'¶

class azure.mgmt.dataprotection.models.PolicyInfo(*, policy_id: str, policy_parameters: _models.PolicyParameters | None = None, **kwargs: Any)[source]¶

Bases: Model

Policy Info in backupInstance.

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

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

Variables:

policy_id (str) – Required.
policy_version (str)
policy_parameters (PolicyParameters) – Policy parameters for the backup instance.

Keyword Arguments:

policy_id (str) – Required.
policy_parameters (PolicyParameters) – Policy parameters for the backup instance.

class azure.mgmt.dataprotection.models.PolicyParameters(*, data_store_parameters_list: List[_models.DataStoreParameters] | None = None, backup_datasource_parameters_list: List[_models.BackupDatasourceParameters] | None = None, **kwargs: Any)[source]¶

Bases: Model

Parameters in Policy.

Variables:

data_store_parameters_list (list[DataStoreParameters]) – Gets or sets the DataStore Parameters.
backup_datasource_parameters_list (list[BackupDatasourceParameters]) – Gets or sets the Backup Data Source Parameters.

Keyword Arguments:

data_store_parameters_list (list[DataStoreParameters]) – Gets or sets the DataStore Parameters.
backup_datasource_parameters_list (list[BackupDatasourceParameters]) – Gets or sets the Backup Data Source Parameters.

class azure.mgmt.dataprotection.models.ProtectionStatusDetails(*, error_details: _models.UserFacingError | None = None, status: str | _models.Status | None = None, **kwargs: Any)[source]¶

Bases: Model

Protection status details.

Variables:

error_details (UserFacingError) – Specifies the protection status error of the resource.
status (str or Status) – Specifies the protection status of the resource. Known values are: “ConfiguringProtection”, “ConfiguringProtectionFailed”, “ProtectionConfigured”, “ProtectionStopped”, “SoftDeleted”, and “SoftDeleting”.

Keyword Arguments:

error_details (UserFacingError) – Specifies the protection status error of the resource.
status (str or Status) – Specifies the protection status of the resource. Known values are: “ConfiguringProtection”, “ConfiguringProtectionFailed”, “ProtectionConfigured”, “ProtectionStopped”, “SoftDeleted”, and “SoftDeleting”.

class azure.mgmt.dataprotection.models.ProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Provisioning state of the BackupVault resource.

FAILED = 'Failed'¶

PROVISIONING = 'Provisioning'¶

SUCCEEDED = 'Succeeded'¶

UNKNOWN = 'Unknown'¶

UPDATING = 'Updating'¶

class azure.mgmt.dataprotection.models.RangeBasedItemLevelRestoreCriteria(*, min_matching_value: str | None = None, max_matching_value: str | None = None, **kwargs: Any)[source]¶

Bases: ItemLevelRestoreCriteria

Item Level target info for restore operation.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
min_matching_value (str) – minimum value for range prefix match.
max_matching_value (str) – maximum value for range prefix match.

Keyword Arguments:

min_matching_value (str) – minimum value for range prefix match.
max_matching_value (str) – maximum value for range prefix match.

class azure.mgmt.dataprotection.models.RecoveryOption(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Recovery Option.

FAIL_IF_EXISTS = 'FailIfExists'¶

class azure.mgmt.dataprotection.models.RecoveryPointCompletionState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up).

COMPLETED = 'Completed'¶

PARTIAL = 'Partial'¶

Bases: Model

RecoveryPoint datastore details.

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

Variables:

creation_time (datetime)
expiry_time (datetime)
id (str)
meta_data (str)
state (str)
type (str)
visible (bool)
rehydration_expiry_time (datetime)
rehydration_status (str or RehydrationStatus) – Known values are: “CREATE_IN_PROGRESS”, “COMPLETED”, “DELETE_IN_PROGRESS”, “DELETED”, and “FAILED”.

Keyword Arguments:

creation_time (datetime)
expiry_time (datetime)
id (str)
meta_data (str)
state (str)
type (str)
visible (bool)

class azure.mgmt.dataprotection.models.RecoveryPointsFilters(*, restore_point_data_store_id: str | None = None, is_visible: bool | None = None, start_date: str | None = None, end_date: str | None = None, extended_info: bool | None = None, restore_point_state: str | None = None, **kwargs: Any)[source]¶

Bases: Model

RecoveryPointsFilters.

Variables:

restore_point_data_store_id (str)
is_visible (bool)
start_date (str)
end_date (str)
extended_info (bool)
restore_point_state (str)

Keyword Arguments:

restore_point_data_store_id (str)
is_visible (bool)
start_date (str)
end_date (str)
extended_info (bool)
restore_point_state (str)

class azure.mgmt.dataprotection.models.RehydrationPriority(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Priority to be used for rehydration. Values High or Standard.

HIGH = 'High'¶

INVALID = 'Invalid'¶

STANDARD = 'Standard'¶

class azure.mgmt.dataprotection.models.RehydrationStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

RehydrationStatus.

COMPLETED = 'COMPLETED'¶

CREATE_IN_PROGRESS = 'CREATE_IN_PROGRESS'¶

DELETED = 'DELETED'¶

DELETE_IN_PROGRESS = 'DELETE_IN_PROGRESS'¶

FAILED = 'FAILED'¶

class azure.mgmt.dataprotection.models.ResourceGuard(*, vault_critical_operation_exclusion_list: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

ResourceGuard.

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

Variables:

provisioning_state (str or ProvisioningState) – Provisioning state of the BackupVault resource. Known values are: “Failed”, “Provisioning”, “Succeeded”, “Unknown”, and “Updating”.
allow_auto_approvals (bool) – This flag indicates whether auto approval is allowed or not.
resource_guard_operations (list[ResourceGuardOperation]) – {readonly} List of operation details those are protected by the ResourceGuard resource.
vault_critical_operation_exclusion_list (list[str]) – List of critical operations which are not protected by this resourceGuard.
description (str) – Description about the pre-req steps to perform all the critical operations.

Keyword Arguments:

vault_critical_operation_exclusion_list (list[str]) – List of critical operations which are not protected by this resourceGuard.

class azure.mgmt.dataprotection.models.ResourceGuardOperation(**kwargs: Any)[source]¶

Bases: Model

This class contains all the details about a critical operation.

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

Variables:

vault_critical_operation (str) – Name of the critical operation.
request_resource_type (str) – Type of resource request.

class azure.mgmt.dataprotection.models.ResourceGuardOperationDetail(*, vault_critical_operation: str | None = None, default_resource_request: str | None = None, **kwargs: Any)[source]¶

Bases: Model

VaultCritical Operation protected by a resource guard.

Variables:

vault_critical_operation (str)
default_resource_request (str)

Keyword Arguments:

vault_critical_operation (str)
default_resource_request (str)

class azure.mgmt.dataprotection.models.ResourceGuardProxyBase(*, resource_guard_resource_id: str | None = None, resource_guard_operation_details: List[_models.ResourceGuardOperationDetail] | None = None, last_updated_time: str | None = None, description: str | None = None, **kwargs: Any)[source]¶

Bases: Model

ResourceGuardProxyBase object, used in ResourceGuardProxyBaseResource.

Variables:

resource_guard_resource_id (str)
resource_guard_operation_details (list[ResourceGuardOperationDetail])
last_updated_time (str)
description (str)

Keyword Arguments:

resource_guard_resource_id (str)
resource_guard_operation_details (list[ResourceGuardOperationDetail])
last_updated_time (str)
description (str)

class azure.mgmt.dataprotection.models.ResourceGuardProxyBaseResource(*, properties: _models.ResourceGuardProxyBase | None = None, **kwargs: Any)[source]¶

Bases: DppResource

ResourceGuardProxyBaseResource object, used for response and request bodies for ResourceGuardProxy APIs.

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/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
properties (ResourceGuardProxyBase) – ResourceGuardProxyBaseResource properties.

Keyword Arguments:

properties (ResourceGuardProxyBase) – ResourceGuardProxyBaseResource properties.

class azure.mgmt.dataprotection.models.ResourceGuardProxyBaseResourceList(*, next_link: str | None = None, value: List[_models.ResourceGuardProxyBaseResource] | None = None, **kwargs: Any)[source]¶

Bases: DppResourceList

List of ResourceGuardProxyBase resources.

Variables:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[ResourceGuardProxyBaseResource]) – List of resources.

Keyword Arguments:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[ResourceGuardProxyBaseResource]) – List of resources.

class azure.mgmt.dataprotection.models.ResourceGuardResource(*, e_tag: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, properties: _models.ResourceGuard | None = None, **kwargs: Any)[source]¶

Bases: DppBaseTrackedResource

ResourceGuardResource.

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

Variables:

e_tag (str) – Optional ETag.
id (str) – Resource Id represents the complete path to the resource.
location (str) – Resource location.
name (str) – Resource name associated with the resource.
tags (dict[str, str]) – Resource tags.
type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
properties (ResourceGuard) – ResourceGuardResource properties.

Keyword Arguments:

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

class azure.mgmt.dataprotection.models.ResourceGuardResourceList(*, next_link: str | None = None, value: List[_models.ResourceGuardResource] | None = None, **kwargs: Any)[source]¶

Bases: DppTrackedResourceList

List of ResourceGuard resources.

Variables:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[ResourceGuardResource]) – List of resources.

Keyword Arguments:

next_link (str) – The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
value (list[ResourceGuardResource]) – List of resources.

class azure.mgmt.dataprotection.models.ResourceMoveDetails(*, operation_id: str | None = None, start_time_utc: str | None = None, completion_time_utc: str | None = None, source_resource_path: str | None = None, target_resource_path: str | None = None, **kwargs: Any)[source]¶

Bases: Model

ResourceMoveDetails will be returned in response to GetResource call from ARM.

Variables:

operation_id (str) – CorrelationId of latest ResourceMove operation attempted.
start_time_utc (str) – Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
completion_time_utc (str) – Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
source_resource_path (str) – ARM resource path of source resource.
target_resource_path (str) – ARM resource path of target resource used in latest ResourceMove operation.

Keyword Arguments:

operation_id (str) – CorrelationId of latest ResourceMove operation attempted.
start_time_utc (str) – Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
completion_time_utc (str) – Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
source_resource_path (str) – ARM resource path of source resource.
target_resource_path (str) – ARM resource path of target resource used in latest ResourceMove operation.

class azure.mgmt.dataprotection.models.ResourceMoveState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Resource move state for backup vault.

COMMIT_FAILED = 'CommitFailed'¶

COMMIT_TIMEDOUT = 'CommitTimedout'¶

CRITICAL_FAILURE = 'CriticalFailure'¶

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

MOVE_SUCCEEDED = 'MoveSucceeded'¶

PARTIAL_SUCCESS = 'PartialSuccess'¶

PREPARE_FAILED = 'PrepareFailed'¶

PREPARE_TIMEDOUT = 'PrepareTimedout'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.dataprotection.models.ResourcePropertiesObjectType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Type of the specific object - used for deserializing.

DEFAULT_RESOURCE_PROPERTIES = 'DefaultResourceProperties'¶

class azure.mgmt.dataprotection.models.RestorableTimeRange(*, start_time: str, end_time: str, object_type: str | None = None, **kwargs: Any)[source]¶

Bases: Model

RestorableTimeRange.

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

Variables:

start_time (str) – Start time for the available restore range. Required.
end_time (str) – End time for the available restore range. Required.
object_type (str)

Keyword Arguments:

start_time (str) – Start time for the available restore range. Required.
end_time (str) – End time for the available restore range. Required.
object_type (str)

class azure.mgmt.dataprotection.models.RestoreFilesTargetInfo(*, recovery_option: str | _models.RecoveryOption, target_details: _models.TargetDetails, restore_location: str | None = None, **kwargs: Any)[source]¶

Bases: RestoreTargetInfoBase

Class encapsulating restore as files target parameters.

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

Variables:

object_type (str) – Type of Datasource object, used to initialize the right inherited type. Required.
recovery_option (str or RecoveryOption) – Recovery Option. Required. “FailIfExists”
restore_location (str) – Target Restore region.
target_details (TargetDetails) – Destination of RestoreAsFiles operation, when destination is not a datasource. Required.

Keyword Arguments:

recovery_option (str or RecoveryOption) – Recovery Option. Required. “FailIfExists”
restore_location (str) – Target Restore region.
target_details (TargetDetails) – Destination of RestoreAsFiles operation, when destination is not a datasource. Required.

class azure.mgmt.dataprotection.models.RestoreJobRecoveryPointDetails(*, recovery_point_id: str | None = None, recovery_point_time: datetime | None = None, **kwargs: Any)[source]¶

Bases: Model

RestoreJobRecoveryPointDetails.

Variables:

recovery_point_id (str)
recovery_point_time (datetime)

Keyword Arguments:

recovery_point_id (str)
recovery_point_time (datetime)

class azure.mgmt.dataprotection.models.RestoreSourceDataStoreType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Gets or sets the type of the source data store.

ARCHIVE_STORE = 'ArchiveStore'¶

OPERATIONAL_STORE = 'OperationalStore'¶

VAULT_STORE = 'VaultStore'¶

class azure.mgmt.dataprotection.models.RestoreTargetInfo(*, recovery_option: str | _models.RecoveryOption, datasource_info: _models.Datasource, restore_location: str | None = None, datasource_set_info: _models.DatasourceSet | None = None, datasource_auth_credentials: _models.AuthCredentials | None = None, **kwargs: Any)[source]¶

Bases: RestoreTargetInfoBase

Class encapsulating restore target parameters.

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

Variables:

object_type (str) – Type of Datasource object, used to initialize the right inherited type. Required.
recovery_option (str or RecoveryOption) – Recovery Option. Required. “FailIfExists”
restore_location (str) – Target Restore region.
datasource_info (Datasource) – Information of target DS. Required.
datasource_set_info (DatasourceSet) – Information of target DS Set.
datasource_auth_credentials (AuthCredentials) – Credentials to use to authenticate with data source provider.

Keyword Arguments:

recovery_option (str or RecoveryOption) – Recovery Option. Required. “FailIfExists”
restore_location (str) – Target Restore region.
datasource_info (Datasource) – Information of target DS. Required.
datasource_set_info (DatasourceSet) – Information of target DS Set.
datasource_auth_credentials (AuthCredentials) – Credentials to use to authenticate with data source provider.

class azure.mgmt.dataprotection.models.RestoreTargetInfoBase(*, recovery_option: str | _models.RecoveryOption, restore_location: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Base class common to RestoreTargetInfo and RestoreFilesTargetInfo.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ItemLevelRestoreTargetInfo, RestoreFilesTargetInfo, RestoreTargetInfo

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

Variables:

object_type (str) – Type of Datasource object, used to initialize the right inherited type. Required.
recovery_option (str or RecoveryOption) – Recovery Option. Required. “FailIfExists”
restore_location (str) – Target Restore region.

Keyword Arguments:

recovery_option (str or RecoveryOption) – Recovery Option. Required. “FailIfExists”
restore_location (str) – Target Restore region.

class azure.mgmt.dataprotection.models.RestoreTargetLocationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Denotes the target location where the data will be restored, string value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}.

AZURE_BLOBS = 'AzureBlobs'¶

AZURE_FILES = 'AzureFiles'¶

INVALID = 'Invalid'¶

class azure.mgmt.dataprotection.models.RetentionTag(*, tag_name: str, **kwargs: Any)[source]¶

Bases: Model

Retention tag.

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

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

Variables:

e_tag (str) – Retention Tag version.
id (str) – Retention Tag version.
tag_name (str) – Retention Tag Name to relate it to retention rule. Required.

Keyword Arguments:

tag_name (str) – Retention Tag Name to relate it to retention rule. Required.

Bases: BackupCriteria

Schedule based backup criteria.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
absolute_criteria (list[str or AbsoluteMarker]) – it contains absolute values like “AllBackup” / “FirstOfDay” / “FirstOfWeek” / “FirstOfMonth” and should be part of AbsoluteMarker enum.
days_of_month (list[Day]) – This is day of the month from 1 to 28 other wise last of month.
days_of_the_week (list[str or DayOfWeek]) – It should be Sunday/Monday/T…./Saturday.
months_of_year (list[str or Month]) – It should be January/February/……/December.
schedule_times (list[datetime]) – List of schedule times for backup.
weeks_of_the_month (list[str or WeekNumber]) – It should be First/Second/Third/Fourth/Last.

Keyword Arguments:

absolute_criteria (list[str or AbsoluteMarker]) – it contains absolute values like “AllBackup” / “FirstOfDay” / “FirstOfWeek” / “FirstOfMonth” and should be part of AbsoluteMarker enum.
days_of_month (list[Day]) – This is day of the month from 1 to 28 other wise last of month.
days_of_the_week (list[str or DayOfWeek]) – It should be Sunday/Monday/T…./Saturday.
months_of_year (list[str or Month]) – It should be January/February/……/December.
schedule_times (list[datetime]) – List of schedule times for backup.
weeks_of_the_month (list[str or WeekNumber]) – It should be First/Second/Third/Fourth/Last.

class azure.mgmt.dataprotection.models.ScheduleBasedTriggerContext(*, schedule: _models.BackupSchedule, tagging_criteria: List[_models.TaggingCriteria], **kwargs: Any)[source]¶

Bases: TriggerContext

Schedule based trigger context.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
schedule (BackupSchedule) – Schedule for this backup. Required.
tagging_criteria (list[TaggingCriteria]) – List of tags that can be applicable for given schedule. Required.

Keyword Arguments:

schedule (BackupSchedule) – Schedule for this backup. Required.
tagging_criteria (list[TaggingCriteria]) – List of tags that can be applicable for given schedule. Required.

class azure.mgmt.dataprotection.models.SecretStoreBasedAuthCredentials(*, secret_store_resource: _models.SecretStoreResource | None = None, **kwargs: Any)[source]¶

Bases: AuthCredentials

Secret store based authentication credentials.

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

Variables:

object_type (str) – Type of the specific object - used for deserializing. Required.
secret_store_resource (SecretStoreResource) – Secret store resource.

Keyword Arguments:

secret_store_resource (SecretStoreResource) – Secret store resource.

class azure.mgmt.dataprotection.models.SecretStoreResource(*, secret_store_type: str | _models.SecretStoreType, uri: str | None = None, value: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Class representing a secret store resource.

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

Variables:

uri (str) – Uri to get to the resource.
secret_store_type (str or SecretStoreType) – Gets or sets the type of secret store. Required. Known values are: “Invalid” and “AzureKeyVault”.
value (str) – Gets or sets value stored in secret store resource.

Keyword Arguments:

uri (str) – Uri to get to the resource.
secret_store_type (str or SecretStoreType) – Gets or sets the type of secret store. Required. Known values are: “Invalid” and “AzureKeyVault”.
value (str) – Gets or sets value stored in secret store resource.

class azure.mgmt.dataprotection.models.SecretStoreType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Gets or sets the type of secret store.

AZURE_KEY_VAULT = 'AzureKeyVault'¶

INVALID = 'Invalid'¶

class azure.mgmt.dataprotection.models.SecureScoreLevel(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Secure Score of Backup Vault.

ADEQUATE = 'Adequate'¶

MAXIMUM = 'Maximum'¶

MINIMUM = 'Minimum'¶

NONE = 'None'¶

NOT_SUPPORTED = 'NotSupported'¶

class azure.mgmt.dataprotection.models.SecuritySettings(*, soft_delete_settings: _models.SoftDeleteSettings | None = None, immutability_settings: _models.ImmutabilitySettings | None = None, encryption_settings: _models.EncryptionSettings | None = None, **kwargs: Any)[source]¶

Bases: Model

Class containing security settings of vault.

Variables:

soft_delete_settings (SoftDeleteSettings) – Soft delete related settings.
immutability_settings (ImmutabilitySettings) – Immutability Settings at vault level.
encryption_settings (EncryptionSettings) – Customer Managed Key details of the resource.

Keyword Arguments:

soft_delete_settings (SoftDeleteSettings) – Soft delete related settings.
immutability_settings (ImmutabilitySettings) – Immutability Settings at vault level.
encryption_settings (EncryptionSettings) – Customer Managed Key details of the resource.

class azure.mgmt.dataprotection.models.SoftDeleteSettings(*, state: str | _models.SoftDeleteState | None = None, retention_duration_in_days: float | None = None, **kwargs: Any)[source]¶

Bases: Model

Soft delete related settings.

Variables:

state (str or SoftDeleteState) – State of soft delete. Known values are: “Off”, “On”, and “AlwaysOn”.
retention_duration_in_days (float) – Soft delete retention duration.

Keyword Arguments:

state (str or SoftDeleteState) – State of soft delete. Known values are: “Off”, “On”, and “AlwaysOn”.
retention_duration_in_days (float) – Soft delete retention duration.

class azure.mgmt.dataprotection.models.SoftDeleteState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

State of soft delete.

ALWAYS_ON = 'AlwaysOn'¶: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed

OFF = 'Off'¶: Soft Delete is turned off for the BackupVault

ON = 'On'¶: Soft Delete is enabled for the BackupVault but can be turned off

class azure.mgmt.dataprotection.models.SourceDataStoreType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Gets or sets the type of the source data store.

ARCHIVE_STORE = 'ArchiveStore'¶

OPERATIONAL_STORE = 'OperationalStore'¶

SNAPSHOT_STORE = 'SnapshotStore'¶

VAULT_STORE = 'VaultStore'¶

class azure.mgmt.dataprotection.models.SourceLifeCycle(*, delete_after: _models.DeleteOption, source_data_store: _models.DataStoreInfoBase, target_data_store_copy_settings: List[_models.TargetCopySetting] | None = None, **kwargs: Any)[source]¶

Bases: Model

Source LifeCycle.

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

Variables:

delete_after (DeleteOption) – Delete Option. Required.
source_data_store (DataStoreInfoBase) – DataStoreInfo base. Required.
target_data_store_copy_settings (list[TargetCopySetting])

Keyword Arguments:

delete_after (DeleteOption) – Delete Option. Required.
source_data_store (DataStoreInfoBase) – DataStoreInfo base. Required.
target_data_store_copy_settings (list[TargetCopySetting])

class azure.mgmt.dataprotection.models.Status(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the protection status of the resource.

CONFIGURING_PROTECTION = 'ConfiguringProtection'¶

CONFIGURING_PROTECTION_FAILED = 'ConfiguringProtectionFailed'¶

PROTECTION_CONFIGURED = 'ProtectionConfigured'¶

PROTECTION_STOPPED = 'ProtectionStopped'¶

SOFT_DELETED = 'SoftDeleted'¶

SOFT_DELETING = 'SoftDeleting'¶

class azure.mgmt.dataprotection.models.StopProtectionRequest(*, resource_guard_operation_requests: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Request body of Stop protection when MUA is Enabled.

Variables:: resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
Keyword Arguments:: resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.

class azure.mgmt.dataprotection.models.StorageSetting(*, datastore_type: str | _models.StorageSettingStoreTypes | None = None, type: str | _models.StorageSettingTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

Storage setting.

Variables:

datastore_type (str or StorageSettingStoreTypes) – Gets or sets the type of the datastore. Known values are: “ArchiveStore”, “OperationalStore”, and “VaultStore”.
type (str or StorageSettingTypes) – Gets or sets the type. Known values are: “GeoRedundant”, “LocallyRedundant”, and “ZoneRedundant”.

Keyword Arguments:

datastore_type (str or StorageSettingStoreTypes) – Gets or sets the type of the datastore. Known values are: “ArchiveStore”, “OperationalStore”, and “VaultStore”.
type (str or StorageSettingTypes) – Gets or sets the type. Known values are: “GeoRedundant”, “LocallyRedundant”, and “ZoneRedundant”.

class azure.mgmt.dataprotection.models.StorageSettingStoreTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Gets or sets the type of the datastore.

ARCHIVE_STORE = 'ArchiveStore'¶

OPERATIONAL_STORE = 'OperationalStore'¶

VAULT_STORE = 'VaultStore'¶

class azure.mgmt.dataprotection.models.StorageSettingTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Gets or sets the type.

GEO_REDUNDANT = 'GeoRedundant'¶

LOCALLY_REDUNDANT = 'LocallyRedundant'¶

ZONE_REDUNDANT = 'ZoneRedundant'¶

class azure.mgmt.dataprotection.models.SupportedFeature(*, feature_name: str | None = None, support_status: str | _models.FeatureSupportStatus | None = None, exposure_controlled_features: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Elements class for feature request.

Variables:

feature_name (str) – support feature type.
support_status (str or FeatureSupportStatus) – feature support status. Known values are: “Invalid”, “NotSupported”, “AlphaPreview”, “PrivatePreview”, “PublicPreview”, and “GenerallyAvailable”.
exposure_controlled_features (list[str]) – support feature type.

Keyword Arguments:

feature_name (str) – support feature type.
support_status (str or FeatureSupportStatus) – feature support status. Known values are: “Invalid”, “NotSupported”, “AlphaPreview”, “PrivatePreview”, “PublicPreview”, and “GenerallyAvailable”.
exposure_controlled_features (list[str]) – support feature type.

class azure.mgmt.dataprotection.models.SuspendBackupRequest(*, resource_guard_operation_requests: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Request body of Suspend backup when MUA is Enabled.

Variables:: resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
Keyword Arguments:: resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.

class azure.mgmt.dataprotection.models.SyncBackupInstanceRequest(*, sync_type: str | _models.SyncType | None = None, **kwargs: Any)[source]¶

Bases: Model

Sync BackupInstance Request.

Variables:: sync_type (str or SyncType) – Field indicating sync type e.g. to sync only in case of failure or in all cases. Known values are: “Default” and “ForceResync”.
Keyword Arguments:: sync_type (str or SyncType) – Field indicating sync type e.g. to sync only in case of failure or in all cases. Known values are: “Default” and “ForceResync”.

class azure.mgmt.dataprotection.models.SyncType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Field indicating sync type e.g. to sync only in case of failure or in all cases.

DEFAULT = 'Default'¶

FORCE_RESYNC = 'ForceResync'¶

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.dataprotection.models.TaggingCriteria(*, is_default: bool, tagging_priority: int, tag_info: _models.RetentionTag, criteria: List[_models.BackupCriteria] | None = None, **kwargs: Any)[source]¶

Bases: Model

Tagging criteria.

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

Variables:

criteria (list[BackupCriteria]) – Criteria which decides whether the tag can be applied to a triggered backup.
is_default (bool) – Specifies if tag is default. Required.
tagging_priority (int) – Retention Tag priority. Required.
tag_info (RetentionTag) – Retention tag information. Required.

Keyword Arguments:

criteria (list[BackupCriteria]) – Criteria which decides whether the tag can be applied to a triggered backup.
is_default (bool) – Specifies if tag is default. Required.
tagging_priority (int) – Retention Tag priority. Required.
tag_info (RetentionTag) – Retention tag information. Required.

class azure.mgmt.dataprotection.models.TargetCopySetting(*, copy_after: _models.CopyOption, data_store: _models.DataStoreInfoBase, **kwargs: Any)[source]¶

Bases: Model

Target copy settings.

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

Variables:

copy_after (CopyOption) – It can be CustomCopyOption or ImmediateCopyOption. Required.
data_store (DataStoreInfoBase) – Info of target datastore. Required.

Keyword Arguments:

copy_after (CopyOption) – It can be CustomCopyOption or ImmediateCopyOption. Required.
data_store (DataStoreInfoBase) – Info of target datastore. Required.

class azure.mgmt.dataprotection.models.TargetDetails(*, file_prefix: str, restore_target_location_type: str | _models.RestoreTargetLocationType, url: str, target_resource_arm_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Class encapsulating target details, used where the destination is not a datasource.

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

Variables:

file_prefix (str) – Restore operation may create multiple files inside location pointed by Url Below will be the common prefix for all of them. Required.
restore_target_location_type (str or RestoreTargetLocationType) – Denotes the target location where the data will be restored, string value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}. Required. Known values are: “Invalid”, “AzureBlobs”, and “AzureFiles”.
url (str) – Url denoting the restore destination. It can point to container / file share etc. Required.
target_resource_arm_id (str) – Full ARM Id denoting the restore destination. It is the ARM Id pointing to container / file share This is optional if the target subscription can be identified with the URL field. If not then this is needed if CrossSubscriptionRestore field of BackupVault is in any of the disabled states.

Keyword Arguments:

file_prefix (str) – Restore operation may create multiple files inside location pointed by Url Below will be the common prefix for all of them. Required.
restore_target_location_type (str or RestoreTargetLocationType) – Denotes the target location where the data will be restored, string value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}. Required. Known values are: “Invalid”, “AzureBlobs”, and “AzureFiles”.
url (str) – Url denoting the restore destination. It can point to container / file share etc. Required.
target_resource_arm_id (str) – Full ARM Id denoting the restore destination. It is the ARM Id pointing to container / file share This is optional if the target subscription can be identified with the URL field. If not then this is needed if CrossSubscriptionRestore field of BackupVault is in any of the disabled states.

class azure.mgmt.dataprotection.models.TriggerBackupRequest(*, backup_rule_options: _models.AdHocBackupRuleOptions, **kwargs: Any)[source]¶

Bases: Model

Trigger backup request.

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

Variables:: backup_rule_options (AdHocBackupRuleOptions) – Name for the Rule of the Policy which needs to be applied for this backup. Required.
Keyword Arguments:: backup_rule_options (AdHocBackupRuleOptions) – Name for the Rule of the Policy which needs to be applied for this backup. Required.

class azure.mgmt.dataprotection.models.TriggerContext(**kwargs: Any)[source]¶

Bases: Model

Trigger context.

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

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

Variables:: object_type (str) – Type of the specific object - used for deserializing. Required.

class azure.mgmt.dataprotection.models.UnlockDeleteRequest(*, resource_guard_operation_requests: List[str] | None = None, resource_to_be_deleted: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Request body of unlock delete API.

Variables:

resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
resource_to_be_deleted (str)

Keyword Arguments:

resource_guard_operation_requests (list[str]) – ResourceGuardOperationRequests on which LAC check will be performed.
resource_to_be_deleted (str)

class azure.mgmt.dataprotection.models.UnlockDeleteResponse(*, unlock_delete_expiry_time: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Response of Unlock Delete API.

Variables:: unlock_delete_expiry_time (str) – This is the time when unlock delete privileges will get expired.
Keyword Arguments:: unlock_delete_expiry_time (str) – This is the time when unlock delete privileges will get expired.

class azure.mgmt.dataprotection.models.UserAssignedIdentity(**kwargs: Any)[source]¶

Bases: Model

User assigned identity properties.

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

Variables:

principal_id (str) – The principal ID of the assigned identity.
client_id (str) – The client ID of the assigned identity.

class azure.mgmt.dataprotection.models.UserFacingError(*, code: str | None = None, details: List[_models.UserFacingError] | None = None, inner_error: _models.InnerError | None = None, is_retryable: bool | None = None, is_user_error: bool | None = None, properties: Dict[str, str] | None = None, message: str | None = None, recommended_action: List[str] | None = None, target: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Error object used by layers that have access to localized content, and propagate that to user.

Variables:

code (str) – Unique code for this error.
details (list[UserFacingError]) – Additional related Errors.
inner_error (InnerError) – Inner Error.
is_retryable (bool) – Whether the operation will be retryable or not.
is_user_error (bool) – Whether the operation is due to a user error or service error.
properties (dict[str, str]) – Any key value pairs that can be injected inside error object.
message (str)
recommended_action (list[str]) – RecommendedAction � localized.
target (str) – Target of the error.

Keyword Arguments:

code (str) – Unique code for this error.
details (list[UserFacingError]) – Additional related Errors.
inner_error (InnerError) – Inner Error.
is_retryable (bool) – Whether the operation will be retryable or not.
is_user_error (bool) – Whether the operation is due to a user error or service error.
properties (dict[str, str]) – Any key value pairs that can be injected inside error object.
message (str)
recommended_action (list[str]) – RecommendedAction � localized.
target (str) – Target of the error.

class azure.mgmt.dataprotection.models.UserFacingWarningDetail(*, warning: _models.UserFacingError, resource_name: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Warning object used by layers that have access to localized content, and propagate that to user.

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

Variables:

resource_name (str) – Name of resource for which warning is raised.
warning (UserFacingError) – Error details for the warning. Required.

Keyword Arguments:

resource_name (str) – Name of resource for which warning is raised.
warning (UserFacingError) – Error details for the warning. Required.

class azure.mgmt.dataprotection.models.ValidateCrossRegionRestoreRequestObject(*, restore_request_object: _models.AzureBackupRestoreRequest, cross_region_restore_details: _models.CrossRegionRestoreDetails, **kwargs: Any)[source]¶

Bases: Model

Cross Region Restore Request Object.

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

Variables:

restore_request_object (AzureBackupRestoreRequest) – Gets or sets the restore request object. Required.
cross_region_restore_details (CrossRegionRestoreDetails) – Cross region restore details. Required.

Keyword Arguments:

restore_request_object (AzureBackupRestoreRequest) – Gets or sets the restore request object. Required.
cross_region_restore_details (CrossRegionRestoreDetails) – Cross region restore details. Required.

class azure.mgmt.dataprotection.models.ValidateForBackupRequest(*, backup_instance: _models.BackupInstance, **kwargs: Any)[source]¶

Bases: Model

Validate for backup request.

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

Variables:: backup_instance (BackupInstance) – Backup Instance. Required.
Keyword Arguments:: backup_instance (BackupInstance) – Backup Instance. Required.

class azure.mgmt.dataprotection.models.ValidateRestoreRequestObject(*, restore_request_object: _models.AzureBackupRestoreRequest, **kwargs: Any)[source]¶

Bases: Model

Validate restore request object.

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

Variables:: restore_request_object (AzureBackupRestoreRequest) – Gets or sets the restore request object. Required.
Keyword Arguments:: restore_request_object (AzureBackupRestoreRequest) – Gets or sets the restore request object. Required.

class azure.mgmt.dataprotection.models.ValidationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.

DEEP_VALIDATION = 'DeepValidation'¶

SHALLOW_VALIDATION = 'ShallowValidation'¶

class azure.mgmt.dataprotection.models.WeekNumber(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

WeekNumber.

FIRST = 'First'¶

FOURTH = 'Fourth'¶

LAST = 'Last'¶

SECOND = 'Second'¶

THIRD = 'Third'¶