BackupVaultsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataProtectionMgmtClient's

<xref:backup_vaults> attribute.

Constructor

BackupVaultsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a BackupVault resource belonging to a resource group.
begin_delete	Deletes a BackupVault resource from the resource group.
begin_update	Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.
check_name_availability	API to check for resource name availability. API to check for resource name availability.
get	Returns a resource belonging to a resource group.
get_in_resource_group	Returns resource collection belonging to a resource group.
get_in_subscription	Returns resource collection belonging to a subscription.

begin_create_or_update

Creates or updates a BackupVault resource belonging to a resource group.

begin_create_or_update(resource_group_name: str, vault_name: str, parameters: _models.BackupVaultResource, *, x_ms_authorization_auxiliary: str | None = None, x_ms_deleted_vault_id: str | None = None, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.BackupVaultResource]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
vault_name Required	str The name of the BackupVaultResource. Required.
parameters Required	BackupVaultResource or <xref:JSON> or IO[bytes] Request body for operation. Is one of the following types: BackupVaultResource, JSON, IO[bytes] Required.

Keyword-Only Parameters

Name	Description
x_ms_authorization_auxiliary	str Default value is None. Default value: None
x_ms_deleted_vault_id	str The ID of the deleted backup vault to restore from during undelete flow. Default value is None. Default value: None

Returns

Type	Description
LROPoller[BackupVaultResource]	An instance of LROPoller that returns BackupVaultResource. The BackupVaultResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a BackupVault resource from the resource group.

begin_delete(resource_group_name: str, vault_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
vault_name Required	str The name of the BackupVaultResource. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.

begin_update(resource_group_name: str, vault_name: str, parameters: _models.PatchResourceRequestInput, *, x_ms_authorization_auxiliary: str | None = None, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.BackupVaultResource]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
vault_name Required	str The name of the BackupVaultResource. Required.
parameters Required	PatchResourceRequestInput or <xref:JSON> or IO[bytes] Request body for operation. Is one of the following types: PatchResourceRequestInput, JSON, IO[bytes] Required.

Keyword-Only Parameters

Name	Description
x_ms_authorization_auxiliary	str Default value is None. Default value: None

Returns

Type	Description
LROPoller[BackupVaultResource]	An instance of LROPoller that returns BackupVaultResource. The BackupVaultResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

check_name_availability

API to check for resource name availability.

API to check for resource name availability.

check_name_availability(resource_group_name: str, location: str, parameters: _models.CheckNameAvailabilityRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameAvailabilityResult

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
location Required	str The name of the Azure region. Required.
parameters Required	CheckNameAvailabilityRequest or <xref:JSON> or IO[bytes] Check name availability request. Is one of the following types: CheckNameAvailabilityRequest, JSON, IO[bytes] Required.

Returns

Type	Description
CheckNameAvailabilityResult	CheckNameAvailabilityResult. The CheckNameAvailabilityResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Returns a resource belonging to a resource group.

get(resource_group_name: str, vault_name: str, **kwargs: Any) -> BackupVaultResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
vault_name Required	str The name of the BackupVaultResource. Required.

Returns

Type	Description
BackupVaultResource	BackupVaultResource. The BackupVaultResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_in_resource_group

Returns resource collection belonging to a resource group.

get_in_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[BackupVaultResource]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[BackupVaultResource]	An iterator like instance of BackupVaultResource

Exceptions

Type	Description
HttpResponseError

get_in_subscription

Returns resource collection belonging to a subscription.

get_in_subscription(**kwargs: Any) -> ItemPaged[BackupVaultResource]

Returns

Type	Description
ItemPaged[BackupVaultResource]	An iterator like instance of BackupVaultResource

Exceptions

Type	Description
HttpResponseError