DefaultAzureCredential Clase

Una credencial predeterminada capaz de controlar la mayoría de los escenarios de autenticación del SDK de Azure.

La identidad que usa depende del entorno. Cuando se necesita un token de acceso, solicita una mediante estas identidades a su vez, deteniendo cuando se proporciona un token:

1. Una entidad de servicio configurada por variables de entorno. Para obtener más información, consulte EnvironmentCredential.

2. WorkloadIdentityCredential si la configuración de la variable de entorno está establecida por el webhook de identidad de carga de trabajo de Azure.

3. Una identidad administrada de Azure. Para obtener más información, consulte ManagedIdentityCredential.

4. Solo en Windows: un usuario que ha iniciado sesión con una aplicación de Microsoft, como Visual Studio. Si hay varias identidades en la memoria caché, el valor de la variable AZURE_USERNAME de entorno se usa para seleccionar la identidad que se va a usar. Para obtener más información, consulte SharedTokenCacheCredential.

5. La identidad que ha iniciado sesión actualmente en la CLI de Azure.

6. La identidad que ha iniciado sesión actualmente en Azure PowerShell.

7. La identidad que ha iniciado sesión actualmente en el Azure Developer CLI.

Este comportamiento predeterminado se puede configurar con argumentos de palabra clave.

Herencia

azure.identity._credentials.chained.ChainedTokenCredential

DefaultAzureCredential

Constructor

DefaultAzureCredential(**kwargs: Any)

Parámetros

authority

str

Autoridad de un punto de conexión de Azure Active Directory, por ejemplo, "login.microsoftonline.com", la autoridad de la nube pública de Azure (que es el valor predeterminado). AzureAuthorityHosts define autoridades para otras nubes. Las identidades administradas omiten esto porque residen en una sola nube.

exclude_workload_identity_credential

bool

Si se va a excluir la identidad de la carga de trabajo de la credencial. El valor predeterminado es False.

exclude_developer_cli_credential

bool

Si se va a excluir el Azure Developer CLI de la credencial. El valor predeterminado es False.

exclude_cli_credential

bool

Si se va a excluir la CLI de Azure de la credencial. El valor predeterminado es False.

exclude_environment_credential

bool

Si se va a excluir una entidad de servicio configurada por variables de entorno de la credencial. El valor predeterminado es False.

exclude_managed_identity_credential

bool

Si se va a excluir la identidad administrada de la credencial. El valor predeterminado es False.

exclude_powershell_credential

bool

Si se va a excluir Azure PowerShell. El valor predeterminado es False.

exclude_visual_studio_code_credential

bool

Si se excluyen las credenciales almacenadas de VS Code. El valor predeterminado es True.

exclude_shared_token_cache_credential

bool

Si se va a excluir la caché de tokens compartidos. El valor predeterminado es False.

exclude_interactive_browser_credential

bool

Si se va a excluir la autenticación interactiva del explorador (consulte InteractiveBrowserCredential). El valor predeterminado es True.

interactive_browser_tenant_id

str

Identificador de inquilino que se va a usar al autenticar un usuario mediante InteractiveBrowserCredential. El valor predeterminado de la variable de entorno AZURE_TENANT_ID, si existe. Si no se especifica, los usuarios se autenticarán en sus inquilinos domésticos.

managed_identity_client_id

str

La identidad de cliente para una identidad administrada asignada por el usuario. El valor predeterminado de la variable de entorno AZURE_CLIENT_ID, si existe. Si no se especifica, se usará una identidad asignada por el sistema.

workload_identity_client_id

str

Identificador de cliente de una identidad asignada al pod. El valor predeterminado de la variable de entorno AZURE_CLIENT_ID, si existe. Si no se especifica, se usará la identidad predeterminada del pod.

workload_identity_tenant_id

str

Inquilino preferido para WorkloadIdentityCredential. El valor predeterminado de la variable de entorno AZURE_TENANT_ID, si existe.

interactive_browser_client_id

str

Identificador de cliente que se va a usar en la credencial interactiva del explorador. Si no se especifica, los usuarios se autenticarán en una aplicación de desarrollo de Azure.

shared_cache_username

str

Nombre de usuario preferido para SharedTokenCacheCredential. El valor predeterminado de la variable de entorno AZURE_USERNAME, si existe.

shared_cache_tenant_id

str

Inquilino preferido para SharedTokenCacheCredential. El valor predeterminado de la variable de entorno AZURE_TENANT_ID, si existe.

visual_studio_code_tenant_id

str

Identificador de inquilino que se va a usar al autenticarse con VisualStudioCodeCredential. El valor predeterminado es la opción "Azure: Tenant" en la configuración de usuario de VS Code o, cuando esa configuración no tiene ningún valor, el inquilino "organizations", que solo admite cuentas profesionales o educativas de Azure Active Directory.

process_timeout

int

Tiempo de espera en segundos que se usará para las credenciales de desarrollador que ejecutan subprocesos (por ejemplo, AzureCliCredential, AzurePowerShellCredential). El valor predeterminado es 10 segundos.

Ejemplos

Cree un valor DefaultAzureCredential.

   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()

Métodos

close	Cierre la sesión de transporte de cada credencial de la cadena.
get_token	Solicite un token de acceso para los ámbitos. Los clientes del SDK de Azure llaman automáticamente a este método.

close

Cierre la sesión de transporte de cada credencial de la cadena.

close() -> None

get_token

Solicite un token de acceso para los ámbitos.

Los clientes del SDK de Azure llaman automáticamente a este método.

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

Parámetros

scopes

str

Requerido

ámbitos deseados para el token de acceso. Este método requiere al menos un ámbito. Para obtener más información sobre los ámbitos, vea https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

Notificaciones adicionales necesarias en el token, como las que se devuelven en el desafío de notificaciones de un proveedor de recursos después de un error de autorización.

tenant_id

str

inquilino opcional que se va a incluir en la solicitud de token.

Devoluciones

Un token de acceso con los ámbitos deseados.

Tipo de valor devuelto

AccessToken

Excepciones

ClientAuthenticationError

error de autenticación. La excepción tiene un atributo de mensaje que muestra cada intento de autenticación y su mensaje de error.