azure.mgmt.keyvault.v2023_02_01.operations module

class azure.mgmt.keyvault.v2023_02_01.operations.KeysOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create_if_not_exist(resource_group_name: str, vault_name: str, key_name: str, parameters: KeyCreateParameters | IO[bytes], **kwargs: Any) → Key

Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.

Parameters:

• resource_group_name (str) – The name of the resource group which contains the specified key vault. Required.

• vault_name (str) – The name of the key vault which contains the key to be created. Required.

• key_name (str) – The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information. Required.

• parameters (KeyCreateParameters or IO[bytes]) – The parameters used to create the specified key. Is either a KeyCreateParameters type or a IO[bytes] type. Required.

Returns:

Key or the result of cls(response)

Return type:

Key

Raises:

HttpResponseError –

get(resource_group_name: str, vault_name: str, key_name: str, **kwargs: Any) → Key

Gets the current version of the specified key from the specified key vault.

Parameters:

• resource_group_name (str) – The name of the resource group which contains the specified key vault. Required.

• vault_name (str) – The name of the vault which contains the key to be retrieved. Required.

• key_name (str) – The name of the key to be retrieved. Required.

Returns:

Key or the result of cls(response)

Return type:

Key

Raises:

HttpResponseError –

get_version(resource_group_name: str, vault_name: str, key_name: str, key_version: str, **kwargs: Any) → Key

Gets the specified version of the specified key in the specified key vault.

Parameters:

• resource_group_name (str) – The name of the resource group which contains the specified key vault. Required.

• vault_name (str) – The name of the vault which contains the key version to be retrieved. Required.

• key_name (str) – The name of the key version to be retrieved. Required.

• key_version (str) – The version of the key to be retrieved. Required.

Returns:

Key or the result of cls(response)

Return type:

Key

Raises:

HttpResponseError –

list(resource_group_name: str, vault_name: str, **kwargs: Any) → Iterable[Key]

Lists the keys in the specified key vault.

Parameters:

• resource_group_name (str) – The name of the resource group which contains the specified key vault. Required.

• vault_name (str) – The name of the vault which contains the keys to be retrieved. Required.

Returns:

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

Return type:

ItemPaged[Key]

Raises:

HttpResponseError –

list_versions(resource_group_name: str, vault_name: str, key_name: str, **kwargs: Any) → Iterable[Key]

Lists the versions of the specified key in the specified key vault.

Parameters:

• resource_group_name (str) – The name of the resource group which contains the specified key vault. Required.

• vault_name (str) – The name of the vault which contains the key versions to be retrieved. Required.

• key_name (str) – The name of the key versions to be retrieved. Required.

Returns:

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

Return type:

ItemPaged[Key]

Raises:

HttpResponseError –

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

class azure.mgmt.keyvault.v2023_02_01.operations.MHSMPrivateEndpointConnectionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_delete(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) → LROPoller[MHSMPrivateEndpointConnection]

Deletes the specified private endpoint connection associated with the managed hsm pool.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• name (str) – Name of the managed HSM Pool. Required.

• private_endpoint_connection_name (str) – Name of the private endpoint connection associated with the managed hsm pool. Required.

Returns:

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

Return type:

LROPoller[MHSMPrivateEndpointConnection]

Raises:

HttpResponseError –

get(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) → MHSMPrivateEndpointConnection

Gets the specified private endpoint connection associated with the managed HSM Pool.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• name (str) – Name of the managed HSM Pool. Required.

• private_endpoint_connection_name (str) – Name of the private endpoint connection associated with the managed hsm pool. Required.

Returns:

MHSMPrivateEndpointConnection or the result of cls(response)

Return type:

MHSMPrivateEndpointConnection

Raises:

HttpResponseError –

list_by_resource(resource_group_name: str, name: str, **kwargs: Any) → Iterable[MHSMPrivateEndpointConnection]

The List operation gets information about the private endpoint connections associated with the managed HSM Pool.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• name (str) – Name of the managed HSM Pool. Required.

Returns:

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

Return type:

ItemPaged[MHSMPrivateEndpointConnection]

Raises:

HttpResponseError –

put(resource_group_name: str, name: str, private_endpoint_connection_name: str, properties: MHSMPrivateEndpointConnection | IO[bytes], **kwargs: Any) → MHSMPrivateEndpointConnection

Updates the specified private endpoint connection associated with the managed hsm pool.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• name (str) – Name of the managed HSM Pool. Required.

• private_endpoint_connection_name (str) – Name of the private endpoint connection associated with the managed hsm pool. Required.

• properties (MHSMPrivateEndpointConnection or IO[bytes]) – The intended state of private endpoint connection. Is either a MHSMPrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

MHSMPrivateEndpointConnection or the result of cls(response)

Return type:

MHSMPrivateEndpointConnection

Raises:

HttpResponseError –

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

class azure.mgmt.keyvault.v2023_02_01.operations.MHSMPrivateLinkResourcesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list_by_mhsm_resource(resource_group_name: str, name: str, **kwargs: Any) → MHSMPrivateLinkResourceListResult

Gets the private link resources supported for the managed hsm pool.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• name (str) – Name of the managed HSM Pool. Required.

Returns:

MHSMPrivateLinkResourceListResult or the result of cls(response)

Return type:

MHSMPrivateLinkResourceListResult

Raises:

HttpResponseError –

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

class azure.mgmt.keyvault.v2023_02_01.operations.MHSMRegionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list_by_resource(resource_group_name: str, name: str, **kwargs: Any) → Iterable[MHSMGeoReplicatedRegion]

The List operation gets information about the regions associated with the managed HSM Pool.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• name (str) – Name of the managed HSM Pool. Required.

Returns:

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

Return type:

ItemPaged[MHSMGeoReplicatedRegion]

Raises:

HttpResponseError –

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

class azure.mgmt.keyvault.v2023_02_01.operations.ManagedHsmKeysOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create_if_not_exist(resource_group_name: str, name: str, key_name: str, parameters: ManagedHsmKeyCreateParameters | IO[bytes], **kwargs: Any) → ManagedHsmKey

Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• name (str) – The name of the Managed HSM Pool within the specified resource group. Required.

• key_name (str) – The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information. Required.

• parameters (ManagedHsmKeyCreateParameters or IO[bytes]) – The parameters used to create the specified key. Is either a ManagedHsmKeyCreateParameters type or a IO[bytes] type. Required.

Returns:

ManagedHsmKey or the result of cls(response)

Return type:

ManagedHsmKey

Raises:

HttpResponseError –

get(resource_group_name: str, name: str, key_name: str, **kwargs: Any) → ManagedHsmKey

Gets the current version of the specified key from the specified managed HSM.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• name (str) – The name of the Managed HSM Pool within the specified resource group. Required.

• key_name (str) – The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information. Required.

Returns:

ManagedHsmKey or the result of cls(response)

Return type:

ManagedHsmKey

Raises:

HttpResponseError –

get_version(resource_group_name: str, name: str, key_name: str, key_version: str, **kwargs: Any) → ManagedHsmKey

Gets the specified version of the specified key in the specified managed HSM.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• name (str) – The name of the Managed HSM Pool within the specified resource group. Required.

• key_name (str) – The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information. Required.

• key_version (str) – The version of the key to be retrieved. Required.

Returns:

ManagedHsmKey or the result of cls(response)

Return type:

ManagedHsmKey

Raises:

HttpResponseError –

list(resource_group_name: str, name: str, **kwargs: Any) → Iterable[ManagedHsmKey]

Lists the keys in the specified managed HSM.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• name (str) – The name of the Managed HSM Pool within the specified resource group. Required.

Returns:

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

Return type:

ItemPaged[ManagedHsmKey]

Raises:

HttpResponseError –

list_versions(resource_group_name: str, name: str, key_name: str, **kwargs: Any) → Iterable[ManagedHsmKey]

Lists the versions of the specified key in the specified managed HSM.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• name (str) – The name of the Managed HSM Pool within the specified resource group. Required.

• key_name (str) – The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information. Required.

Returns:

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

Return type:

ItemPaged[ManagedHsmKey]

Raises:

HttpResponseError –

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

class azure.mgmt.keyvault.v2023_02_01.operations.ManagedHsmsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_create_or_update(resource_group_name: str, name: str, parameters: ManagedHsm | IO[bytes], **kwargs: Any) → LROPoller[ManagedHsm]

Create or update a managed HSM Pool in the specified subscription.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• name (str) – Name of the managed HSM Pool. Required.

• parameters (ManagedHsm or IO[bytes]) – Parameters to create or update the managed HSM Pool. Is either a ManagedHsm type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[ManagedHsm]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, name: str, **kwargs: Any) → LROPoller[None]

Deletes the specified managed HSM Pool.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• name (str) – The name of the managed HSM Pool to delete. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_purge_deleted(name: str, location: str, **kwargs: Any) → LROPoller[None]

Permanently deletes the specified managed HSM.

Parameters:

• name (str) – The name of the soft-deleted managed HSM. Required.

• location (str) – The location of the soft-deleted managed HSM. 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, name: str, parameters: ManagedHsm | IO[bytes], **kwargs: Any) → LROPoller[ManagedHsm]

Update a managed HSM Pool in the specified subscription.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• name (str) – Name of the managed HSM Pool. Required.

• parameters (ManagedHsm or IO[bytes]) – Parameters to patch the managed HSM Pool. Is either a ManagedHsm type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[ManagedHsm]

Raises:

HttpResponseError –

check_mhsm_name_availability(mhsm_name: CheckMhsmNameAvailabilityParameters | IO[bytes], **kwargs: Any) → CheckMhsmNameAvailabilityResult

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

Parameters:

mhsm_name (CheckMhsmNameAvailabilityParameters or IO[bytes]) – The name of the managed hsm. Is either a CheckMhsmNameAvailabilityParameters type or a IO[bytes] type. Required.

Returns:

CheckMhsmNameAvailabilityResult or the result of cls(response)

Return type:

CheckMhsmNameAvailabilityResult

Raises:

HttpResponseError –

get(resource_group_name: str, name: str, **kwargs: Any) → ManagedHsm | None

Gets the specified managed HSM Pool.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• name (str) – The name of the managed HSM Pool. Required.

Returns:

ManagedHsm or None or the result of cls(response)

Return type:

ManagedHsm or None

Raises:

HttpResponseError –

get_deleted(name: str, location: str, **kwargs: Any) → DeletedManagedHsm

Gets the specified deleted managed HSM.

Parameters:

• name (str) – The name of the deleted managed HSM. Required.

• location (str) – The location of the deleted managed HSM. Required.

Returns:

DeletedManagedHsm or the result of cls(response)

Return type:

DeletedManagedHsm

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, top: int | None = None, **kwargs: Any) → Iterable[ManagedHsm]

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

Parameters:

• resource_group_name (str) – Name of the resource group that contains the managed HSM pool. Required.

• top (int) – Maximum number of results to return. Default value is None.

Returns:

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

Return type:

ItemPaged[ManagedHsm]

Raises:

HttpResponseError –

list_by_subscription(top: int | None = None, **kwargs: Any) → Iterable[ManagedHsm]

The List operation gets information about the managed HSM Pools associated with the subscription.

Parameters:

top (int) – Maximum number of results to return. Default value is None.

Returns:

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

Return type:

ItemPaged[ManagedHsm]

Raises:

HttpResponseError –

list_deleted(**kwargs: Any) → Iterable[DeletedManagedHsm]

The List operation gets information about the deleted managed HSMs associated with the subscription.

Returns:

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

Return type:

ItemPaged[DeletedManagedHsm]

Raises:

HttpResponseError –

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

class azure.mgmt.keyvault.v2023_02_01.operations.Operations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list(**kwargs: Any) → Iterable[Operation]

Lists all of the available Key Vault Rest API operations.

Returns:

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

Return type:

ItemPaged[Operation]

Raises:

HttpResponseError –

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

class azure.mgmt.keyvault.v2023_02_01.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_delete(resource_group_name: str, vault_name: str, private_endpoint_connection_name: str, **kwargs: Any) → LROPoller[PrivateEndpointConnection]

Deletes the specified private endpoint connection associated with the key vault.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the key vault. Required.

• vault_name (str) – The name of the key vault. Required.

• private_endpoint_connection_name (str) – Name of the private endpoint connection associated with the key vault. Required.

Returns:

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

Return type:

LROPoller[PrivateEndpointConnection]

Raises:

HttpResponseError –

get(resource_group_name: str, vault_name: str, private_endpoint_connection_name: str, **kwargs: Any) → PrivateEndpointConnection | None

Gets the specified private endpoint connection associated with the key vault.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the key vault. Required.

• vault_name (str) – The name of the key vault. Required.

• private_endpoint_connection_name (str) – Name of the private endpoint connection associated with the key vault. Required.

Returns:

PrivateEndpointConnection or None or the result of cls(response)

Return type:

PrivateEndpointConnection or None

Raises:

HttpResponseError –

list_by_resource(resource_group_name: str, vault_name: str, **kwargs: Any) → Iterable[PrivateEndpointConnection]

The List operation gets information about the private endpoint connections associated with the vault.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the key vault. Required.

• vault_name (str) – The name of the key vault. Required.

Returns:

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

Return type:

ItemPaged[PrivateEndpointConnection]

Raises:

HttpResponseError –

put(resource_group_name: str, vault_name: str, private_endpoint_connection_name: str, properties: PrivateEndpointConnection | IO[bytes], **kwargs: Any) → PrivateEndpointConnection

Updates the specified private endpoint connection associated with the key vault.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the key vault. Required.

• vault_name (str) – The name of the key vault. Required.

• private_endpoint_connection_name (str) – Name of the private endpoint connection associated with the key vault. Required.

• properties (PrivateEndpointConnection or IO[bytes]) – The intended state of private endpoint connection. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

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

class azure.mgmt.keyvault.v2023_02_01.operations.PrivateLinkResourcesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list_by_vault(resource_group_name: str, vault_name: str, **kwargs: Any) → PrivateLinkResourceListResult

Gets the private link resources supported for the key vault.

Parameters:

• resource_group_name (str) – Name of the resource group that contains the key vault. Required.

• vault_name (str) – The name of the key vault. Required.

Returns:

PrivateLinkResourceListResult or the result of cls(response)

Return type:

PrivateLinkResourceListResult

Raises:

HttpResponseError –

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

class azure.mgmt.keyvault.v2023_02_01.operations.SecretsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create_or_update(resource_group_name: str, vault_name: str, secret_name: str, parameters: SecretCreateOrUpdateParameters | IO[bytes], **kwargs: Any) → Secret

Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

• resource_group_name (str) – The name of the Resource Group to which the vault belongs. Required.

• vault_name (str) – Name of the vault. Required.

• secret_name (str) – Name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information. Required.

• parameters (SecretCreateOrUpdateParameters or IO[bytes]) – Parameters to create or update the secret. Is either a SecretCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

Secret or the result of cls(response)

Return type:

Secret

Raises:

HttpResponseError –

get(resource_group_name: str, vault_name: str, secret_name: str, **kwargs: Any) → Secret

Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

• resource_group_name (str) – The name of the Resource Group to which the vault belongs. Required.

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

• secret_name (str) – The name of the secret. Required.

Returns:

Secret or the result of cls(response)

Return type:

Secret

Raises:

HttpResponseError –

list(resource_group_name: str, vault_name: str, top: int | None = None, **kwargs: Any) → Iterable[Secret]

The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

• resource_group_name (str) – The name of the Resource Group to which the vault belongs. Required.

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

• top (int) – Maximum number of results to return. Default value is None.

Returns:

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

Return type:

ItemPaged[Secret]

Raises:

HttpResponseError –

update(resource_group_name: str, vault_name: str, secret_name: str, parameters: SecretPatchParameters | IO[bytes], **kwargs: Any) → Secret

Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

• resource_group_name (str) – The name of the Resource Group to which the vault belongs. Required.

• vault_name (str) – Name of the vault. Required.

• secret_name (str) – Name of the secret. Required.

• parameters (SecretPatchParameters or IO[bytes]) – Parameters to patch the secret. Is either a SecretPatchParameters type or a IO[bytes] type. Required.

Returns:

Secret or the result of cls(response)

Return type:

Secret

Raises:

HttpResponseError –

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

class azure.mgmt.keyvault.v2023_02_01.operations.VaultsOperations(*args, **kwargs)

Bases: VaultsOperations

list(top: int | None = None, **kwargs: Any) → Iterable[Resource]

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

Parameters:

top (int) – Maximum number of results to return. Default value is None.

Returns:

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

Return type:

ItemPaged[Resource]

Raises:

HttpResponseError –