azure-keyvault-py

AZURE_KEYVAULT_URL=https://<vault-name>.vault.azure.net/  # Required for all auth methods
AZURE_TOKEN_CREDENTIALS=prod # Required only if DefaultAzureCredential is used in production

from azure.identity import DefaultAzureCredential, ManagedIdentityCredential
from azure.keyvault.secrets import SecretClient
 
# Local dev: DefaultAzureCredential. Production: set AZURE_TOKEN_CREDENTIALS=prod or AZURE_TOKEN_CREDENTIALS=<specific_credential>
credential = DefaultAzureCredential(require_envvar=True)
# Or use a specific credential directly in production:
# See https://learn.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python#credential-classes
# credential = ManagedIdentityCredential()
vault_url = "https://<vault-name>.vault.azure.net/"
 
with SecretClient(vault_url=vault_url, credential=credential) as client:
    # All secret operations go inside this block (see examples below)
    ...

# Set secret
secret = client.set_secret("database-password", "super-secret-value")
print(f"Created: {secret.name}, version: {secret.properties.version}")
 
# Get secret
secret = client.get_secret("database-password")
print(f"Value: {secret.value}")
 
# Get specific version
secret = client.get_secret("database-password", version="abc123")
 
# List secrets (names only, not values)
for secret_properties in client.list_properties_of_secrets():
    print(f"Secret: {secret_properties.name}")
 
# List versions
for version in client.list_properties_of_secret_versions("database-password"):
    print(f"Version: {version.version}, Created: {version.created_on}")
 
# Delete secret (soft delete)
poller = client.begin_delete_secret("database-password")
deleted_secret = poller.result()
 
# Purge (permanent delete, if soft-delete enabled)
client.purge_deleted_secret("database-password")
 
# Recover deleted secret
client.begin_recover_deleted_secret("database-password").result()

from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient
 
credential = DefaultAzureCredential()
vault_url = "https://<vault-name>.vault.azure.net/"
 
with KeyClient(vault_url=vault_url, credential=credential) as client:
    # All key operations go inside this block (see examples below)
    ...

from azure.keyvault.keys import KeyType
 
# Create RSA key
rsa_key = client.create_rsa_key("rsa-key", size=2048)
 
# Create EC key
ec_key = client.create_ec_key("ec-key", curve="P-256")
 
# Get key
key = client.get_key("rsa-key")
print(f"Key type: {key.key_type}")
 
# List keys
for key_properties in client.list_properties_of_keys():
    print(f"Key: {key_properties.name}")
 
# Delete key
poller = client.begin_delete_key("rsa-key")
deleted_key = poller.result()

from azure.keyvault.keys.crypto import CryptographyClient, EncryptionAlgorithm
 
# Get crypto client for a specific key
# crypto_client = CryptographyClient(key, credential=credential)
# Or from key ID
with CryptographyClient(
    "https://<vault>.vault.azure.net/keys/<key-name>/<version>",
    credential=credential
) as crypto_client:
    # Encrypt
    plaintext = b"Hello, Key Vault!"
    result = crypto_client.encrypt(EncryptionAlgorithm.rsa_oaep, plaintext)
    ciphertext = result.ciphertext
 
    # Decrypt
    result = crypto_client.decrypt(EncryptionAlgorithm.rsa_oaep, ciphertext)
    decrypted = result.plaintext
 
    # Sign
    from azure.keyvault.keys.crypto import SignatureAlgorithm
    import hashlib
 
    digest = hashlib.sha256(b"data to sign").digest()
    result = crypto_client.sign(SignatureAlgorithm.rs256, digest)
    signature = result.signature
 
    # Verify
    result = crypto_client.verify(SignatureAlgorithm.rs256, digest, signature)
    print(f"Valid: {result.is_valid}")

from azure.identity import DefaultAzureCredential
from azure.keyvault.certificates import CertificateClient, CertificatePolicy
 
credential = DefaultAzureCredential()
vault_url = "https://<vault-name>.vault.azure.net/"
 
with CertificateClient(vault_url=vault_url, credential=credential) as client:
    # All certificate operations go inside this block (see examples below)
    ...

# Create self-signed certificate
policy = CertificatePolicy.get_default()
poller = client.begin_create_certificate("my-cert", policy=policy)
certificate = poller.result()
 
# Get certificate
certificate = client.get_certificate("my-cert")
print(f"Thumbprint: {certificate.properties.x509_thumbprint.hex()}")
 
# Get certificate with private key (as secret)
from azure.keyvault.secrets import SecretClient
with SecretClient(vault_url=vault_url, credential=credential) as secret_client:
    cert_secret = secret_client.get_secret("my-cert")
    # cert_secret.value contains PEM or PKCS12
 
# List certificates
for cert in client.list_properties_of_certificates():
    print(f"Certificate: {cert.name}")
 
# Delete certificate
poller = client.begin_delete_certificate("my-cert")
deleted = poller.result()

from azure.identity.aio import DefaultAzureCredential
from azure.keyvault.secrets.aio import SecretClient
 
async def get_secret():
    async with DefaultAzureCredential() as credential:
        async with SecretClient(vault_url=vault_url, credential=credential) as client:
            secret = await client.get_secret("my-secret")
            print(secret.value)
 
import asyncio
asyncio.run(get_secret())

from azure.core.exceptions import ResourceNotFoundError, HttpResponseError
 
try:
    secret = client.get_secret("nonexistent")
except ResourceNotFoundError:
    print("Secret not found")
except HttpResponseError as e:
    if e.status_code == 403:
        print("Access denied - check RBAC permissions")
    raise