.. role:: raw-html-m2r(raw) :format: html Azure Key Vault Certificates client library for Python ====================================================== Azure Key Vault helps solve the following problems: * Certificate management (this library) - create, manage, and deploy public and private SSL/TLS certificates * Cryptographic key management (\ `azure-keyvault-keys `_\ ) - create, store, and control access to the keys used to encrypt your data * Secrets management (\ `azure-keyvault-secrets `_\ ) - securely store and control access to tokens, passwords, certificates, API keys, and other secrets * Vault administration (\ `azure-keyvault-administration `_\ ) - role-based access control (RBAC), and vault-level backup and restore options `Source code `_ | `Package (PyPI) `_ | `API reference documentation `_ | `Product documentation `_ | `Samples `_ *Disclaimer* ---------------- *Azure SDK Python packages support for Python 2.7 is ending 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691* Getting started --------------- Install the package ^^^^^^^^^^^^^^^^^^^ Install `azure-keyvault-certificates `_ and `azure-identity `_ with `pip `_\ : .. code-block:: Bash pip install azure-keyvault-certificates azure-identity `azure-identity `_ is used for Azure Active Directory authentication as demonstrated below. Prerequisites ^^^^^^^^^^^^^ * An `Azure subscription `_ * Python 2.7, 3.5.3, or later * A Key Vault. If you need to create one, you can use the `Azure Cloud Shell `_ to create one with these commands (replace ``"my-resource-group"`` and ``"my-key-vault"`` with your own, unique names): (Optional) if you want a new resource group to hold the Key Vault: .. code-block:: sh az group create --name my-resource-group --location westus2 Create the Key Vault: .. code-block:: Bash az keyvault create --resource-group my-resource-group --name my-key-vault Output: .. code-block:: json { "id": "...", "location": "westus2", "name": "my-key-vault", "properties": { "accessPolicies": [...], "createMode": null, "enablePurgeProtection": null, "enableSoftDelete": null, "enabledForDeployment": false, "enabledForDiskEncryption": null, "enabledForTemplateDeployment": null, "networkAcls": null, "provisioningState": "Succeeded", "sku": { "name": "standard" }, "tenantId": "...", "vaultUri": "https://my-key-vault.vault.azure.net/" }, "resourceGroup": "my-resource-group", "type": "Microsoft.KeyVault/vaults" } .. The ``"vaultUri"`` property is the ``vault_url`` used by `CertificateClient `_ Authenticate the client ^^^^^^^^^^^^^^^^^^^^^^^ This document demonstrates using `DefaultAzureCredential `_ to authenticate as a service principal. However, `CertificateClient `_ accepts any `azure-identity `_ credential. See the `azure-identity `_ documentation for more information about other credentials. Create a service principal (optional) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This `Azure Cloud Shell `_ snippet shows how to create a new service principal. Before using it, replace "your-application-name" with a more appropriate name for your service principal. Create a service principal: .. code-block:: Bash az ad sp create-for-rbac --name http://my-application --skip-assignment .. Output: .. code-block:: json { "appId": "generated app id", "displayName": "my-application", "name": "http://my-application", "password": "random password", "tenant": "tenant id" } Use the output to set **AZURE_CLIENT_ID** ("appId" above), **AZURE_CLIENT_SECRET** ("password" above) and **AZURE_TENANT_ID** ("tenant" above) environment variables. The following example shows a way to do this in Bash: .. code-block:: Bash export AZURE_CLIENT_ID="generated app id" export AZURE_CLIENT_SECRET="random password" export AZURE_TENANT_ID="tenant id" Authorize the service principal to perform certificate operations in your Key Vault: .. code-block:: Bash az keyvault set-policy --name my-key-vault --spn $AZURE_CLIENT_ID --certificate-permissions backup create delete get import list purge recover restore update .. Possible certificate permissions: backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update If you have enabled role-based access control (RBAC) for Key Vault instead, you can find roles like "Key Vault Certificates Officer" in our `RBAC guide `_. Create a client ~~~~~~~~~~~~~~~ Once the **AZURE_CLIENT_ID**\ , **AZURE_CLIENT_SECRET** and **AZURE_TENANT_ID** environment variables are set, `DefaultAzureCredential `_ will be able to authenticate the `CertificateClient `_. Constructing the client also requires your vault's URL, which you can get from the Azure CLI or the Azure Portal. In the Azure Portal, this URL is the vault's "DNS Name". .. code-block:: python from azure.identity import DefaultAzureCredential from azure.keyvault.certificates import CertificateClient credential = DefaultAzureCredential() certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) Key concepts ------------ Certificate Client ^^^^^^^^^^^^^^^^^^ With a `CertificateClient `_ you can get certificates from the vault, create new certificates and new versions of existing certificates, update certificate metadata, and delete certificates. You can also manage certificate issuers, contacts, and management policies of certificates. This is illustrated in the `examples <#examples>`_ below. Examples -------- This section contains code snippets covering common tasks: * :raw-html-m2r:`Create a Certificate` * :raw-html-m2r:`Retrieve a Certificate` * :raw-html-m2r:`Update Properties of an existing Certificate` * :raw-html-m2r:`Delete a Certificate` * :raw-html-m2r:`List Properites of Certificates` * :raw-html-m2r:`Asynchronously create a Certificate` * :raw-html-m2r:`Asynchronously list properties of Certificates` Create a Certificate ^^^^^^^^^^^^^^^^^^^^ `begin_create_certificate `_ creates a certificate to be stored in the Azure Key Vault. If a certificate with the same name already exists, a new version of the certificate is created. Before creating a certificate, a management policy for the certificate can be created or our default policy will be used. This method returns a long running operation poller. .. code-block:: python from azure.identity import DefaultAzureCredential from azure.keyvault.certificates import CertificateClient, CertificatePolicy credential = DefaultAzureCredential() certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) create_certificate_poller = certificate_client.begin_create_certificate( certificate_name="cert-name", policy=CertificatePolicy.get_default() ) print(create_certificate_poller.result()) If you would like to check the status of your certificate creation, you can call ``status()`` on the poller or `get_certificate_operation `_ with the name of the certificate. Retrieve a Certificate ^^^^^^^^^^^^^^^^^^^^^^ `get_certificate `_ retrieves the latest version of a certificate previously stored in the Key Vault. .. code-block:: python from azure.identity import DefaultAzureCredential from azure.keyvault.certificates import CertificateClient credential = DefaultAzureCredential() certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) certificate = certificate_client.get_certificate("cert-name") print(certificate.name) print(certificate.properties.version) print(certificate.policy.issuer_name) `get_certificate_version `_ retrieves a specific version of a certificate. .. code-block:: python from azure.identity import DefaultAzureCredential from azure.keyvault.certificates import CertificateClient credential = DefaultAzureCredential() certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) certificate = certificate_client.get_certificate_version(certificate_name="cert-name", version="cert-version") print(certificate.name) print(certificate.properties.version) Update properties of an existing Certificate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `update_certificate_properties `_ updates a certificate previously stored in the Key Vault. .. code-block:: python from azure.identity import DefaultAzureCredential from azure.keyvault.certificates import CertificateClient credential = DefaultAzureCredential() certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) # we will now disable the certificate for further use updated_certificate= certificate_client.update_certificate_properties( certificate_name="cert-name", enabled=False ) print(updated_certificate.name) print(updated_certificate.properties.enabled) Delete a Certificate ^^^^^^^^^^^^^^^^^^^^ `begin_delete_certificate `_ requests Key Vault delete a certificate, returning a poller which allows you to wait for the deletion to finish. Waiting is helpful when the vault has `soft-delete `_ enabled, and you want to purge (permanently delete) the certificate as soon as possible. When `soft-delete `_ is disabled, ``begin_delete_certificate`` itself is permanent. .. code-block:: python from azure.identity import DefaultAzureCredential from azure.keyvault.certificates import CertificateClient credential = DefaultAzureCredential() certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) deleted_certificate_poller = certificate_client.begin_delete_certificate("cert-name") deleted_certificate = deleted_certificate_poller.result() print(deleted_certificate.name) print(deleted_certificate.deleted_on) List properties of Certificates ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `list_properties_of_certificates `_ lists the properties of all certificates in the specified Key Vault. .. code-block:: python from azure.identity import DefaultAzureCredential from azure.keyvault.certificates import CertificateClient credential = DefaultAzureCredential() certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) certificates = certificate_client.list_properties_of_certificates() for certificate in certificates: # this list doesn't include versions of the certificates print(certificate.name) Async operations ^^^^^^^^^^^^^^^^ This library includes a complete async API supported on Python 3.5+. To use it, you must first install an async transport, such as `aiohttp `_. See `azure-core documentation `_ for more information. Async clients and credentials should be closed when they're no longer needed. These objects are async context managers and define async ``close`` methods. For example: .. code-block:: py from azure.identity.aio import DefaultAzureCredential from azure.keyvault.certificates.aio import CertificateClient credential = DefaultAzureCredential() # call close when the client and credential are no longer needed client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) ... await client.close() await credential.close() # alternatively, use them as async context managers (contextlib.AsyncExitStack can help) client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) async with client: async with credential: ... Asynchronously create a Certificate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `create_certificate `_ creates a certificate to be stored in the Azure Key Vault. If a certificate with the same name already exists, a new version of the certificate is created. Before creating a certificate, a management policy for the certificate can be created or our default policy will be used. Awaiting ``create_certificate`` returns your created certificate if creation is successful, and a `CertificateOperation `_ if it is not. .. code-block:: python from azure.identity.aio import DefaultAzureCredential from azure.keyvault.certificates.aio import CertificateClient from azure.keyvault.certificates import CertificatePolicy credential = DefaultAzureCredential() certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) create_certificate_result = await certificate_client.create_certificate( certificate_name="cert-name", policy=CertificatePolicy.get_default() ) print(create_certificate_result) Asynchronously list properties of Certificates ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `list_properties_of_certificates `_ lists all the properties of the certificates in the client's vault: .. code-block:: python from azure.identity.aio import DefaultAzureCredential from azure.keyvault.certificates.aio import CertificateClient credential = DefaultAzureCredential() certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) certificates = certificate_client.list_properties_of_certificates() async for certificate in certificates: print(certificate.name) Troubleshooting --------------- General ^^^^^^^ Key Vault clients raise exceptions defined in `azure-core `_. For example, if you try to get a key that doesn't exist in the vault, `CertificateClient `_ raises `ResourceNotFoundError `_\ : .. code-block:: python from azure.identity import DefaultAzureCredential from azure.keyvault.certificates import CertificateClient from azure.core.exceptions import ResourceNotFoundError credential = DefaultAzureCredential() certificate_client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential) try: certificate_client.get_certificate("which-does-not-exist") except ResourceNotFoundError as e: print(e.message) Logging ^^^^^^^ This library uses the standard `logging `_ library for logging. Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO level. Detailed DEBUG level logging, including request/response bodies and unredacted headers, can be enabled on a client with the ``logging_enable`` argument: .. code-block:: py from azure.identity import DefaultAzureCredential from azure.keyvault.certificates import CertificateClient import sys import logging # Create a logger for the 'azure' SDK logger = logging.getLogger('azure') logger.setLevel(logging.DEBUG) # Configure a console output handler = logging.StreamHandler(stream=sys.stdout) logger.addHandler(handler) credential = DefaultAzureCredential() # This client will log detailed information about its HTTP sessions, at DEBUG level client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential, logging_enable=True) Network trace logging can also be enabled for any single operation: .. code-block:: python certificate = certificate_client.get_certificate(certificate_name="cert-name", logging_enable=True) Next steps ---------- Several samples are available in the Azure SDK for Python GitHub repository. These samples provide example code for additional Key Vault scenarios: * `hello_world.py `_ and `hello_world_async.py `_ - create/get/update/delete certificates * `backup_restore_operations.py `_ and `backup_restore_operations_async.py `_ - backup and recover certificates * `list_operations.py `_ and `list_operations_async.py `_ - list certificates * `recover_purge_operations.py `_ and `recover_purge_operations_async.py `_ - recover and purge certificates * `issuers.py `_ and `issuers_async.py `_ - manage certificate issuers * `contacts.py `_ and `contacts_async.py `_ - manage certificate contacts Additional Documentation ^^^^^^^^^^^^^^^^^^^^^^^^ For more extensive documentation on Azure Key Vault, see the `API reference documentation `_. Contributing ------------ This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. This project has adopted the `Microsoft Open Source Code of Conduct `_. For more information, see the `Code of Conduct FAQ `_ or contact opencode@microsoft.com with any additional questions or comments. .. image:: https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fkeyvault%2Fazure-keyvault-certificates%2FREADME.png :target: https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fkeyvault%2Fazure-keyvault-certificates%2FREADME.png :alt: Impressions Indices and tables ------------------ * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. toctree:: :maxdepth: 5 :glob: :caption: Developer Documentation azure.keyvault.certificates.rst