Partager via

EnvironmentCredential Classe

  • Référence

Informations d’identification configurées par des variables d’environnement.

Ces informations d’identification sont capables de s’authentifier en tant que principal de service à l’aide d’une clé secrète client ou d’un certificat, ou en tant qu’utilisateur avec un nom d’utilisateur et un mot de passe. La configuration est tentée dans cet ordre, à l’aide des variables d’environnement suivantes :

Principal de service avec secret :

  • AZURE_TENANT_ID : ID du locataire du principal de service. Également appelé son ID « répertoire ».

  • AZURE_CLIENT_ID : ID client du principal de service

  • AZURE_CLIENT_SECRET : l’une des clés secrètes client du principal de service

  • AZURE_AUTHORITY_HOST : 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 quand aucune valeur n’est donnée.

Principal de service avec certificat :

  • AZURE_TENANT_ID : ID du locataire du principal de service. Également appelé son ID « répertoire ».

  • AZURE_CLIENT_ID : ID client du principal de service

  • AZURE_CLIENT_CERTIFICATE_PATH : chemin d’accès à un fichier de certificat PEM ou PKCS12 incluant la clé privée.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD : mot de passe (facultatif) du fichier de certificat, le cas échéant.

  • AZURE_AUTHORITY_HOST : 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 quand aucune valeur n’est donnée.

Utilisateur avec nom d’utilisateur et mot de passe :

  • AZURE_CLIENT_ID : ID client de l’application

  • AZURE_USERNAME : nom d’utilisateur (généralement une adresse e-mail)

  • AZURE_PASSWORD : mot de passe de cet utilisateur

  • AZURE_TENANT_ID : (facultatif) ID du locataire du principal de service. Également appelé son ID « répertoire ». S’il n’est pas fourni, la valeur par défaut est le locataire « organizations », qui prend uniquement en charge les comptes professionnels ou scolaires Azure Active Directory.

  • AZURE_AUTHORITY_HOST : 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 quand aucune valeur n’est donnée.

Héritage
builtins.object
EnvironmentCredential

Constructeur

EnvironmentCredential(**kwargs: Any)

Exemples

Créez un élément EnvironmentCredential.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Méthodes

close

Fermez la session de transport des informations d’identification.
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.

close

Fermez la session de transport des informations d’identification.

close() -> None

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, claims: str | None = None, tenant_id: str | None = None, **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. Pour plus d’informations sur les étendues, consultez https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

revendications supplémentaires requises dans le jeton, telles que celles retournées dans la contestation de revendications d’un fournisseur de ressources suite à un échec d’autorisation.

tenant_id
str

locataire facultatif à inclure dans la demande de jeton.

Retours

Jeton d’accès avec les étendues souhaitées.

Type de retour

AccessToken

Exceptions

CredentialUnavailableError

La configuration de la variable d’environnement est incomplète