Retrieve secrets using Azure SDK client libraries (Key Vault)

La python library azure-keyvault-secrets proviene la clase SecretClient para todas las operaciones de secretos contra Azure Key Vault. Combinado con azure-identity para auth, ambos paquetes cubren la necesidad de obtener credenciales en codigo.

Install the SDK

El Key Vault secrets SDK requiere de dos packages

  • azure-keyvault-secrets para vault ops
  • azure-identity para auth
pip install azure-keyvault-secrets azure-identity

La URL de la vault sigue el patron https://<vault-name>.vault.azure.net/

la url se puede obtener desde la web o asi

az keyvault show --name <vault-name> --query properties.vaultUri

Authenticate with DefaultAzureCredential

DefaultAzureCredential de la libreria azure-identity encadena multiples auth methods en un orden definido, provando cada uno hasta que uno funciona. Esta clase funciona para desarrollo local y PROD sin cambios de codigo.

En produccion, managed identity se autentica sin credenciales almacenadas. En local, lo hace a través de Azure CLI.

Orden que sigue:

  1. EnvironmentCredentials: Lee AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET environment vars
  2. WorkloadIdentityCredential: Auth usando K8s workload identity tokens
  3. ManagedIdentityCredential: Usa Azure managed identity (system-assigned o user-assigned) attached al computer resource
  4. AzureCliCredential: Auth usando az login
  5. AzureDeveloperCliCredential: Auth usando azd auth login
  6. AzurePowerShellCredential: Auth usando Connect-AzAccount

Para servicios que corren en Azure compute resources (Container Apps, K8s o App Service) se recomienda usar managed identity como auth method. La app hace auth a Key Vault a través de Entra ID.
La managed identity necesita el rol Key Vault Secrets User.

Retrieve a secret by name

El metodo get_secret() obtiene la version actual de un secreto de la Key Vault.
El object obtenido KeyVaultSecret contiene secret value, name y properties con metadatos como la version o fechas.

# Code fragment - focus on retrieving a secret with DefaultAzureCredential
from azure.identity import DefaultAzureCredential
from azure.keyvault.secrets import SecretClient

credential = DefaultAzureCredential()
client = SecretClient(
    vault_url="https://kv-ragpipeline-prod.vault.azure.net/",
    credential=credential
)

secret = client.get_secret("openai-api-key")

# Access the secret value and metadata
api_key = secret.value
version = secret.properties.version
created = secret.properties.created_on
content_type = secret.properties.content_type

El secret.value contiene la secret string que tu app pasa a downstream service clients. Los properties son metadata para logging o debugging.

List secret properties

El metodo list_properties_of_secrets() enumera todos los secretos del vault - SIN OBTENER SUS VALORES.
Esto devuelve SecretProperties que contiene metadata. Se usa para hacer discovery de los secretos disponibles.

# Code fragment - focus on listing secret properties for discovery
secret_properties = client.list_properties_of_secrets()

for prop in secret_properties:
    print(f"Secret: {prop.name}, Enabled: {prop.enabled}, "
          f"Content type: {prop.content_type}")
    if prop.tags:
        print(f"  Tags: {prop.tags}")

El listado es util durante app startup para validar que todas las credenciales existen.

Handle errors and exceptions

El SDK levanta excepciones especificas para distintos escenarios. Es nuestra responsabilidad gestionarlos bien para ver cual es recuperable y cual no.

# Code fragment - focus on structured error handling for secret retrieval
from azure.core.exceptions import (
    ResourceNotFoundError,
    HttpResponseError,
    ServiceRequestError
)

def get_secret_safely(client, secret_name):
    try:
        secret = client.get_secret(secret_name)
        return secret.value
    except ResourceNotFoundError:
        # Secret doesn't exist - configuration error
        print(f"Secret '{secret_name}' not found in vault. "
              "Verify the secret name and vault configuration.")
        raise
    except HttpResponseError as e:
        # Authentication or authorization failure
        print(f"Access denied or server error for '{secret_name}': "
              f"{e.status_code} - {e.message}")
        raise
    except ServiceRequestError:
        # Network connectivity issue - may be transient
        print(f"Network error retrieving '{secret_name}'. "
              "Check connectivity to Key Vault.")
        raise

Use the async client for high-throughput apps

El modulo azure.keyvault.secrets.aio provee un SecretClient async para apps que usan asyncio. Los servicios de IA que procesan requests concurrentes se benefician de async secret retrieval porque evita bloquear el event loop durante vault calls.

# Code fragment - focus on async secret retrieval
from azure.identity.aio import DefaultAzureCredential
from azure.keyvault.secrets.aio import SecretClient

async def get_ai_credentials():
    credential = DefaultAzureCredential()
    client = SecretClient(
        vault_url="https://kv-ragpipeline-prod.vault.azure.net/",
        credential=credential
    )

    async with client:
        secret = await client.get_secret("openai-api-key")

    await credential.close()
    return secret.value