Package: azure-mgmt-keyvault
Microsoft Azure SDK for PythonThis is the Microsoft Azure Key Vault Management Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see theazure sdk python release.DisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691Getting startedPrerequisitesPython 3.7+ is required to use this package.Azure subscriptionInstall the packagepipinstallazure-mgmt-keyvault
pipinstallazure-identityAuthenticationBy default,Azure Active Directorytoken authentication depends on correct configure of following environment variables.AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETfor Azure client secret.In addition, Azure subscription ID can be configured via environment variableAZURE_SUBSCRIPTION_ID.With above configuration, client can be authenticated by following code:fromazure.identityimportDefaultAzureCredentialfromazure.mgmt.keyvaultimportKeyVaultManagementClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=KeyVaultManagementClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search Key Vault Managementon docs.microsoft.comAzure Python Mgmt SDK Samples RepoTroubleshootingNext stepsProvide FeedbackIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History10.3.0 (2023-10-23)Features AddedModel MHSMPrivateEndpointConnection has a new parameter identityModel MHSMPrivateLinkResource has a new parameter identityModel ManagedHsm has a new parameter identityModel ManagedHsmResource has a new parameter identity10.2.3 (2023-07-25)Bugs FixedDo not use configured api_version to relpace the value in nextLink forVaultsOperation.list10.2.2 (2023-05-24)Other ChangesAdded default value back for model Sku.family to avoid breaking10.2.1 (2023-04-03)Bugs FixedSeal enum which has single value as constant by default to avoid breaking change10.2.0 (2023-03-13)Features AddedAdded operation group MHSMRegionsOperationsAdded operation group ManagedHsmKeysOperationsModel ManagedHsmProperties has a new parameter regionsModel ManagedHsmProperties has a new parameter security_domain_properties10.2.0b1 (2023-02-14)Features AddedModel ManagedHsmProperties has a new parameter security_domain_properties10.1.0 (2022-08-10)Features AddedAdded operation ManagedHsmsOperations.check_mhsm_name_availabilityModel Key has a new parameter release_policyModel Key has a new parameter rotation_policyModel KeyProperties has a new parameter release_policyModel KeyProperties has a new parameter rotation_policyModel MHSMPrivateEndpointConnectionItem has a new parameter etagModel MHSMPrivateEndpointConnectionItem has a new parameter idOther ChangesPython 3.6 is no longer supported. Please use Python version 3.7 or later.10.0.0 (2022-05-24)Breaking changesModel Key no longer has parameter release_policyModel Key no longer has parameter rotation_policyModel KeyProperties no longer has parameter release_policyModel KeyProperties no longer has parameter rotation_policy9.3.0 (2021-11-11)FeaturesAdded some enum value9.2.0 (2021-10-15)FeaturesModel VaultProperties has a new parameter public_network_accessModel VaultPatchProperties has a new parameter public_network_accessModel KeyAttributes has a new parameter exportableModel Key has a new parameter release_policyModel Key has a new parameter rotation_policyModel KeyProperties has a new parameter release_policyModel KeyProperties has a new parameter rotation_policy9.1.0 (2021-08-26)FeaturesModel VirtualNetworkRule has a new parameter ignore_missing_vnet_service_endpointModel VaultProperties has a new parameter hsm_pool_resource_idModel PrivateEndpointConnectionItem has a new parameter etagModel PrivateEndpointConnectionItem has a new parameter idModel ServiceSpecification has a new parameter metric_specifications9.0.0 (2021-04-19)FeaturesModel DeletedVaultProperties has a new parameter purge_protection_enabledModel Operation has a new parameter is_data_actionModel Vault has a new parameter system_dataModel ManagedHsmProperties has a new parameter scheduled_purge_dateModel ManagedHsmProperties has a new parameter public_network_accessModel ManagedHsmProperties has a new parameter network_aclsModel ManagedHsmProperties has a new parameter private_endpoint_connectionsModel VaultProperties has a new parameter provisioning_stateModel PrivateLinkServiceConnectionState has a new parameter actions_requiredModel ManagedHsmResource has a new parameter system_dataModel ManagedHsm has a new parameter system_dataModel PrivateEndpointConnection has a new parameter etagAdded operation ManagedHsmsOperations.get_deletedAdded operation ManagedHsmsOperations.list_deletedAdded operation ManagedHsmsOperations.begin_purge_deletedAdded operation PrivateEndpointConnectionsOperations.list_by_resourceAdded operation group SecretsOperationsAdded operation group MHSMPrivateLinkResourcesOperationsAdded operation group KeysOperationsAdded operation group MHSMPrivateEndpointConnectionsOperationsBreaking changesModel PrivateLinkServiceConnectionState no longer has parameter action_required8.0.0 (2020-09-29)FeaturesModel ManagedHsmProperties has a new parameter hsm_uriBreaking changesModel ManagedHsmProperties no longer has parameter hsm_pool_uri7.0.0 (2020-09-15)Release as a stable version7.0.0b3 (2020-09-09)FeaturesAdded operation group ManagedHsmsOperations7.0.0b2 (2020-07-21)BugfixesUse service api_version "2015-11-01" instead of "2016-10-01".7.0.0b1 (2020-06-17)This is beta preview version.
For detailed changelog please refer to equivalent stable version 2.2.0 (https://pypi.org/project/azure-mgmt-keyvault/2.2.0/)This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).General breaking changesCredential system has been completly revamped:azure.common.credentialsormsrestazure.azure_active_directoryinstances are no longer supported, use theazure-identityclasses instead:https://pypi.org/project/azure-identity/credentialsparameter has been renamedcredentialTheconfigattribute no longer exists on a client, configuration should be passed as kwarg. Example:MyClient(credential, subscription_id, enable_logging=True). For a complete set of
supported options, see theparameters accept in init documentation of azure-coreYou can't import aversionmodule anymore, use__version__insteadOperations that used to return amsrest.polling.LROPollernow returns aazure.core.polling.LROPollerand are prefixed withbegin_.Exceptions tree have been simplified and most exceptions are nowazure.core.exceptions.HttpResponseError(CloudErrorhas been removed).Most of the operation kwarg have changed. Some of the most noticeable:rawhas been removed. Equivalent feature can be found usingcls, a callback that will give access to internal HTTP response for advanced userFor a complete set of
supported options, see theparameters accept in Request documentation of azure-coreGeneral new featuresType annotations support usingtyping. SDKs are mypy ready.This client has now stable and official support for async. Check theaionamespace of your package to find the async client.This client now support natively tracing library like OpenCensus or OpenTelemetry. See thistracing quickstartfor an overview.2.2.0 (2020-03-20)FeaturesModel VaultProperties has a new parameter enable_rbac_authorizationModel VaultProperties has a new parameter soft_delete_retention_in_daysModel VaultPatchProperties has a new parameter enable_rbac_authorizationModel VaultPatchProperties has a new parameter soft_delete_retention_in_days2.1.1 (2020-02-07)BugfixesFixed multi-API client issues2.1.0 (2020-01-30)FeaturesModel VaultProperties has a new parameter private_endpoint_connectionsAdded operation group PrivateEndpointConnectionsOperationsAdded operation group PrivateLinkResourcesOperations2.0.0 (2019-06-18)General Breaking changesThis version uses a next-generation code generator thatmightintroduce breaking changes if you were importing from the v20xx_yy_zz
API folders. In summary, some modules were incorrectly
visible/importable and have been renamed. This fixed several issues
caused by usage of classes that were not supposed to be used in the
first place.KeyVaultManagementClient cannot be imported fromazure.mgmt.key_vault.v20xx_yy_zz.key_vault_management_clientanymore (import fromazure.mgmt.key_vault.v20xx_yy_zzworks
like before)KeyVaultManagementClientConfiguration import has been moved fromazure.mgmt.key_vault.v20xx_yy_zz.key_vault_management_clienttoazure.mgmt.key_vault.v20xx_yy_zzA modelMyClassfrom a "models" sub-module cannot be imported
anymore usingazure.mgmt.key_vault.v20xx_yy_zz.models.my_class(import
fromazure.mgmt.key_vault.v20xx_yy_zz.modelsworks like
before)An operation classMyClassOperationsfrom anoperationssub-module cannot be imported anymore usingazure.mgmt.key_vault.v20xx_yy_zz.operations.my_class_operations(import fromazure.mgmt.key_vault.v20xx_yy_zz.operationsworks like before)Last but not least, HTTP connection pooling is now enabled by default.
You should always use a client as a context manager, or call close(), or
use no more than one client per process.1.1.0 (2018-08-07)Adding support for multi-api and API profiles1.0.0 (2018-06-27)Moving azure-mgmt-keyvault to stable API version 2018-02-141.0.0b1 (2018-04-10)Upgraded to autorest 3.0 generated codeGeneral Breaking changesThis version uses a next-generation code generator thatmightintroduce breaking changes.Model signatures now use only keyword-argument syntax. All
positional arguments must be re-written as keyword-arguments. To
keep auto-completion in most cases, models are now generated for
Python 2 and Python 3. Python 3 uses the "*" syntax for
keyword-only arguments.Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
improve the behavior when unrecognized enum values are encountered.
While this is not a breaking change, the distinctions are important,
and are documented here:https://docs.python.org/3/library/enum.html#othersAt a glance:"is" should not be used at all."format" will return the string value, where "%s" string
formatting will returnNameOfEnum.stringvalue. Format syntax
should be prefered.New Long Running Operation:Return type changes frommsrestazure.azure_operation.AzureOperationPollertomsrest.polling.LROPoller. External API is the same.Return type is nowalwaysamsrest.polling.LROPoller,
regardless of the optional parameters used.The behavior has changed when usingraw=True. Instead of
returning the initial call result asClientRawResponse,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as aClientRawResponse.Newpollingparameter. The default behavior isPolling=Truewhich will poll using ARM algorithm. WhenPolling=False, the response of the initial call will be
returned without polling.pollingparameter accepts instances of subclasses ofmsrest.polling.PollingMethod.add_done_callbackwill no longer raise if called after
polling is finished, but will instead execute the callback right
away.1.0.0a2 (2018-03-28)Upgrading to API version 2018-02-14-previewBreaking change in vault create_or_update now returns a
'LROPoller' objects rather than the Vault, to allow callers to
determine when the vault is ready to accept traffic. Callers should
use the result() method to block until the vault is accessible.Adding network_acls vault property for limiting network access to a
vaultAdding managed storage account key backup, restore and soft delete
supportAdding vault property enable_purge_protection for enhance
protection against vault deletion0.40.0 (2017-06-06)upgrading to API version 2016-10-01adding keyvault management plane updates to enable the soft delete
feature for a new or existing keyvaultNotesthis contains a backwards breaking change removing the All value
from KeyPermissions, SecretPermissions and CertificatePermissions0.31.0 (2017-04-19)BugfixesFix possible deserialization error, but updating from
list to list when applicableNotesThis wheel package is now built with the azure wheel extension0.30.1 (2016-12-15)Fix list Vault by subscription method return type0.30.0 (2016-10-04)Initial preview release (API Version 2016-10-02)