DefaultAzureCredential Classe

  • Référence

Informations d’identification par défaut capables de gérer la plupart des scénarios d’authentification du Kit de développement logiciel (SDK) Azure.

L’identité qu’il utilise dépend de l’environnement. Lorsqu’un jeton d’accès est nécessaire, il en demande un à l’aide de ces identités à son tour, s’arrêtant lorsque l’on fournit un jeton :

  1. Un principal de service configuré par des variables d’environnement. Consultez EnvironmentCredential pour plus d’informations.

  2. Une identité managée Azure. Consultez ManagedIdentityCredential pour plus d’informations.

  3. Sur Windows uniquement : un utilisateur qui s’est connecté avec une application Microsoft, telle que Visual Studio. Si plusieurs identités se trouvent dans le cache, la valeur de la variable AZURE_USERNAME d’environnement est utilisée pour sélectionner l’identité à utiliser. Consultez SharedTokenCacheCredential pour plus d’informations.

  4. L’utilisateur est actuellement connecté à Visual Studio Code.

  5. Identité actuellement connectée à Azure CLI.

  6. Identité actuellement connectée à Azure PowerShell.

Ce comportement par défaut est configurable avec des arguments de mot clé.

Héritage
azure.identity._credentials.chained.ChainedTokenCredential
DefaultAzureCredential

Constructeur

DefaultAzureCredential(**kwargs: Any)

Paramètres

authority
str

Autorité d’un point de terminaison Azure Active Directory, par exemple « login.microsoftonline.com », l’autorité pour le cloud public Azure (qui est la valeur par défaut). AzureAuthorityHosts définit les autorités pour d’autres clouds. Les identités managées ignorent cela, car elles résident dans un seul cloud.

exclude_cli_credential
bool

Indique s’il faut exclure Azure CLI des informations d’identification. La valeur par défaut est False.

exclude_environment_credential
bool

Indique s’il faut exclure des informations d’identification un principal de service configuré par des variables d’environnement. La valeur par défaut est False.

exclude_managed_identity_credential
bool

Indique s’il faut exclure l’identité managée des informations d’identification. La valeur par défaut est False.

exclude_powershell_credential
bool

Indique s’il faut exclure Azure PowerShell. La valeur par défaut est False.

exclude_visual_studio_code_credential
bool

Indique s’il faut exclure les informations d’identification stockées de VS Code. La valeur par défaut est False.

exclude_shared_token_cache_credential
bool

Indique s’il faut exclure le cache de jetons partagé. La valeur par défaut est False.

exclude_interactive_browser_credential
bool

Indique s’il faut exclure l’authentification interactive du navigateur (voir InteractiveBrowserCredential). La valeur par défaut est True.

interactive_browser_tenant_id
str

ID de locataire à utiliser lors de l’authentification d’un utilisateur via InteractiveBrowserCredential. La valeur par défaut de la variable d’environnement AZURE_TENANT_ID, le cas échéant. S’il n’est pas spécifié, les utilisateurs s’authentifient dans leurs locataires de base.

managed_identity_client_id
str

ID de client d’une identité managée affectée par l’utilisateur. La valeur par défaut de la variable d’environnement AZURE_CLIENT_ID, le cas échéant. Si elle n’est pas spécifiée, une identité affectée par le système est utilisée.

interactive_browser_client_id
str

ID client à utiliser dans les informations d’identification du navigateur interactif. S’il n’est pas spécifié, les utilisateurs s’authentifient auprès d’une application de développement Azure.

shared_cache_username
str

Nom d’utilisateur préféré pour SharedTokenCacheCredential. La valeur par défaut de la variable d’environnement AZURE_USERNAME, le cas échéant.

shared_cache_tenant_id
str

Locataire préféré pour SharedTokenCacheCredential. La valeur par défaut de la variable d’environnement AZURE_TENANT_ID, le cas échéant.

visual_studio_code_tenant_id
str

ID de locataire à utiliser lors de l’authentification avec VisualStudioCodeCredential. Par défaut, le paramètre « Azure : Locataire » dans les paramètres utilisateur de VS Code ou, lorsque ce paramètre n’a aucune valeur, le locataire « organisations », qui prend en charge uniquement les comptes professionnels ou scolaires Azure Active Directory.

Méthodes

get_token

Demandez un jeton d’accès pour les étendues.

Cette méthode est appelée automatiquement par les clients du Kit de développement logiciel (SDK) Azure.

get_token

Demandez un jeton d’accès pour les étendues.

Cette méthode est appelée automatiquement par les clients du Kit de développement logiciel (SDK) Azure.

get_token(*scopes: str, **kwargs: Any) -> AccessToken

Paramètres

scopes
str
Obligatoire

étendues souhaitées pour le jeton d’accès. Cette méthode nécessite au moins une étendue.

tenant_id
str

locataire facultatif à inclure dans la demande de jeton.

Type de retour

AccessToken

Exceptions

ClientAuthenticationError

échec de l’authentification. L’exception a un attribut de message répertoriant chaque tentative d’authentification et son message d’erreur.