azure.mgmt.recoveryservices.models module

class azure.mgmt.recoveryservices.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.recoveryservices.models.AuthType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Specifies the authentication type.

AAD = 'AAD'
ACCESS_CONTROL_SERVICE = 'AccessControlService'
ACS = 'ACS'
AZURE_ACTIVE_DIRECTORY = 'AzureActiveDirectory'
INVALID = 'Invalid'
class azure.mgmt.recoveryservices.models.AzureMonitorAlertSettings(*, alerts_for_all_job_failures: str | _models.AlertsState | None = None, alerts_for_all_replication_issues: str | _models.AlertsState | None = None, alerts_for_all_failover_issues: 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”.

  • alerts_for_all_replication_issues (str or AlertsState) – Known values are: “Enabled” and “Disabled”.

  • alerts_for_all_failover_issues (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”.

  • alerts_for_all_replication_issues (str or AlertsState) – Known values are: “Enabled” and “Disabled”.

  • alerts_for_all_failover_issues (str or AlertsState) – Known values are: “Enabled” and “Disabled”.

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

Bases: str, Enum

Security levels of Recovery Services Vault for business continuity and disaster recovery.

EXCELLENT = 'Excellent'
FAIR = 'Fair'
GOOD = 'Good'
POOR = 'Poor'
class azure.mgmt.recoveryservices.models.BackupStorageVersion(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Backup storage version.

UNASSIGNED = 'Unassigned'
V1 = 'V1'
V2 = 'V2'
class azure.mgmt.recoveryservices.models.CapabilitiesProperties(*, dns_zones: List[_models.DNSZone] | None = None, **kwargs: Any)[source]

Bases: Model

Capabilities information.

Variables:

dns_zones (list[DNSZone]) –

Keyword Arguments:

dns_zones (list[DNSZone]) –

class azure.mgmt.recoveryservices.models.CapabilitiesResponse(*, type: str, properties: _models.CapabilitiesResponseProperties | None = None, **kwargs: Any)[source]

Bases: ResourceCapabilitiesBase

Capabilities response for Microsoft.RecoveryServices.

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

Variables:

  • type (str) – Describes the Resource type: Microsoft.RecoveryServices/Vaults. Required.

  • properties (CapabilitiesResponseProperties) – Capabilities properties in response.

Keyword Arguments:

  • type (str) – Describes the Resource type: Microsoft.RecoveryServices/Vaults. Required.

  • properties (CapabilitiesResponseProperties) – Capabilities properties in response.

class azure.mgmt.recoveryservices.models.CapabilitiesResponseProperties(*, dns_zones: List[_models.DNSZoneResponse] | None = None, **kwargs: Any)[source]

Bases: Model

Capabilities properties in response.

Variables:

dns_zones (list[DNSZoneResponse]) –

Keyword Arguments:

dns_zones (list[DNSZoneResponse]) –

class azure.mgmt.recoveryservices.models.CertificateRequest(*, properties: _models.RawCertificateData | None = None, **kwargs: Any)[source]

Bases: Model

Details of the certificate to be uploaded to the vault.

Variables:

properties (RawCertificateData) – Raw certificate data.

Keyword Arguments:

properties (RawCertificateData) – Raw certificate data.

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

Bases: Model

Resource Name availability input parameters - Resource type and resource name.

Variables:

  • type (str) – Describes the Resource type: Microsoft.RecoveryServices/Vaults.

  • name (str) – Resource name for which availability needs to be checked.

Keyword Arguments:

  • type (str) – Describes the Resource type: Microsoft.RecoveryServices/Vaults.

  • name (str) – Resource name for which availability needs to be checked.

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

Bases: Model

Response for check name availability API. Resource provider will set availability as true | false.

Variables:

  • name_available (bool) –

  • reason (str) –

  • message (str) –

Keyword Arguments:

  • name_available (bool) –

  • reason (str) –

  • message (str) –

class azure.mgmt.recoveryservices.models.ClassicAlertSettings(*, alerts_for_critical_operations: str | _models.AlertsState | None = None, email_notifications_for_site_recovery: str | _models.AlertsState | None = None, **kwargs: Any)[source]

Bases: Model

Settings for classic alerts.

Variables:

  • alerts_for_critical_operations (str or AlertsState) – Known values are: “Enabled” and “Disabled”.

  • email_notifications_for_site_recovery (str or AlertsState) – Known values are: “Enabled” and “Disabled”.

Keyword Arguments:

  • alerts_for_critical_operations (str or AlertsState) – Known values are: “Enabled” and “Disabled”.

  • email_notifications_for_site_recovery (str or AlertsState) – Known values are: “Enabled” and “Disabled”.

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

Bases: Model

Localized display information of an operation.

Variables:

  • provider (str) – Name of the provider for display purposes.

  • resource (str) – ResourceType for which this Operation can be performed.

  • operation (str) – Operations Name itself.

  • description (str) – Description of the operation having details of what operation is about.

Keyword Arguments:

  • provider (str) – Name of the provider for display purposes.

  • resource (str) – ResourceType for which this Operation can be performed.

  • operation (str) – Operations Name itself.

  • description (str) – Description of the operation having details of what operation is about.

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

Bases: Model

Class to represent shoebox log specification in json client discovery.

Variables:

  • name (str) – Name of the log.

  • display_name (str) – Localized display name.

  • blob_duration (str) – Blobs created in customer storage account per hour.

Keyword Arguments:

  • name (str) – Name of the log.

  • display_name (str) – Localized display name.

  • blob_duration (str) – Blobs created in customer storage account per hour.

class azure.mgmt.recoveryservices.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.recoveryservices.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.recoveryservices.models.ClientDiscoveryResponse(*, value: List[_models.ClientDiscoveryValueForSingleApi] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Operations List response which contains list of available APIs.

Variables:
Keyword Arguments:
class azure.mgmt.recoveryservices.models.ClientDiscoveryValueForSingleApi(*, name: str | None = None, display: _models.ClientDiscoveryDisplay | None = None, origin: str | None = None, properties: _models.ClientDiscoveryForProperties | None = None, **kwargs: Any)[source]

Bases: Model

Available operation details.

Variables:

  • name (str) – Name of the Operation.

  • display (ClientDiscoveryDisplay) – Contains the localized display information for this particular operation.

  • origin (str) – The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX.

  • properties (ClientDiscoveryForProperties) – ShoeBox properties for the given operation.

Keyword Arguments:

  • name (str) – Name of the Operation.

  • display (ClientDiscoveryDisplay) – Contains the localized display information for this particular operation.

  • origin (str) – The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX.

  • properties (ClientDiscoveryForProperties) – ShoeBox properties for the given operation.

class azure.mgmt.recoveryservices.models.CmkKekIdentity(*, use_system_assigned_identity: bool | None = None, user_assigned_identity: str | None = None, **kwargs: Any)[source]

Bases: Model

The details of the identity used for CMK.

Variables:

  • use_system_assigned_identity (bool) – Indicate that system assigned identity should be used. Mutually exclusive with ‘userAssignedIdentity’ field.

  • user_assigned_identity (str) – The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned.

Keyword Arguments:

  • use_system_assigned_identity (bool) – Indicate that system assigned identity should be used. Mutually exclusive with ‘userAssignedIdentity’ field.

  • user_assigned_identity (str) – The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned.

class azure.mgmt.recoveryservices.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.recoveryservices.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.recoveryservices.models.CrossRegionRestore(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Flag to show if Cross Region Restore is enabled on the Vault or not.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.recoveryservices.models.CrossSubscriptionRestoreSettings(*, cross_subscription_restore_state: str | _models.CrossSubscriptionRestoreState | None = None, **kwargs: Any)[source]

Bases: Model

Settings for Cross Subscription Restore Settings.

Variables:

cross_subscription_restore_state (str or CrossSubscriptionRestoreState) – Known values are: “Enabled”, “Disabled”, and “PermanentlyDisabled”.

Keyword Arguments:

cross_subscription_restore_state (str or CrossSubscriptionRestoreState) – Known values are: “Enabled”, “Disabled”, and “PermanentlyDisabled”.

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

Bases: str, Enum

CrossSubscriptionRestoreState.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
PERMANENTLY_DISABLED = 'PermanentlyDisabled'
class azure.mgmt.recoveryservices.models.DNSZone(*, sub_resource: str | _models.VaultSubResourceType | None = None, **kwargs: Any)[source]

Bases: Model

DNSZone information.

Variables:

sub_resource (str or VaultSubResourceType) – Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery. Known values are: “AzureBackup”, “AzureBackup_secondary”, and “AzureSiteRecovery”.

Keyword Arguments:

sub_resource (str or VaultSubResourceType) – Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery. Known values are: “AzureBackup”, “AzureBackup_secondary”, and “AzureSiteRecovery”.

class azure.mgmt.recoveryservices.models.DNSZoneResponse(*, sub_resource: str | _models.VaultSubResourceType | None = None, required_zone_names: List[str] | None = None, **kwargs: Any)[source]

Bases: DNSZone

DNSZone information for Microsoft.RecoveryServices.

Variables:

  • sub_resource (str or VaultSubResourceType) – Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery. Known values are: “AzureBackup”, “AzureBackup_secondary”, and “AzureSiteRecovery”.

  • required_zone_names (list[str]) – The private link resource Private link DNS zone names.

Keyword Arguments:

  • sub_resource (str or VaultSubResourceType) – Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery. Known values are: “AzureBackup”, “AzureBackup_secondary”, and “AzureSiteRecovery”.

  • required_zone_names (list[str]) – The private link resource Private link DNS zone names.

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

Bases: str, Enum

EnhancedSecurityState.

ALWAYS_ON = 'AlwaysON'
DISABLED = 'Disabled'
ENABLED = 'Enabled'
INVALID = 'Invalid'
class azure.mgmt.recoveryservices.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.recoveryservices.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.recoveryservices.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:
class azure.mgmt.recoveryservices.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.recoveryservices.models.IdentityData(*, type: str | _models.ResourceIdentityType, user_assigned_identities: Dict[str, _models.UserIdentity] | None = None, **kwargs: Any)[source]

Bases: Model

Identity for the 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:

  • principal_id (str) – The principal ID of resource identity.

  • tenant_id (str) – The tenant ID of resource.

  • type (str or ResourceIdentityType) – The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identities. Required. Known values are: “SystemAssigned”, “None”, “UserAssigned”, and “SystemAssigned, UserAssigned”.

  • user_assigned_identities (dict[str, UserIdentity]) – The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. # pylint: disable=line-too-long

Keyword Arguments:

  • type (str or ResourceIdentityType) – The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identities. Required. Known values are: “SystemAssigned”, “None”, “UserAssigned”, and “SystemAssigned, UserAssigned”.

  • user_assigned_identities (dict[str, UserIdentity]) – The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. # pylint: disable=line-too-long

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

Bases: Model

Immutability Settings of vault.

Variables:

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

Keyword Arguments:

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

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

Bases: str, Enum

ImmutabilityState.

DISABLED = 'Disabled'
LOCKED = 'Locked'
UNLOCKED = 'Unlocked'
class azure.mgmt.recoveryservices.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.recoveryservices.models.JobsSummary(*, failed_jobs: int | None = None, suspended_jobs: int | None = None, in_progress_jobs: int | None = None, **kwargs: Any)[source]

Bases: Model

Summary of the replication job data for this vault.

Variables:

  • failed_jobs (int) – Count of failed jobs.

  • suspended_jobs (int) – Count of suspended jobs.

  • in_progress_jobs (int) – Count of in-progress jobs.

Keyword Arguments:

  • failed_jobs (int) – Count of failed jobs.

  • suspended_jobs (int) – Count of suspended jobs.

  • in_progress_jobs (int) – Count of in-progress jobs.

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

Bases: Model

Monitoring Settings of the vault.

Variables:
Keyword Arguments:
class azure.mgmt.recoveryservices.models.MonitoringSummary(*, un_healthy_vm_count: int | None = None, un_healthy_provider_count: int | None = None, events_count: int | None = None, deprecated_provider_count: int | None = None, supported_provider_count: int | None = None, unsupported_provider_count: int | None = None, **kwargs: Any)[source]

Bases: Model

Summary of the replication monitoring data for this vault.

Variables:

  • un_healthy_vm_count (int) – Count of unhealthy VMs.

  • un_healthy_provider_count (int) – Count of unhealthy replication providers.

  • events_count (int) – Count of all critical warnings.

  • deprecated_provider_count (int) – Count of all deprecated recovery service providers.

  • supported_provider_count (int) – Count of all the supported recovery service providers.

  • unsupported_provider_count (int) – Count of all the unsupported recovery service providers.

Keyword Arguments:

  • un_healthy_vm_count (int) – Count of unhealthy VMs.

  • un_healthy_provider_count (int) – Count of unhealthy replication providers.

  • events_count (int) – Count of all critical warnings.

  • deprecated_provider_count (int) – Count of all deprecated recovery service providers.

  • supported_provider_count (int) – Count of all the supported recovery service providers.

  • unsupported_provider_count (int) – Count of all the unsupported recovery service providers.

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

Bases: str, Enum

MUA Settings of vault.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
INVALID = 'Invalid'
class azure.mgmt.recoveryservices.models.NameInfo(*, value: str | None = None, localized_value: str | None = None, **kwargs: Any)[source]

Bases: Model

The name of usage.

Variables:

  • value (str) – Value of usage.

  • localized_value (str) – Localized value of usage.

Keyword Arguments:

  • value (str) – Value of usage.

  • localized_value (str) – Localized value of usage.

class azure.mgmt.recoveryservices.models.OperationResource(*, end_time: datetime | None = None, error: _models.Error | None = None, id: str | None = None, name: str | None = None, status: str | None = None, start_time: datetime | None = None, **kwargs: Any)[source]

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.

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

  • status (str) – The status of the operation. (InProgress/Success/Failed/Cancelled).

  • start_time (datetime) – Start time of the operation.

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.

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

  • status (str) – The status of the operation. (InProgress/Success/Failed/Cancelled).

  • start_time (datetime) – Start time of the operation.

class azure.mgmt.recoveryservices.models.PatchTrackedResource(*, etag: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Resource

Tracked resource with location.

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

  • etag (str) – Optional ETag.

  • location (str) – Resource location.

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

Keyword Arguments:

  • etag (str) – Optional ETag.

  • location (str) – Resource location.

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

class azure.mgmt.recoveryservices.models.PatchVault(*, etag: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, properties: _models.VaultProperties | None = None, sku: _models.Sku | None = None, identity: _models.IdentityData | None = None, **kwargs: Any)[source]

Bases: PatchTrackedResource

Patch Resource information, as returned by the resource provider.

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

  • etag (str) – Optional ETag.

  • location (str) – Resource location.

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

  • properties (VaultProperties) – Properties of the vault.

  • sku (Sku) – Identifies the unique system identifier for each Azure resource.

  • identity (IdentityData) – Identity for the resource.

Keyword Arguments:

  • etag (str) – Optional ETag.

  • location (str) – Resource location.

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

  • properties (VaultProperties) – Properties of the vault.

  • sku (Sku) – Identifies the unique system identifier for each Azure resource.

  • identity (IdentityData) – Identity for the resource.

class azure.mgmt.recoveryservices.models.PrivateEndpoint(**kwargs: Any)[source]

Bases: Model

The Private Endpoint network resource that is linked to the Private Endpoint connection.

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

Variables:

id (str) – Gets or sets id.

class azure.mgmt.recoveryservices.models.PrivateEndpointConnection(*, group_ids: List[str | _models.VaultSubResourceType] | None = None, **kwargs: Any)[source]

Bases: Model

Private Endpoint Connection Response Properties.

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

Variables:

  • provisioning_state (str or ProvisioningState) – Gets or sets provisioning state of the private endpoint connection. Known values are: “Succeeded”, “Deleting”, “Failed”, and “Pending”.

  • private_endpoint (PrivateEndpoint) – The Private Endpoint network resource that is linked to the Private Endpoint connection.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – Gets or sets private link service connection state.

  • group_ids (list[str or VaultSubResourceType]) – Group Ids for the Private Endpoint.

Keyword Arguments:

group_ids (list[str or VaultSubResourceType]) – Group Ids for the Private Endpoint.

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

Bases: str, Enum

Gets or sets the status.

APPROVED = 'Approved'
DISCONNECTED = 'Disconnected'
PENDING = 'Pending'
REJECTED = 'Rejected'
class azure.mgmt.recoveryservices.models.PrivateEndpointConnectionVaultProperties(**kwargs: Any)[source]

Bases: Model

Information to be stored in Vault properties as an element of privateEndpointConnections List.

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

Variables:

  • id (str) – Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. # pylint: disable=line-too-long

  • properties (PrivateEndpointConnection) – Private Endpoint Connection Response Properties.

  • name (str) – The name of the private Endpoint Connection.

  • type (str) – The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections.

  • location (str) – The location of the private Endpoint connection.

class azure.mgmt.recoveryservices.models.PrivateLinkResource(**kwargs: Any)[source]

Bases: Model

Information of the private link resource.

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

Variables:

  • id (str) – Fully qualified identifier of the resource.

  • name (str) – Name of the resource.

  • type (str) – e.g. Microsoft.RecoveryServices/vaults/privateLinkResources.

  • group_id (str) – e.g. f9ad6492-33d4-4690-9999-6bfd52a0d081 (Backup) or f9ad6492-33d4-4690-9999-6bfd52a0d082 (SiteRecovery).

  • required_members (list[str]) – [backup-ecs1, backup-prot1, backup-prot1b, backup-prot1c, backup-id1].

  • required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.recoveryservices.models.PrivateLinkResources(*, value: List[_models.PrivateLinkResource] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Class which represent the stamps associated with the vault.

Variables:

  • value (list[PrivateLinkResource]) – A collection of private link resources.

  • next_link (str) – Link to the next chunk of the response.

Keyword Arguments:

  • value (list[PrivateLinkResource]) – A collection of private link resources.

  • next_link (str) – Link to the next chunk of the response.

class azure.mgmt.recoveryservices.models.PrivateLinkServiceConnectionState(**kwargs: Any)[source]

Bases: Model

Gets or sets private link service connection state.

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

Variables:

  • status (str or PrivateEndpointConnectionStatus) – Gets or sets the status. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

  • description (str) – Gets or sets description.

  • actions_required (str) – Gets or sets actions required.

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

Bases: str, Enum

Gets or sets provisioning state of the private endpoint connection.

DELETING = 'Deleting'
FAILED = 'Failed'
PENDING = 'Pending'
SUCCEEDED = 'Succeeded'
class azure.mgmt.recoveryservices.models.PublicNetworkAccess(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

property to enable or disable resource provider inbound network traffic from public clients.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.recoveryservices.models.RawCertificateData(*, auth_type: str | _models.AuthType | None = None, certificate: bytes | None = None, **kwargs: Any)[source]

Bases: Model

Raw certificate data.

Variables:

  • auth_type (str or AuthType) – Specifies the authentication type. Known values are: “Invalid”, “ACS”, “AAD”, “AccessControlService”, and “AzureActiveDirectory”.

  • certificate (bytes) – The base64 encoded certificate raw data string.

Keyword Arguments:

  • auth_type (str or AuthType) – Specifies the authentication type. Known values are: “Invalid”, “ACS”, “AAD”, “AccessControlService”, and “AzureActiveDirectory”.

  • certificate (bytes) – The base64 encoded certificate raw data string.

class azure.mgmt.recoveryservices.models.ReplicationUsage(*, monitoring_summary: _models.MonitoringSummary | None = None, jobs_summary: _models.JobsSummary | None = None, protected_item_count: int | None = None, recovery_plan_count: int | None = None, registered_servers_count: int | None = None, recovery_services_provider_auth_type: int | None = None, **kwargs: Any)[source]

Bases: Model

Replication usages of a vault.

Variables:

  • monitoring_summary (MonitoringSummary) – Summary of the replication monitoring data for this vault.

  • jobs_summary (JobsSummary) – Summary of the replication jobs data for this vault.

  • protected_item_count (int) – Number of replication protected items for this vault.

  • recovery_plan_count (int) – Number of replication recovery plans for this vault.

  • registered_servers_count (int) – Number of servers registered to this vault.

  • recovery_services_provider_auth_type (int) – The authentication type of recovery service providers in the vault.

Keyword Arguments:

  • monitoring_summary (MonitoringSummary) – Summary of the replication monitoring data for this vault.

  • jobs_summary (JobsSummary) – Summary of the replication jobs data for this vault.

  • protected_item_count (int) – Number of replication protected items for this vault.

  • recovery_plan_count (int) – Number of replication recovery plans for this vault.

  • registered_servers_count (int) – Number of servers registered to this vault.

  • recovery_services_provider_auth_type (int) – The authentication type of recovery service providers in the vault.

class azure.mgmt.recoveryservices.models.ReplicationUsageList(*, value: List[_models.ReplicationUsage] | None = None, **kwargs: Any)[source]

Bases: Model

Replication usages for vault.

Variables:

value (list[ReplicationUsage]) – The list of replication usages for the given vault.

Keyword Arguments:

value (list[ReplicationUsage]) – The list of replication usages for the given vault.

class azure.mgmt.recoveryservices.models.Resource(*, etag: str | None = None, **kwargs: Any)[source]

Bases: Model

ARM Resource.

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

Variables:

  • id (str) – Resource Id represents the complete path to the resource.

  • name (str) – Resource name associated with the resource.

  • type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

  • etag (str) – Optional ETag.

Keyword Arguments:

etag (str) – Optional ETag.

class azure.mgmt.recoveryservices.models.ResourceCapabilities(*, type: str, properties: _models.CapabilitiesProperties | None = None, **kwargs: Any)[source]

Bases: ResourceCapabilitiesBase

Input to get capabilities information for Microsoft.RecoveryServices.

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

Variables:

  • type (str) – Describes the Resource type: Microsoft.RecoveryServices/Vaults. Required.

  • properties (CapabilitiesProperties) – Capabilities information.

Keyword Arguments:

  • type (str) – Describes the Resource type: Microsoft.RecoveryServices/Vaults. Required.

  • properties (CapabilitiesProperties) – Capabilities information.

class azure.mgmt.recoveryservices.models.ResourceCapabilitiesBase(*, type: str, **kwargs: Any)[source]

Bases: Model

Base class for request and response capabilities information for Microsoft.RecoveryServices.

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

Variables:

type (str) – Describes the Resource type: Microsoft.RecoveryServices/Vaults. Required.

Keyword Arguments:

type (str) – Describes the Resource type: Microsoft.RecoveryServices/Vaults. Required.

class azure.mgmt.recoveryservices.models.ResourceCertificateAndAadDetails(*, aad_authority: str, aad_tenant_id: str, service_principal_client_id: str, service_principal_object_id: str, azure_management_endpoint_audience: str, certificate: bytes | None = None, friendly_name: str | None = None, issuer: str | None = None, resource_id: int | None = None, subject: str | None = None, thumbprint: str | None = None, valid_from: datetime | None = None, valid_to: datetime | None = None, service_resource_id: str | None = None, aad_audience: str | None = None, **kwargs: Any)[source]

Bases: ResourceCertificateDetails

Certificate details representing the Vault credentials for AAD.

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

Variables:

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

  • certificate (bytes) – The base64 encoded certificate raw data string.

  • friendly_name (str) – Certificate friendly name.

  • issuer (str) – Certificate issuer.

  • resource_id (int) – Resource ID of the vault.

  • subject (str) – Certificate Subject Name.

  • thumbprint (str) – Certificate thumbprint.

  • valid_from (datetime) – Certificate Validity start Date time.

  • valid_to (datetime) – Certificate Validity End Date time.

  • aad_authority (str) – AAD tenant authority. Required.

  • aad_tenant_id (str) – AAD tenant Id. Required.

  • service_principal_client_id (str) – AAD service principal clientId. Required.

  • service_principal_object_id (str) – AAD service principal ObjectId. Required.

  • azure_management_endpoint_audience (str) – Azure Management Endpoint Audience. Required.

  • service_resource_id (str) – Service Resource Id.

  • aad_audience (str) – AAD audience for the resource.

Keyword Arguments:

  • certificate (bytes) – The base64 encoded certificate raw data string.

  • friendly_name (str) – Certificate friendly name.

  • issuer (str) – Certificate issuer.

  • resource_id (int) – Resource ID of the vault.

  • subject (str) – Certificate Subject Name.

  • thumbprint (str) – Certificate thumbprint.

  • valid_from (datetime) – Certificate Validity start Date time.

  • valid_to (datetime) – Certificate Validity End Date time.

  • aad_authority (str) – AAD tenant authority. Required.

  • aad_tenant_id (str) – AAD tenant Id. Required.

  • service_principal_client_id (str) – AAD service principal clientId. Required.

  • service_principal_object_id (str) – AAD service principal ObjectId. Required.

  • azure_management_endpoint_audience (str) – Azure Management Endpoint Audience. Required.

  • service_resource_id (str) – Service Resource Id.

  • aad_audience (str) – AAD audience for the resource.

class azure.mgmt.recoveryservices.models.ResourceCertificateAndAcsDetails(*, global_acs_namespace: str, global_acs_host_name: str, global_acs_rp_realm: str, certificate: bytes | None = None, friendly_name: str | None = None, issuer: str | None = None, resource_id: int | None = None, subject: str | None = None, thumbprint: str | None = None, valid_from: datetime | None = None, valid_to: datetime | None = None, **kwargs: Any)[source]

Bases: ResourceCertificateDetails

Certificate details representing the Vault credentials for ACS.

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

Variables:

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

  • certificate (bytes) – The base64 encoded certificate raw data string.

  • friendly_name (str) – Certificate friendly name.

  • issuer (str) – Certificate issuer.

  • resource_id (int) – Resource ID of the vault.

  • subject (str) – Certificate Subject Name.

  • thumbprint (str) – Certificate thumbprint.

  • valid_from (datetime) – Certificate Validity start Date time.

  • valid_to (datetime) – Certificate Validity End Date time.

  • global_acs_namespace (str) – ACS namespace name - tenant for our service. Required.

  • global_acs_host_name (str) – Acs mgmt host name to connect to. Required.

  • global_acs_rp_realm (str) – Global ACS namespace RP realm. Required.

Keyword Arguments:

  • certificate (bytes) – The base64 encoded certificate raw data string.

  • friendly_name (str) – Certificate friendly name.

  • issuer (str) – Certificate issuer.

  • resource_id (int) – Resource ID of the vault.

  • subject (str) – Certificate Subject Name.

  • thumbprint (str) – Certificate thumbprint.

  • valid_from (datetime) – Certificate Validity start Date time.

  • valid_to (datetime) – Certificate Validity End Date time.

  • global_acs_namespace (str) – ACS namespace name - tenant for our service. Required.

  • global_acs_host_name (str) – Acs mgmt host name to connect to. Required.

  • global_acs_rp_realm (str) – Global ACS namespace RP realm. Required.

class azure.mgmt.recoveryservices.models.ResourceCertificateDetails(*, certificate: bytes | None = None, friendly_name: str | None = None, issuer: str | None = None, resource_id: int | None = None, subject: str | None = None, thumbprint: str | None = None, valid_from: datetime | None = None, valid_to: datetime | None = None, **kwargs: Any)[source]

Bases: Model

Certificate details representing the Vault credentials.

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

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

Variables:

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

  • certificate (bytes) – The base64 encoded certificate raw data string.

  • friendly_name (str) – Certificate friendly name.

  • issuer (str) – Certificate issuer.

  • resource_id (int) – Resource ID of the vault.

  • subject (str) – Certificate Subject Name.

  • thumbprint (str) – Certificate thumbprint.

  • valid_from (datetime) – Certificate Validity start Date time.

  • valid_to (datetime) – Certificate Validity End Date time.

Keyword Arguments:

  • certificate (bytes) – The base64 encoded certificate raw data string.

  • friendly_name (str) – Certificate friendly name.

  • issuer (str) – Certificate issuer.

  • resource_id (int) – Resource ID of the vault.

  • subject (str) – Certificate Subject Name.

  • thumbprint (str) – Certificate thumbprint.

  • valid_from (datetime) – Certificate Validity start Date time.

  • valid_to (datetime) – Certificate Validity End Date time.

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

Bases: str, Enum

The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identities.

NONE = 'None'
SYSTEM_ASSIGNED = 'SystemAssigned'
SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'
USER_ASSIGNED = 'UserAssigned'
class azure.mgmt.recoveryservices.models.ResourceMoveState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The State of the Resource after the move operation.

COMMIT_FAILED = 'CommitFailed'
COMMIT_TIMEDOUT = 'CommitTimedout'
CRITICAL_FAILURE = 'CriticalFailure'
FAILURE = 'Failure'
IN_PROGRESS = 'InProgress'
MOVE_SUCCEEDED = 'MoveSucceeded'
PARTIAL_SUCCESS = 'PartialSuccess'
PREPARE_FAILED = 'PrepareFailed'
PREPARE_TIMEDOUT = 'PrepareTimedout'
UNKNOWN = 'Unknown'
class azure.mgmt.recoveryservices.models.RestoreSettings(*, cross_subscription_restore_settings: _models.CrossSubscriptionRestoreSettings | None = None, **kwargs: Any)[source]

Bases: Model

Restore Settings of the vault.

Variables:

cross_subscription_restore_settings (CrossSubscriptionRestoreSettings) – Settings for CrossSubscriptionRestore.

Keyword Arguments:

cross_subscription_restore_settings (CrossSubscriptionRestoreSettings) – Settings for CrossSubscriptionRestore.

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

Bases: str, Enum

Secure Score of Recovery Services Vault.

ADEQUATE = 'Adequate'
MAXIMUM = 'Maximum'
MINIMUM = 'Minimum'
NONE = 'None'
class azure.mgmt.recoveryservices.models.SecuritySettings(*, immutability_settings: _models.ImmutabilitySettings | None = None, soft_delete_settings: _models.SoftDeleteSettings | None = None, **kwargs: Any)[source]

Bases: Model

Security Settings of the vault.

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

Variables:

  • immutability_settings (ImmutabilitySettings) – Immutability Settings of a vault.

  • soft_delete_settings (SoftDeleteSettings) – Soft delete Settings of a vault.

  • multi_user_authorization (str or MultiUserAuthorization) – MUA Settings of a vault. Known values are: “Invalid”, “Enabled”, and “Disabled”.

Keyword Arguments:
class azure.mgmt.recoveryservices.models.Sku(*, name: str | _models.SkuName, tier: str | None = None, family: str | None = None, size: str | None = None, capacity: str | None = None, **kwargs: Any)[source]

Bases: Model

Identifies the unique system identifier for each Azure resource.

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

Variables:

  • name (str or SkuName) – Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig. Required. Known values are: “Standard” and “RS0”.

  • tier (str) – The Sku tier.

  • family (str) – The sku family.

  • size (str) – The sku size.

  • capacity (str) – The sku capacity.

Keyword Arguments:

  • name (str or SkuName) – Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig. Required. Known values are: “Standard” and “RS0”.

  • tier (str) – The Sku tier.

  • family (str) – The sku family.

  • size (str) – The sku size.

  • capacity (str) – The sku capacity.

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

Bases: str, Enum

Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig.

RS0 = 'RS0'
STANDARD = 'Standard'
class azure.mgmt.recoveryservices.models.SoftDeleteSettings(*, soft_delete_state: str | _models.SoftDeleteState | None = None, soft_delete_retention_period_in_days: int | None = None, enhanced_security_state: str | _models.EnhancedSecurityState | None = None, **kwargs: Any)[source]

Bases: Model

Soft delete Settings of vault.

Variables:

  • soft_delete_state (str or SoftDeleteState) – Known values are: “Invalid”, “Enabled”, “Disabled”, and “AlwaysON”.

  • soft_delete_retention_period_in_days (int) – Soft delete retention period in days.

  • enhanced_security_state (str or EnhancedSecurityState) – Known values are: “Invalid”, “Enabled”, “Disabled”, and “AlwaysON”.

Keyword Arguments:

  • soft_delete_state (str or SoftDeleteState) – Known values are: “Invalid”, “Enabled”, “Disabled”, and “AlwaysON”.

  • soft_delete_retention_period_in_days (int) – Soft delete retention period in days.

  • enhanced_security_state (str or EnhancedSecurityState) – Known values are: “Invalid”, “Enabled”, “Disabled”, and “AlwaysON”.

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

Bases: str, Enum

SoftDeleteState.

ALWAYS_ON = 'AlwaysON'
DISABLED = 'Disabled'
ENABLED = 'Enabled'
INVALID = 'Invalid'
class azure.mgmt.recoveryservices.models.StandardTierStorageRedundancy(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The storage redundancy setting of a vault.

GEO_REDUNDANT = 'GeoRedundant'
INVALID = 'Invalid'
LOCALLY_REDUNDANT = 'LocallyRedundant'
ZONE_REDUNDANT = 'ZoneRedundant'
class azure.mgmt.recoveryservices.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)[source]

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

class azure.mgmt.recoveryservices.models.TrackedResource(*, location: str, etag: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Resource

Tracked resource with location.

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:

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

  • etag (str) – Optional ETag.

  • location (str) – Resource location. Required.

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

Keyword Arguments:

  • etag (str) – Optional ETag.

  • location (str) – Resource location. Required.

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

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

Bases: str, Enum

The way the vault upgrade was triggered.

FORCED_UPGRADE = 'ForcedUpgrade'
USER_TRIGGERED = 'UserTriggered'
class azure.mgmt.recoveryservices.models.UpgradeDetails(**kwargs: Any)[source]

Bases: Model

Details for upgrading vault.

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

Variables:

  • operation_id (str) – ID of the vault upgrade operation.

  • start_time_utc (datetime) – UTC time at which the upgrade operation has started.

  • last_updated_time_utc (datetime) – UTC time at which the upgrade operation status was last updated.

  • end_time_utc (datetime) – UTC time at which the upgrade operation has ended.

  • status (str or VaultUpgradeState) – Status of the vault upgrade operation. Known values are: “Unknown”, “InProgress”, “Upgraded”, and “Failed”.

  • message (str) – Message to the user containing information about the upgrade operation.

  • trigger_type (str or TriggerType) – The way the vault upgrade was triggered. Known values are: “UserTriggered” and “ForcedUpgrade”.

  • upgraded_resource_id (str) – Resource ID of the upgraded vault.

  • previous_resource_id (str) – Resource ID of the vault before the upgrade.

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

Bases: str, Enum

Unit of the usage.

BYTES = 'Bytes'
BYTES_PER_SECOND = 'BytesPerSecond'
COUNT = 'Count'
COUNT_PER_SECOND = 'CountPerSecond'
PERCENT = 'Percent'
SECONDS = 'Seconds'
class azure.mgmt.recoveryservices.models.UserIdentity(**kwargs: Any)[source]

Bases: Model

A resource identity that is managed by the user of the service.

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

Variables:

  • principal_id (str) – The principal ID of the user-assigned identity.

  • client_id (str) – The client ID of the user-assigned identity.

class azure.mgmt.recoveryservices.models.Vault(*, location: str, etag: str | None = None, tags: Dict[str, str] | None = None, identity: _models.IdentityData | None = None, properties: _models.VaultProperties | None = None, sku: _models.Sku | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Resource information, as returned by the resource provider.

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:

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

  • etag (str) – Optional ETag.

  • location (str) – Resource location. Required.

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

  • identity (IdentityData) – Identity for the resource.

  • properties (VaultProperties) – Properties of the vault.

  • sku (Sku) – Identifies the unique system identifier for each Azure resource.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments:

  • etag (str) – Optional ETag.

  • location (str) – Resource location. Required.

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

  • identity (IdentityData) – Identity for the resource.

  • properties (VaultProperties) – Properties of the vault.

  • sku (Sku) – Identifies the unique system identifier for each Azure resource.

class azure.mgmt.recoveryservices.models.VaultCertificateResponse(*, properties: _models.ResourceCertificateDetails | None = None, **kwargs: Any)[source]

Bases: Model

Certificate corresponding to a vault that can be used by clients to register themselves with the vault.

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

Variables:

  • name (str) – Resource name associated with the resource.

  • type (str) – Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

  • id (str) – Resource Id represents the complete path to the resource.

  • properties (ResourceCertificateDetails) – Certificate details representing the Vault credentials.

Keyword Arguments:

properties (ResourceCertificateDetails) – Certificate details representing the Vault credentials.

class azure.mgmt.recoveryservices.models.VaultExtendedInfoResource(*, etag: str | None = None, integrity_key: str | None = None, encryption_key: str | None = None, encryption_key_thumbprint: str | None = None, algorithm: str | None = None, **kwargs: Any)[source]

Bases: Resource

Vault extended information.

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

  • etag (str) – Optional ETag.

  • integrity_key (str) – Integrity key.

  • encryption_key (str) – Encryption key.

  • encryption_key_thumbprint (str) – Encryption key thumbprint.

  • algorithm (str) – Algorithm for Vault ExtendedInfo.

Keyword Arguments:

  • etag (str) – Optional ETag.

  • integrity_key (str) – Integrity key.

  • encryption_key (str) – Encryption key.

  • encryption_key_thumbprint (str) – Encryption key thumbprint.

  • algorithm (str) – Algorithm for Vault ExtendedInfo.

class azure.mgmt.recoveryservices.models.VaultList(*, value: List[_models.Vault] | None = None, **kwargs: Any)[source]

Bases: Model

The response model for a list of Vaults.

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

Variables:
Keyword Arguments:

value (list[Vault]) –

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

Bases: str, Enum

Private endpoint state for backup.

ENABLED = 'Enabled'
NONE = 'None'
class azure.mgmt.recoveryservices.models.VaultProperties(*, upgrade_details: _models.UpgradeDetails | None = None, encryption: _models.VaultPropertiesEncryption | None = None, move_details: _models.VaultPropertiesMoveDetails | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, monitoring_settings: _models.MonitoringSettings | None = None, restore_settings: _models.RestoreSettings | None = None, redundancy_settings: _models.VaultPropertiesRedundancySettings | None = None, security_settings: _models.SecuritySettings | None = None, resource_guard_operation_requests: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Properties of the vault.

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

Variables:

  • provisioning_state (str) – Provisioning State.

  • upgrade_details (UpgradeDetails) – Details for upgrading vault.

  • private_endpoint_connections (list[PrivateEndpointConnectionVaultProperties]) – List of private endpoint connection.

  • private_endpoint_state_for_backup (str or VaultPrivateEndpointState) – Private endpoint state for backup. Known values are: “None” and “Enabled”.

  • private_endpoint_state_for_site_recovery (str or VaultPrivateEndpointState) – Private endpoint state for site recovery. Known values are: “None” and “Enabled”.

  • encryption (VaultPropertiesEncryption) – Customer Managed Key details of the resource.

  • move_details (VaultPropertiesMoveDetails) – The details of the latest move operation performed on the Azure Resource.

  • move_state (str or ResourceMoveState) – The State of the Resource after the move operation. Known values are: “Unknown”, “InProgress”, “PrepareFailed”, “CommitFailed”, “PrepareTimedout”, “CommitTimedout”, “MoveSucceeded”, “Failure”, “CriticalFailure”, and “PartialSuccess”.

  • backup_storage_version (str or BackupStorageVersion) – Backup storage version. Known values are: “V1”, “V2”, and “Unassigned”.

  • public_network_access (str or PublicNetworkAccess) – property to enable or disable resource provider inbound network traffic from public clients. Known values are: “Enabled” and “Disabled”.

  • monitoring_settings (MonitoringSettings) – Monitoring Settings of the vault.

  • restore_settings (RestoreSettings) – Restore Settings of the vault.

  • redundancy_settings (VaultPropertiesRedundancySettings) – The redundancy Settings of a Vault.

  • security_settings (SecuritySettings) – Security Settings of the vault.

  • secure_score (str or SecureScoreLevel) – Secure Score of Recovery Services Vault. Known values are: “None”, “Minimum”, “Adequate”, and “Maximum”.

  • bcdr_security_level (str or BCDRSecurityLevel) – Security levels of Recovery Services Vault for business continuity and disaster recovery. Known values are: “Poor”, “Fair”, “Good”, and “Excellent”.

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

Keyword Arguments:

  • upgrade_details (UpgradeDetails) – Details for upgrading vault.

  • encryption (VaultPropertiesEncryption) – Customer Managed Key details of the resource.

  • move_details (VaultPropertiesMoveDetails) – The details of the latest move operation performed on the Azure Resource.

  • public_network_access (str or PublicNetworkAccess) – property to enable or disable resource provider inbound network traffic from public clients. Known values are: “Enabled” and “Disabled”.

  • monitoring_settings (MonitoringSettings) – Monitoring Settings of the vault.

  • restore_settings (RestoreSettings) – Restore Settings of the vault.

  • redundancy_settings (VaultPropertiesRedundancySettings) – The redundancy Settings of a Vault.

  • security_settings (SecuritySettings) – Security Settings of the vault.

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

class azure.mgmt.recoveryservices.models.VaultPropertiesEncryption(*, 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:

  • key_vault_properties (CmkKeyVaultProperties) – The properties of the Key Vault which hosts CMK.

  • kek_identity (CmkKekIdentity) – The details of the identity used for CMK.

  • infrastructure_encryption (str or InfrastructureEncryptionState) – Enabling/Disabling the Double Encryption state. Known values are: “Enabled” and “Disabled”.

Keyword Arguments:

  • key_vault_properties (CmkKeyVaultProperties) – The properties of the Key Vault which hosts CMK.

  • kek_identity (CmkKekIdentity) – The details of the identity used for CMK.

  • infrastructure_encryption (str or InfrastructureEncryptionState) – Enabling/Disabling the Double Encryption state. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.recoveryservices.models.VaultPropertiesMoveDetails(**kwargs: Any)[source]

Bases: Model

The details of the latest move operation performed on the Azure Resource.

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

Variables:

  • operation_id (str) – OperationId of the Resource Move Operation.

  • start_time_utc (datetime) – Start Time of the Resource Move Operation.

  • completion_time_utc (datetime) – End Time of the Resource Move Operation.

  • source_resource_id (str) – Source Resource of the Resource Move Operation.

  • target_resource_id (str) – Target Resource of the Resource Move Operation.

class azure.mgmt.recoveryservices.models.VaultPropertiesRedundancySettings(*, standard_tier_storage_redundancy: str | _models.StandardTierStorageRedundancy | None = None, cross_region_restore: str | _models.CrossRegionRestore | None = None, **kwargs: Any)[source]

Bases: Model

The redundancy Settings of a Vault.

Variables:

  • standard_tier_storage_redundancy (str or StandardTierStorageRedundancy) – The storage redundancy setting of a vault. Known values are: “Invalid”, “LocallyRedundant”, “GeoRedundant”, and “ZoneRedundant”.

  • cross_region_restore (str or CrossRegionRestore) – Flag to show if Cross Region Restore is enabled on the Vault or not. Known values are: “Enabled” and “Disabled”.

Keyword Arguments:

  • standard_tier_storage_redundancy (str or StandardTierStorageRedundancy) – The storage redundancy setting of a vault. Known values are: “Invalid”, “LocallyRedundant”, “GeoRedundant”, and “ZoneRedundant”.

  • cross_region_restore (str or CrossRegionRestore) – Flag to show if Cross Region Restore is enabled on the Vault or not. Known values are: “Enabled” and “Disabled”.

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

Bases: str, Enum

Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery.

AZURE_BACKUP = 'AzureBackup'
AZURE_BACKUP_SECONDARY = 'AzureBackup_secondary'
AZURE_SITE_RECOVERY = 'AzureSiteRecovery'
class azure.mgmt.recoveryservices.models.VaultUpgradeState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Status of the vault upgrade operation.

FAILED = 'Failed'
IN_PROGRESS = 'InProgress'
UNKNOWN = 'Unknown'
UPGRADED = 'Upgraded'
class azure.mgmt.recoveryservices.models.VaultUsage(*, unit: str | _models.UsagesUnit | None = None, quota_period: str | None = None, next_reset_time: datetime | None = None, current_value: int | None = None, limit: int | None = None, name: _models.NameInfo | None = None, **kwargs: Any)[source]

Bases: Model

Usages of a vault.

Variables:

  • unit (str or UsagesUnit) – Unit of the usage. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, and “BytesPerSecond”.

  • quota_period (str) – Quota period of usage.

  • next_reset_time (datetime) – Next reset time of usage.

  • current_value (int) – Current value of usage.

  • limit (int) – Limit of usage.

  • name (NameInfo) – Name of usage.

Keyword Arguments:

  • unit (str or UsagesUnit) – Unit of the usage. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, and “BytesPerSecond”.

  • quota_period (str) – Quota period of usage.

  • next_reset_time (datetime) – Next reset time of usage.

  • current_value (int) – Current value of usage.

  • limit (int) – Limit of usage.

  • name (NameInfo) – Name of usage.

class azure.mgmt.recoveryservices.models.VaultUsageList(*, value: List[_models.VaultUsage] | None = None, **kwargs: Any)[source]

Bases: Model

Usage for vault.

Variables:

value (list[VaultUsage]) – The list of usages for the given vault.

Keyword Arguments:

value (list[VaultUsage]) – The list of usages for the given vault.