azure.mgmt.recoveryservices.operations module

class azure.mgmt.recoveryservices.operations.VaultCertificatesOperations(client, config, serializer, deserializer)[source]

Bases: object

VaultCertificatesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2016-06-01”.

create(resource_group_name, vault_name, certificate_name, properties=None, custom_headers=None, raw=False, **operation_config)[source]

Uploads a certificate for a resource.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • certificate_name (str) – Certificate friendly name.

  • properties (RawCertificateData) –

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

VaultCertificateResponse or ClientRawResponse if raw=true

Return type

VaultCertificateResponse or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.recoveryservices.models' from '/home/vsts/work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>
class azure.mgmt.recoveryservices.operations.RegisteredIdentitiesOperations(client, config, serializer, deserializer)[source]

Bases: object

RegisteredIdentitiesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2016-06-01”.

delete(resource_group_name, vault_name, identity_name, custom_headers=None, raw=False, **operation_config)[source]

Unregisters the given container from your Recovery Services vault.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • identity_name (str) – Name of the protection container to unregister.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.recoveryservices.models' from '/home/vsts/work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>
class azure.mgmt.recoveryservices.operations.ReplicationUsagesOperations(client, config, serializer, deserializer)[source]

Bases: object

ReplicationUsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2016-06-01”.

list(resource_group_name, vault_name, custom_headers=None, raw=False, **operation_config)[source]

Fetches the replication usages of the vault.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ReplicationUsage

Return type

ReplicationUsagePaged[ReplicationUsage]

Raises

CloudError

models = <module 'azure.mgmt.recoveryservices.models' from '/home/vsts/work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>
class azure.mgmt.recoveryservices.operations.PrivateLinkResourcesOperations(client, config, serializer, deserializer)[source]

Bases: object

PrivateLinkResourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2016-06-01”.

get(resource_group_name, vault_name, private_link_resource_name, custom_headers=None, raw=False, **operation_config)[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 where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • private_link_resource_name (str) –

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

PrivateLinkResource or ClientRawResponse if raw=true

Return type

PrivateLinkResource or ClientRawResponse

Raises

CloudError

list(resource_group_name, vault_name, custom_headers=None, raw=False, **operation_config)[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 where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of PrivateLinkResource

Return type

PrivateLinkResourcePaged[PrivateLinkResource]

Raises

CloudError

models = <module 'azure.mgmt.recoveryservices.models' from '/home/vsts/work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>
class azure.mgmt.recoveryservices.operations.RecoveryServicesOperations(client, config, serializer, deserializer)[source]

Bases: object

RecoveryServicesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2016-06-01”.

check_name_availability(resource_group_name, location, type=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

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 where the recovery services vault is present.

  • location (str) – Location of the resource

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

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

CheckNameAvailabilityResult or ClientRawResponse if raw=true

Return type

CheckNameAvailabilityResult or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.recoveryservices.models' from '/home/vsts/work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>
class azure.mgmt.recoveryservices.operations.VaultsOperations(client, config, serializer, deserializer)[source]

Bases: object

VaultsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2016-06-01”.

create_or_update(resource_group_name, vault_name, vault, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a Recovery Services vault.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • vault (Vault) – Recovery Services Vault to be created.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Vault or ClientRawResponse if raw=true

Return type

Vault or ClientRawResponse

Raises

CloudError

delete(resource_group_name, vault_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a vault.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, vault_name, custom_headers=None, raw=False, **operation_config)[source]

Get the Vault details.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Vault or ClientRawResponse if raw=true

Return type

Vault or ClientRawResponse

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieve a list of Vaults.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Vault

Return type

VaultPaged[Vault]

Raises

CloudError

list_by_subscription_id(custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Vault

Return type

VaultPaged[Vault]

Raises

CloudError

update(resource_group_name, vault_name, vault, custom_headers=None, raw=False, **operation_config)[source]

Updates the vault.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • vault (PatchVault) – Recovery Services Vault to be created.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Vault or ClientRawResponse if raw=true

Return type

Vault or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.recoveryservices.models' from '/home/vsts/work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>
class azure.mgmt.recoveryservices.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2016-06-01”.

list(custom_headers=None, raw=False, **operation_config)[source]

Returns the list of available operations.

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ClientDiscoveryValueForSingleApi

Return type

ClientDiscoveryValueForSingleApiPaged[ClientDiscoveryValueForSingleApi]

Raises

CloudError

models = <module 'azure.mgmt.recoveryservices.models' from '/home/vsts/work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>
class azure.mgmt.recoveryservices.operations.VaultExtendedInfoOperations(client, config, serializer, deserializer)[source]

Bases: object

VaultExtendedInfoOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2016-06-01”.

create_or_update(resource_group_name, vault_name, resource_resource_extended_info_details, custom_headers=None, raw=False, **operation_config)[source]

Create vault extended info.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • resource_resource_extended_info_details (VaultExtendedInfoResource) – Details of ResourceExtendedInfo

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

VaultExtendedInfoResource or ClientRawResponse if raw=true

Return type

VaultExtendedInfoResource or ClientRawResponse

Raises

CloudError

get(resource_group_name, vault_name, custom_headers=None, raw=False, **operation_config)[source]

Get the vault extended info.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

VaultExtendedInfoResource or ClientRawResponse if raw=true

Return type

VaultExtendedInfoResource or ClientRawResponse

Raises

CloudError

update(resource_group_name, vault_name, resource_resource_extended_info_details, custom_headers=None, raw=False, **operation_config)[source]

Update vault extended info.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • resource_resource_extended_info_details (VaultExtendedInfoResource) – Details of ResourceExtendedInfo

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

VaultExtendedInfoResource or ClientRawResponse if raw=true

Return type

VaultExtendedInfoResource or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.recoveryservices.models' from '/home/vsts/work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>
class azure.mgmt.recoveryservices.operations.UsagesOperations(client, config, serializer, deserializer)[source]

Bases: object

UsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2016-06-01”.

list_by_vaults(resource_group_name, vault_name, custom_headers=None, raw=False, **operation_config)[source]

Fetches the usages of the vault.

Parameters
  • resource_group_name (str) – The name of the resource group where the recovery services vault is present.

  • vault_name (str) – The name of the recovery services vault.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of VaultUsage

Return type

VaultUsagePaged[VaultUsage]

Raises

CloudError

models = <module 'azure.mgmt.recoveryservices.models' from '/home/vsts/work/1/s/sdk/recoveryservices/azure-mgmt-recoveryservices/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/recoveryservices/models/__init__.py'>