Share via

EnvironmentCredential Klas

  • Referentie

Een referentie die is geconfigureerd door omgevingsvariabelen.

Deze referentie kan worden geverifieerd als een service-principal met behulp van een clientgeheim of een certificaat, of als een gebruiker met een gebruikersnaam en wachtwoord. Configuratie wordt uitgevoerd in deze volgorde, met behulp van deze omgevingsvariabelen:

Service-principal met geheim:

  • AZURE_TENANT_ID: id van de tenant van de service-principal. Ook wel de map-id genoemd.

  • AZURE_CLIENT_ID: de client-id van de service-principal

  • AZURE_CLIENT_SECRET: een van de clientgeheimen van de service-principal

  • AZURE_AUTHORITY_HOST: instantie van een Azure Active Directory-eindpunt, bijvoorbeeld 'login.microsoftonline.com', de instantie voor de openbare Azure-cloud, die de standaardwaarde is wanneer er geen waarde wordt opgegeven.

Service-principal met certificaat:

  • AZURE_TENANT_ID: id van de tenant van de service-principal. Ook wel de map-id genoemd.

  • AZURE_CLIENT_ID: de client-id van de service-principal

  • AZURE_CLIENT_CERTIFICATE_PATH: pad naar een PEM- of PKCS12-certificaatbestand met inbegrip van de persoonlijke sleutel.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (optioneel) wachtwoord van het certificaatbestand, indien van toepassing.

  • AZURE_AUTHORITY_HOST: instantie van een Azure Active Directory-eindpunt, bijvoorbeeld 'login.microsoftonline.com', de instantie voor de openbare Azure-cloud, die de standaardwaarde is wanneer er geen waarde wordt opgegeven.

Gebruiker met gebruikersnaam en wachtwoord:

  • AZURE_CLIENT_ID: de client-id van de toepassing

  • AZURE_USERNAME: een gebruikersnaam (meestal een e-mailadres)

  • AZURE_PASSWORD: het wachtwoord van die gebruiker

  • AZURE_TENANT_ID: (optioneel) id van de tenant van de service-principal. Ook wel de map-id genoemd. Als deze niet is opgegeven, wordt standaard de tenant 'organisaties' gebruikt, die alleen werk- of schoolaccounts van Azure Active Directory ondersteunt.

  • AZURE_AUTHORITY_HOST: instantie van een Azure Active Directory-eindpunt, bijvoorbeeld 'login.microsoftonline.com', de instantie voor de openbare Azure-cloud, die de standaardwaarde is wanneer er geen waarde wordt opgegeven.

Overname
builtins.object
EnvironmentCredential

Constructor

EnvironmentCredential(**kwargs: Any)

Voorbeelden

Maak een EnvironmentCredential.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Methoden

close

Sluit de transportsessie van de referentie.
get_token

Een toegangstoken aanvragen voor bereiken.

Deze methode wordt automatisch aangeroepen door Azure SDK-clients.

close

Sluit de transportsessie van de referentie.

close() -> None

get_token

Een toegangstoken aanvragen voor bereiken.

Deze methode wordt automatisch aangeroepen door Azure SDK-clients.

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

Parameters

scopes
str
Vereist

gewenste bereiken voor het toegangstoken. Voor deze methode is ten minste één bereik vereist. Zie voor meer informatie over bereiken https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

aanvullende claims die zijn vereist in het token, zoals de claims die worden geretourneerd in de claimvraag van een resourceprovider na een autorisatiefout.

tenant_id
str

optionele tenant die moet worden opgenomen in de tokenaanvraag.

Retouren

Een toegangstoken met de gewenste bereiken.

Retourtype

AccessToken

Uitzonderingen

CredentialUnavailableError

configuratie van omgevingsvariabele is onvolledig