azure.mgmt.recoveryservices.operations module¶

class azure.mgmt.recoveryservices.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RecoveryServicesClient’s operations attribute.

list(**kwargs: Any) → Iterable[ClientDiscoveryValueForSingleApi][source]¶

Returns the list of available operations.

Returns:: An iterator like instance of either ClientDiscoveryValueForSingleApi or the result of cls(response)
Return type:: ItemPaged[ClientDiscoveryValueForSingleApi]
Raises:: HttpResponseError –

models = <module 'azure.mgmt.recoveryservices.models' from '/mnt/vss/_work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>¶

class azure.mgmt.recoveryservices.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RecoveryServicesClient’s private_link_resources attribute.

get(resource_group_name: str, vault_name: str, private_link_resource_name: str, **kwargs: Any) → PrivateLinkResource[source]¶

Returns a specified private link resource that need to be created for Backup and SiteRecovery.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.
private_link_resource_name (str) – Required.

Returns:

PrivateLinkResource or the result of cls(response)

Return type:

PrivateLinkResource

Raises:

HttpResponseError –

list(resource_group_name: str, vault_name: str, **kwargs: Any) → Iterable[PrivateLinkResource][source]¶

Returns the list of private link resources that need to be created for Backup and SiteRecovery.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.

Returns:

An iterator like instance of either PrivateLinkResource or the result of cls(response)

Return type:

ItemPaged[PrivateLinkResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.recoveryservices.models' from '/mnt/vss/_work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>¶

class azure.mgmt.recoveryservices.operations.RecoveryServicesClientOperationsMixin[source]¶

Bases: RecoveryServicesClientMixinABC

get_operation_result(resource_group_name: str, vault_name: str, operation_id: str, **kwargs: Any) → Vault | None[source]¶

Gets the operation result for a resource.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.
operation_id (str) – Required.

Returns:

Vault or None or the result of cls(response)

Return type:

Vault or None

Raises:

HttpResponseError –

get_operation_status(resource_group_name: str, vault_name: str, operation_id: str, **kwargs: Any) → OperationResource[source]¶

Gets the operation status for a resource.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.
operation_id (str) – Required.

Returns:

OperationResource or the result of cls(response)

Return type:

OperationResource

Raises:

HttpResponseError –

class azure.mgmt.recoveryservices.operations.RecoveryServicesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RecoveryServicesClient’s recovery_services attribute.

capabilities(location: str, input: _models.ResourceCapabilities, *, content_type: str = 'application/json', **kwargs: Any) → _models.CapabilitiesResponse[source]¶

capabilities(location: str, input: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.CapabilitiesResponse

API to get details about capabilities provided by Microsoft.RecoveryServices RP.

Parameters:

location (str) – Location of the resource. Required.
input (ResourceCapabilities or IO[bytes]) – Contains information about Resource type and properties to get capabilities. Is either a ResourceCapabilities type or a IO[bytes] type. Required.

Returns:

CapabilitiesResponse or the result of cls(response)

Return type:

CapabilitiesResponse

Raises:

HttpResponseError –

check_name_availability(resource_group_name: str, location: str, input: _models.CheckNameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.CheckNameAvailabilityResult[source]¶

check_name_availability(resource_group_name: str, location: str, input: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.CheckNameAvailabilityResult

API to check for resource name availability. A name is available if no other resource exists that has the same SubscriptionId, Resource Name and Type or if one or more such resources exist, each of these must be GC’d and their time of deletion be more than 24 Hours Ago.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
location (str) – Location of the resource. Required.
input (CheckNameAvailabilityParameters or IO[bytes]) – Contains information about Resource type and Resource name. Is either a CheckNameAvailabilityParameters type or a IO[bytes] type. Required.

Returns:

CheckNameAvailabilityResult or the result of cls(response)

Return type:

CheckNameAvailabilityResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.recoveryservices.models' from '/mnt/vss/_work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>¶

class azure.mgmt.recoveryservices.operations.RegisteredIdentitiesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RecoveryServicesClient’s registered_identities attribute.

delete(resource_group_name: str, vault_name: str, identity_name: str, **kwargs: Any) → None[source]¶

Unregisters the given container from your Recovery Services vault.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.
identity_name (str) – Name of the protection container to unregister. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

models = <module 'azure.mgmt.recoveryservices.models' from '/mnt/vss/_work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>¶

class azure.mgmt.recoveryservices.operations.ReplicationUsagesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RecoveryServicesClient’s replication_usages attribute.

list(resource_group_name: str, vault_name: str, **kwargs: Any) → Iterable[ReplicationUsage][source]¶

Fetches the replication usages of the vault.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.

Returns:

An iterator like instance of either ReplicationUsage or the result of cls(response)

Return type:

ItemPaged[ReplicationUsage]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.recoveryservices.models' from '/mnt/vss/_work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>¶

class azure.mgmt.recoveryservices.operations.UsagesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RecoveryServicesClient’s usages attribute.

list_by_vaults(resource_group_name: str, vault_name: str, **kwargs: Any) → Iterable[VaultUsage][source]¶

Fetches the usages of the vault.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.

Returns:

An iterator like instance of either VaultUsage or the result of cls(response)

Return type:

ItemPaged[VaultUsage]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.recoveryservices.models' from '/mnt/vss/_work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>¶

class azure.mgmt.recoveryservices.operations.VaultCertificatesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RecoveryServicesClient’s vault_certificates attribute.

create(resource_group_name: str, vault_name: str, certificate_name: str, certificate_request: _models.CertificateRequest, *, content_type: str = 'application/json', **kwargs: Any) → _models.VaultCertificateResponse[source]¶

create(resource_group_name: str, vault_name: str, certificate_name: str, certificate_request: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.VaultCertificateResponse

Uploads a certificate for a resource.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.
certificate_name (str) – Certificate friendly name. Required.
certificate_request (CertificateRequest or IO[bytes]) – Input parameters for uploading the vault certificate. Is either a CertificateRequest type or a IO[bytes] type. Required.

Returns:

VaultCertificateResponse or the result of cls(response)

Return type:

VaultCertificateResponse

Raises:

HttpResponseError –

models = <module 'azure.mgmt.recoveryservices.models' from '/mnt/vss/_work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>¶

class azure.mgmt.recoveryservices.operations.VaultExtendedInfoOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RecoveryServicesClient’s vault_extended_info attribute.

create_or_update(resource_group_name: str, vault_name: str, resource_extended_info_details: _models.VaultExtendedInfoResource, *, content_type: str = 'application/json', **kwargs: Any) → _models.VaultExtendedInfoResource[source]¶

create_or_update(resource_group_name: str, vault_name: str, resource_extended_info_details: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.VaultExtendedInfoResource

Create vault extended info.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.
resource_extended_info_details (VaultExtendedInfoResource or IO[bytes]) – Details of ResourceExtendedInfo. Is either a VaultExtendedInfoResource type or a IO[bytes] type. Required.

Returns:

VaultExtendedInfoResource or the result of cls(response)

Return type:

VaultExtendedInfoResource

Raises:

HttpResponseError –

get(resource_group_name: str, vault_name: str, **kwargs: Any) → VaultExtendedInfoResource[source]¶

Get the vault extended info.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.

Returns:

VaultExtendedInfoResource or the result of cls(response)

Return type:

VaultExtendedInfoResource

Raises:

HttpResponseError –

update(resource_group_name: str, vault_name: str, resource_extended_info_details: _models.VaultExtendedInfoResource, *, content_type: str = 'application/json', **kwargs: Any) → _models.VaultExtendedInfoResource[source]¶

update(resource_group_name: str, vault_name: str, resource_extended_info_details: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.VaultExtendedInfoResource

Update vault extended info.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.
resource_extended_info_details (VaultExtendedInfoResource or IO[bytes]) – Details of ResourceExtendedInfo. Is either a VaultExtendedInfoResource type or a IO[bytes] type. Required.

Returns:

VaultExtendedInfoResource or the result of cls(response)

Return type:

VaultExtendedInfoResource

Raises:

HttpResponseError –

models = <module 'azure.mgmt.recoveryservices.models' from '/mnt/vss/_work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>¶

class azure.mgmt.recoveryservices.operations.VaultsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through RecoveryServicesClient’s vaults attribute.

begin_create_or_update(resource_group_name: str, vault_name: str, vault: _models.Vault, x_ms_authorization_auxiliary: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Vault][source]¶

begin_create_or_update(resource_group_name: str, vault_name: str, vault: IO[bytes], x_ms_authorization_auxiliary: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Vault]

Creates or updates a Recovery Services vault.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.
vault (Vault or IO[bytes]) – Recovery Services Vault to be created. Is either a Vault type or a IO[bytes] type. Required.
x_ms_authorization_auxiliary (str) – Default value is None.

Returns:

An instance of LROPoller that returns either Vault or the result of cls(response)

Return type:

LROPoller[Vault]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, vault_name: str, **kwargs: Any) → LROPoller[None][source]¶

Deletes a vault.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, vault_name: str, vault: _models.PatchVault, x_ms_authorization_auxiliary: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Vault][source]¶

begin_update(resource_group_name: str, vault_name: str, vault: IO[bytes], x_ms_authorization_auxiliary: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.Vault]

Updates the vault.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.
vault (PatchVault or IO[bytes]) – Recovery Services Vault to be created. Is either a PatchVault type or a IO[bytes] type. Required.
x_ms_authorization_auxiliary (str) – Default value is None.

Returns:

An instance of LROPoller that returns either Vault or the result of cls(response)

Return type:

LROPoller[Vault]

Raises:

HttpResponseError –

get(resource_group_name: str, vault_name: str, **kwargs: Any) → Vault[source]¶

Get the Vault details.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
vault_name (str) – The name of the recovery services vault. Required.

Returns:

Vault or the result of cls(response)

Return type:

Vault

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[Vault][source]¶

Retrieve a list of Vaults.

Parameters:: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Returns:: An iterator like instance of either Vault or the result of cls(response)
Return type:: ItemPaged[Vault]
Raises:: HttpResponseError –

list_by_subscription_id(**kwargs: Any) → Iterable[Vault][source]¶

Fetches all the resources of the specified type in the subscription.

Returns:: An iterator like instance of either Vault or the result of cls(response)
Return type:: ItemPaged[Vault]
Raises:: HttpResponseError –

models = <module 'azure.mgmt.recoveryservices.models' from '/mnt/vss/_work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>¶