.. role:: raw-html-m2r(raw)
   :format: html


Azure Key Vault Secret client library for Python
================================================

Azure Key Vault helps solve the following problems:


* Secrets management (this library) -
  securely store and control access to tokens, passwords, certificates, API keys,
  and other secrets
* Cryptographic key management
  (\ `azure-keyvault-keys <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets>`_\ ) -
  create, store, and control access to the keys used to encrypt your data
* Certificate management
  (\ `azure-keyvault-certificates <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-certificates>`_\ ) -
  create, manage, and deploy public and private SSL/TLS certificates

`Source code <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets>`_ | `Package (PyPI) <https://pypi.org/project/azure-keyvault-secrets/>`_ | `API reference documentation <https://aka.ms/azsdk-python-keyvault-secrets-ref>`_ | `Product documentation <https://docs.microsoft.com/en-us/azure/key-vault/>`_ | `Samples <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-secrets/samples>`_

Getting started
---------------

Install packages
^^^^^^^^^^^^^^^^

Install `azure-keyvault-secrets <https://pypi.org/project/azure-keyvault-secrets/>`_ and
`azure-identity <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity>`_ with `pip <https://pypi.org/project/pip/>`_\ :

.. code-block:: Bash

   pip install azure-keyvault-secrets azure-identity

`azure-identity <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity>`_ is used for Azure Active Directory
authentication as demonstrated below.

Prerequisites
^^^^^^^^^^^^^


* An `Azure subscription <https://azure.microsoft.com/free/>`_
* Python 2.7, 3.5.3, or later
* 
  A Key Vault. If you need to create one, you can use the
  `Azure Cloud Shell <https://shell.azure.com/bash>`_ 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 `SecretClient <https://aka.ms/azsdk-python-keyvault-secrets-secretclient>`_


Authenticate the client
^^^^^^^^^^^^^^^^^^^^^^^

This document demonstrates using `DefaultAzureCredential <https://aka.ms/azsdk-python-identity-default-cred-ref>`_
to authenticate as a service principal. However, `SecretClient <https://aka.ms/azsdk-python-keyvault-secrets-secretclient>`_
accepts any `azure-identity <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity>`_ credential. See the
`azure-identity <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity>`_ documentation for more information about other
credentials.

Create a service principal (optional)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This `Azure Cloud Shell <https://shell.azure.com/bash>`_ 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 key operations in your Key Vault:

.. code-block:: Bash

   az keyvault set-policy --name my-key-vault --spn $AZURE_CLIENT_ID --secret-permissions backup delete get list create update

..

   Possible permissions:


   * Secret management: set, backup, delete, get, list, purge, recover, restore


Create a client
~~~~~~~~~~~~~~~

Once the **AZURE_CLIENT_ID**\ , **AZURE_CLIENT_SECRET** and
**AZURE_TENANT_ID** environment variables are set,
`DefaultAzureCredential <https://aka.ms/azsdk-python-identity-default-cred-ref>`_ will be able to authenticate the
`SecretClient <https://aka.ms/azsdk-python-keyvault-secrets-secretclient>`_.

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.secrets import SecretClient

       credential = DefaultAzureCredential()

       secret_client = SecretClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)

Key concepts
------------

Secret
^^^^^^

A secret consists of a secret value and its associated metadata and management
information. This library handles secret values as strings, but Azure Key Vault
doesn't store them as such. For more information about secrets and how Key
Vault stores and manages them, see the
`Key Vault documentation <https://docs.microsoft.com/en-us/azure/key-vault/about-keys-secrets-and-certificates#key-vault-secrets>`_.

`SecretClient <https://aka.ms/azsdk-python-keyvault-secrets-secretclient>`_ can set secret values in the vault, update
secret metadata, and delete secrets, as shown in the
:raw-html-m2r:`<a href="#examples" title="examples">examples</a>` below.

Examples
--------

This section contains code snippets covering common tasks:


* :raw-html-m2r:`<a href="#set-a-secret" title="Set a Secret">Set a Secret</a>`
* :raw-html-m2r:`<a href="#retrieve-a-secret" title="Retrieve a Secret">Retrieve a Secret</a>`
* :raw-html-m2r:`<a href="#update-secret-metadata" title="Update Secret metadata">Update Secret metadata</a>`
* :raw-html-m2r:`<a href="#delete-a-secret" title="Delete a Secret">Delete a Secret</a>`
* :raw-html-m2r:`<a href="#list-secrets" title="List Secrets">List Secrets</a>`
* :raw-html-m2r:`<a href="#asynchronously-create-a-secret" title="Asynchronously create a Secret">Asynchronously create a Secret</a>`
* :raw-html-m2r:`<a href="#asynchronously-list-secrets" title="Asynchronously list Secrets">Asynchronously list Secrets</a>`

Set a Secret
^^^^^^^^^^^^

`set_secret <https://aka.ms/azsdk-python-keyvault-secrets-set-secret>`_ creates
new secrets and changes the values of existing secrets. If no secret with the
given name exists, ``set_secret`` creates a new secret with that name and the
given value. If the given name is in use, ``set_secret`` creates a new version
of that secret, with the given value.

.. code-block:: python

       from azure.identity import DefaultAzureCredential
       from azure.keyvault.secrets import SecretClient

       credential = DefaultAzureCredential()

       secret_client = SecretClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
       secret = secret_client.set_secret("secret-name", "secret-value")

       print(secret.name)
       print(secret.value)
       print(secret.properties.version)

Retrieve a Secret
^^^^^^^^^^^^^^^^^

`get_secret <https://aka.ms/azsdk-python-keyvault-secrets-get-secret>`_ retrieves a secret previously stored in the Key Vault.

.. code-block:: python

       from azure.identity import DefaultAzureCredential
       from azure.keyvault.secrets import SecretClient

       credential = DefaultAzureCredential()

       secret_client = SecretClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
       secret = secret_client.get_secret("secret-name")

       print(secret.name)
       print(secret.value)

Update Secret metadata
^^^^^^^^^^^^^^^^^^^^^^

`update_secret_properites <https://aka.ms/azsdk-python-keyvault-secrets-update-secret-ref>`_ updates a secret's metadata. It cannot change the secret's
value; use `set_secret <#create-a-secret>`_ to set a secret's value.

.. code-block:: python

       from azure.identity import DefaultAzureCredential
       from azure.keyvault.secrets import SecretClient

       credential = DefaultAzureCredential()

       secret_client = SecretClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)

       # Clients may specify the content type of a secret to assist in interpreting the secret data when it's retrieved
       content_type = "text/plain"

       # We will also disable the secret for further use

       updated_secret_properties = secret_client.update_secret_properties("secret-name", content_type=content_type, enabled=False)

       print(updated_secret_properties.updated_on)
       print(updated_secret_properties.content_type)
       print(updated_secret_properties.enabled)

Delete a Secret
^^^^^^^^^^^^^^^

`begin_delete_secret <https://aka.ms/azsdk-python-keyvault-secrets-begin-delete-secret-ref>`_ requests Key Vault delete
a secret, returning a poller which allows you to wait for the deletion to finish. Waiting is helpful when the vault has
`soft-delete <https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete>`_ enabled, and you want to purge (permanently delete) the secret as soon as possible.
When `soft-delete <https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete>`_ is disabled, ``begin_delete_secret`` itself is permanent.

.. code-block:: python

       from azure.identity import DefaultAzureCredential
       from azure.keyvault.secrets import SecretClient

       credential = DefaultAzureCredential()

       secret_client = SecretClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
       deleted_secret = secret_client.begin_delete_secret("secret-name").result()

       print(deleted_secret.name)
       print(deleted_secret.deleted_date)

List secrets
^^^^^^^^^^^^

`list_properties_of_secrets <https://aka.ms/azsdk-python-keyvault-secrets-list-properties-secrets-ref>`_ lists the
properties of all of the secrets in the client's vault. This list doesn't include the secret's values.

.. code-block:: python

       from azure.identity import DefaultAzureCredential
       from azure.keyvault.secrets import SecretClient

       credential = DefaultAzureCredential()

       secret_client = SecretClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
       secret_properties = secret_client.list_properties_of_secrets()

       for secret_property in secret_properties:
           # the list doesn't include values or versions of the secrets
           print(secret_property.name)

Async API
^^^^^^^^^

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 <https://pypi.org/project/aiohttp/>`_.
See
`azure-core documentation <https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/README.md#transport>`_
for more information.

Asynchronously create a secret
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

`set_secret <https://aka.ms/azsdk-python-keyvault-secrets-async-set-secret-ref>`_ creates a secret in the Key Vault with the
specified optional arguments.

.. code-block:: python

       from azure.identity.aio import DefaultAzureCredential
       from azure.keyvault.secrets.aio import SecretClient

       credential = DefaultAzureCredential()
       secret_client = SecretClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)

       secret = await secret_client.set_secret("secret-name", "secret-value")

       print(secret.name)
       print(secret.value)
       print(secret.properties.version)

Asynchronously list secrets
^^^^^^^^^^^^^^^^^^^^^^^^^^^

`list_properties_of_secrets <https://aka.ms/azsdk-python-keyvault-secrets-async-list-properties-secrets-ref>`_ lists the
properties of all of the secrets in the client's vault.

.. code-block:: python

       from azure.identity.aio import DefaultAzureCredential
       from azure.keyvault.secrets.aio import SecretClient

       credential = DefaultAzureCredential()
       secret_client = SecretClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
       secret_properties = secret_client.list_properties_of_secrets()

       async for secret_property in secret_properties:
           # the list doesn't include values or versions of the secrets
           print(secret_property.name)

Troubleshooting
---------------

General
^^^^^^^

Key Vault clients raise exceptions defined in `azure-core <https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/docs/exceptions.md>`_.
For example, if you try to get a key that doesn't exist in the vault,
`SecretClient <https://aka.ms/azsdk-python-keyvault-secrets-secretclient>`_ raises
`ResourceNotFoundError <https://aka.ms/azsdk-python-core-exceptions-resource-not-found-error>`_\ :

.. code-block:: python

   from azure.identity import DefaultAzureCredential
   from azure.keyvault.secrets import SecretClient
   from azure.core.exceptions import ResourceNotFoundError

   credential = DefaultAzureCredential()
   secret_client = SecretClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)

   try:
       secret_client.get_secret("which-does-not-exist")
   except ResourceNotFoundError as e:
       print(e.message)

Logging
^^^^^^^

This library uses the standard
`logging <https://docs.python.org/3.5/library/logging.html>`_ 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:: python

   from azure.identity import DefaultAzureCredential
   from azure.keyvault.secrets import SecretClient
   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
   secret_client = SecretClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential, logging_enable=True)

Similarly, ``logging_enable`` can enable detailed logging for a single operation,
even when it isn't enabled for the client:

.. code-block:: py

   secret_client.get_secret("my-secret", logging_enable=True)

Next steps
----------

Several samples are available in the Azure SDK for Python GitHub repository.
These provide example code for additional Key Vault scenarios:


* `test_samples_secrets.py <https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/tests/test_samples_secrets.py>`_ and
  `test_samples_secrets_async.py <https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/tests/test_samples_secrets_async.py>`_ - code snippets
  from the library's documentation
* `hello_world.py <https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/hello_world.py>`_ and
  `hello_world_async.py <https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/hello_world_async.py>`_ - create/get/update/delete
  secrets
* `list_operations.py <https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/list_operations.py>`_ and
  `list_operations_async.py <https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-secrets/samples/list_operations_async.py>`_ - list secrets

Additional Documentation
^^^^^^^^^^^^^^^^^^^^^^^^

For more extensive documentation on Azure Key Vault, see the
`API reference documentation <https://aka.ms/azsdk-python-keyvault-secrets-ref>`_.

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 <https://opensource.microsoft.com/codeofconduct/>`_. 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-secrets%2FFREADME.png
   :target: https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fkeyvault%2Fazure-keyvault-secrets%2FFREADME.png
   :alt: Impressions



Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. toctree::
  :maxdepth: 5
  :glob:
  :caption: Developer Documentation

  azure.keyvault.secrets.rst