KeyVaultManagementClient Class

The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Constructor

KeyVaultManagementClient(credential: AsyncTokenCredential, subscription_id: str, api_version: str | None = None, base_url: str = 'https://management.azure.com', profile: KnownProfiles = KnownProfiles.default, **kwargs: Any)

Parameters

Name	Description
credential Required	AsyncTokenCredential Credential needed for the client to connect to Azure. Required.
subscription_id Required	str Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. Required.
api_version	str API version to use if no profile is provided, or if missing in profile. Default value: None
base_url	str Service URL Default value: https://management.azure.com
profile	KnownProfiles A profile definition, from KnownProfiles to dict. Default value: KnownProfiles.default

Keyword-Only Parameters

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

Methods

close
models	Module depends on the API version: 2016-10-01: models 2023-02-01: models 2024-11-01: models

close

async close()

models

Module depends on the API version:

• 2016-10-01: models

• 2023-02-01: models

• 2024-11-01: models

models(api_version='2024-11-01')

Parameters

Name	Description
api_version	Default value: 2024-11-01

Attributes

keys

Instance depends on the API version:

• 2023-02-01: KeysOperations

• 2024-11-01: KeysOperations

managed_hsm_keys

Instance depends on the API version:

• 2023-02-01: ManagedHsmKeysOperations

• 2024-11-01: ManagedHsmKeysOperations

managed_hsms

Instance depends on the API version:

• 2023-02-01: ManagedHsmsOperations

• 2024-11-01: ManagedHsmsOperations

mhsm_private_endpoint_connections

Instance depends on the API version:

• 2023-02-01: MHSMPrivateEndpointConnectionsOperations

• 2024-11-01: MHSMPrivateEndpointConnectionsOperations

mhsm_private_link_resources

Instance depends on the API version:

• 2023-02-01: MHSMPrivateLinkResourcesOperations

• 2024-11-01: MHSMPrivateLinkResourcesOperations

mhsm_regions

Instance depends on the API version:

• 2023-02-01: MHSMRegionsOperations

• 2024-11-01: MHSMRegionsOperations

operations

Instance depends on the API version:

• 2016-10-01: Operations

• 2023-02-01: Operations

• 2024-11-01: Operations

private_endpoint_connections

Instance depends on the API version:

• 2023-02-01: PrivateEndpointConnectionsOperations

• 2024-11-01: PrivateEndpointConnectionsOperations

private_link_resources

Instance depends on the API version:

• 2023-02-01: PrivateLinkResourcesOperations

• 2024-11-01: PrivateLinkResourcesOperations

secrets

Instance depends on the API version:

• 2023-02-01: SecretsOperations

• 2024-11-01: SecretsOperations

vaults

Instance depends on the API version:

• 2016-10-01: VaultsOperations

• 2023-02-01: VaultsOperations

• 2024-11-01: VaultsOperations

DEFAULT_API_VERSION

DEFAULT_API_VERSION = '2024-11-01'

LATEST_PROFILE

LATEST_PROFILE = azure.mgmt.keyvault.KeyVaultManagementClient latest