名称: azure-identity-py
描述: |
Azure Identity SDK for Python 身份验证库。适用于 DefaultAzureCredential、托管标识、服务主体和令牌缓存。
触发词:"azure-identity"、"DefaultAzureCredential"、"authentication"、"managed identity"、"service principal"、"credential"。
package: azure-identity
用于 Azure SDK 客户端的身份验证库,基于 Microsoft Entra ID(原 Azure AD)。
pip install azure-identity
# 服务主体(用于生产环境/CI)
AZURE_TENANT_ID=<你的租户ID>
AZURE_CLIENT_ID=<你的客户端ID>
AZURE_CLIENT_SECRET=<你的客户端密钥>
# 用户分配的托管标识(可选)
AZURE_CLIENT_ID=<托管标识客户端ID>
推荐在大多数场景下使用的凭据。它会按顺序尝试多种身份验证方法:
from azure.identity import DefaultAzureCredential
from azure.storage.blob import BlobServiceClient
# 在本地开发和环境中均可工作,无需修改代码
credential = DefaultAzureCredential()
client = BlobServiceClient(
account_url="https://<账户>.blob.core.windows.net",
credential=credential
)
| 顺序 | 凭据 | 适用环境 |
|---|---|---|
| 1 | EnvironmentCredential | CI/CD、容器 |
| 2 | WorkloadIdentityCredential | Kubernetes |
| 3 | ManagedIdentityCredential | Azure VM、应用服务、函数 |
| 4 | SharedTokenCacheCredential | 仅限 Windows |
| 5 | VisualStudioCodeCredential | 安装了 Azure 扩展的 VS Code |
| 6 | AzureCliCredential | az login |
| 7 | AzurePowerShellCredential | Connect-AzAccount |
| 8 | AzureDeveloperCliCredential | azd auth login |
# 排除不需要的凭据
credential = DefaultAzureCredential(
exclude_environment_credential=True,
exclude_shared_token_cache_credential=True,
managed_identity_client_id="<用户分配的托管标识客户端ID>" # 用于用户分配的托管标识
)
# 启用交互式浏览器(默认禁用)
credential = DefaultAzureCredential(
exclude_interactive_browser_credential=False
)
适用于 Azure 托管的资源(VM、应用服务、函数、AKS):
from azure.identity import ManagedIdentityCredential
# 系统分配的托管标识
credential = ManagedIdentityCredential()
# 用户分配的托管标识
credential = ManagedIdentityCredential(
client_id="<用户分配的托管标识客户端ID>"
)
适用于使用密钥的服务主体:
from azure.identity import ClientSecretCredential
credential = ClientSecretCredential(
tenant_id=os.environ["AZURE_TENANT_ID"],
client_id=os.environ["AZURE_CLIENT_ID"],
client_secret=os.environ["AZURE_CLIENT_SECRET"]
)
使用 az login 登录的账户:
from azure.identity import AzureCliCredential
credential = AzureCliCredential()
自定义凭据链:
from azure.identity import (
ChainedTokenCredential,
ManagedIdentityCredential,
AzureCliCredential
)
# 先尝试托管标识,失败则回退到 CLI
credential = ChainedTokenCredential(
ManagedIdentityCredential(client_id="<用户分配的托管标识客户端ID>"),
AzureCliCredential()
)
| 凭据 | 使用场景 | 身份验证方式 |
|---|---|---|
DefaultAzureCredential |
大多数场景 | 自动检测 |
ManagedIdentityCredential |
Azure 托管的应用程序 | 托管标识 |
ClientSecretCredential |
服务主体 | 客户端密钥 |
ClientCertificateCredential |
服务主体 | 证书 |
AzureCliCredential |
本地开发 | Azure CLI |
AzureDeveloperCliCredential |
本地开发 | Azure Developer CLI |
InteractiveBrowserCredential |
用户登录 | 浏览器 OAuth |
DeviceCodeCredential |
无头/SSH 环境 | 设备代码流 |
from azure.identity import DefaultAzureCredential
credential = DefaultAzureCredential()
# 获取特定作用域的令牌
token = credential.get_token("https://management.azure.com/.default")
print(f"令牌过期时间: {token.expires_on}")
# 用于 Azure Database for PostgreSQL
token = credential.get_token("https://ossrdbms-aad.database.windows.net/.default")
from azure.identity.aio import DefaultAzureCredential
from azure.storage.blob.aio import BlobServiceClient
async def main():
credential = DefaultAzureCredential()
async with BlobServiceClient(
account_url="https://<账户>.blob.core.windows.net",
credential=credential
) as client:
# ... 异步操作
pass
await credential.close()