VaultsOperations Class

VaultsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

VaultsOperations

Constructor

VaultsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_purge_deleted	Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
check_name_availability	Checks that the vault name is valid and is not already in use.
create_or_update	Create or update a key vault in the specified subscription.
delete	Deletes the specified Azure key vault.
get	Gets the specified Azure key vault.
get_deleted	Gets the deleted Azure key vault.
list	The List operation gets information about the vaults associated with the subscription.
list_by_resource_group	The List operation gets information about the vaults associated with the subscription and within the specified resource group.
list_by_subscription	The List operation gets information about the vaults associated with the subscription.
list_deleted	Gets information about the deleted vaults in a subscription.
update	Update a key vault in the specified subscription.
update_access_policy	Update access policies in a key vault in the specified subscription.

begin_purge_deleted

Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

begin_purge_deleted(vault_name: str, location: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

vault_name

str

Required

The name of the soft-deleted vault.

location

str

Required

The location of the soft-deleted vault.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Exceptions

HttpResponseError

check_name_availability

Checks that the vault name is valid and is not already in use.

check_name_availability(vault_name: azure.mgmt.keyvault.v2016_10_01.models._models_py3.VaultCheckNameAvailabilityParameters, **kwargs: Any) -> azure.mgmt.keyvault.v2016_10_01.models._models_py3.CheckNameAvailabilityResult

Parameters

vault_name

VaultCheckNameAvailabilityParameters

Required

The name of the vault.

cls

callable

A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityResult, or the result of cls(response)

Return type

CheckNameAvailabilityResult

Exceptions

HttpResponseError

create_or_update

Create or update a key vault in the specified subscription.

create_or_update(resource_group_name: str, vault_name: str, parameters: azure.mgmt.keyvault.v2016_10_01.models._models_py3.VaultCreateOrUpdateParameters, **kwargs: Any) -> azure.mgmt.keyvault.v2016_10_01.models._models_py3.Vault

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the server belongs.

vault_name

str

Required

Name of the vault.

parameters

VaultCreateOrUpdateParameters

Required

Parameters to create or update the vault.

cls

callable

A custom type or function that will be passed the direct response

Returns

Vault, or the result of cls(response)

Return type

Vault

Exceptions

HttpResponseError

delete

Deletes the specified Azure key vault.

delete(resource_group_name: str, vault_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the vault belongs.

vault_name

str

Required

The name of the vault to delete.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Gets the specified Azure key vault.

get(resource_group_name: str, vault_name: str, **kwargs: Any) -> azure.mgmt.keyvault.v2016_10_01.models._models_py3.Vault

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the vault belongs.

vault_name

str

Required

The name of the vault.

cls

callable

A custom type or function that will be passed the direct response

Returns

Vault, or the result of cls(response)

Return type

Vault

Exceptions

HttpResponseError

get_deleted

Gets the deleted Azure key vault.

get_deleted(vault_name: str, location: str, **kwargs: Any) -> azure.mgmt.keyvault.v2016_10_01.models._models_py3.DeletedVault

Parameters

vault_name

str

Required

The name of the vault.

location

str

Required

The location of the deleted vault.

cls

callable

A custom type or function that will be passed the direct response

Returns

DeletedVault, or the result of cls(response)

Return type

DeletedVault

Exceptions

HttpResponseError

list

The List operation gets information about the vaults associated with the subscription.

list(top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.keyvault.v2016_10_01.models._models_py3.ResourceListResult]

Parameters

top

int

Required

Maximum number of results to return. Default value is None.

filter

str

The filter to apply on the operation. Default value is "resourceType eq 'Microsoft.KeyVault/vaults'". Note that overriding this default value may result in unsupported behavior.

api_version

str

Azure Resource Manager Api Version. Default value is "2015-11-01". Note that overriding this default value may result in unsupported behavior.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ResourceListResult]

Exceptions

HttpResponseError

list_by_resource_group

The List operation gets information about the vaults associated with the subscription and within the specified resource group.

list_by_resource_group(resource_group_name: str, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.keyvault.v2016_10_01.models._models_py3.VaultListResult]

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the vault belongs.

top

int

Required

Maximum number of results to return. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[VaultListResult]

Exceptions

HttpResponseError

list_by_subscription

The List operation gets information about the vaults associated with the subscription.

list_by_subscription(top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.keyvault.v2016_10_01.models._models_py3.VaultListResult]

Parameters

top

int

Required

Maximum number of results to return. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[VaultListResult]

Exceptions

HttpResponseError

list_deleted

Gets information about the deleted vaults in a subscription.

list_deleted(**kwargs: Any) -> Iterable[azure.mgmt.keyvault.v2016_10_01.models._models_py3.DeletedVaultListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[DeletedVaultListResult]

Exceptions

HttpResponseError

update

Update a key vault in the specified subscription.

update(resource_group_name: str, vault_name: str, parameters: azure.mgmt.keyvault.v2016_10_01.models._models_py3.VaultPatchParameters, **kwargs: Any) -> azure.mgmt.keyvault.v2016_10_01.models._models_py3.Vault

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the server belongs.

vault_name

str

Required

Name of the vault.

parameters

VaultPatchParameters

Required

Parameters to patch the vault.

cls

callable

A custom type or function that will be passed the direct response

Returns

Vault, or the result of cls(response)

Return type

Vault

Exceptions

HttpResponseError

update_access_policy

Update access policies in a key vault in the specified subscription.

update_access_policy(resource_group_name: str, vault_name: str, operation_kind: Union[str, azure.mgmt.keyvault.v2016_10_01.models._key_vault_management_client_enums.AccessPolicyUpdateKind], parameters: azure.mgmt.keyvault.v2016_10_01.models._models_py3.VaultAccessPolicyParameters, **kwargs: Any) -> azure.mgmt.keyvault.v2016_10_01.models._models_py3.VaultAccessPolicyParameters

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the vault belongs.

vault_name

str

Required

Name of the vault.

operation_kind

str or AccessPolicyUpdateKind

Required

Name of the operation.

parameters

VaultAccessPolicyParameters

Required

Access policy to merge into the vault.

cls

callable

A custom type or function that will be passed the direct response

Returns

VaultAccessPolicyParameters, or the result of cls(response)

Return type

VaultAccessPolicyParameters

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.keyvault.v2016_10_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\keyvault\\v2016_10_01\\models\\__init__.py'>