Udostępnij za pośrednictwem

EnvironmentCredential Klasa

  • Odwołanie

Poświadczenia skonfigurowane przez zmienne środowiskowe.

To poświadczenie może uwierzytelniać się jako jednostka usługi przy użyciu klucza tajnego klienta lub certyfikatu albo jako użytkownik z nazwą użytkownika i hasłem. W tej kolejności podjęto próbę konfiguracji przy użyciu następujących zmiennych środowiskowych:

Jednostka usługi z wpisem tajnym:

  • AZURE_TENANT_ID: identyfikator dzierżawy jednostki usługi. Nazwana również identyfikatorem "katalogu".

  • AZURE_CLIENT_ID: identyfikator klienta jednostki usługi

  • AZURE_CLIENT_SECRET: jeden z wpisów tajnych klienta jednostki usługi

  • AZURE_AUTHORITY_HOST: urząd punktu końcowego usługi Azure Active Directory, na przykład "login.microsoftonline.com", urząd dla chmury publicznej platformy Azure, który jest wartością domyślną, gdy nie zostanie podana żadna wartość.

Jednostka usługi z certyfikatem:

  • AZURE_TENANT_ID: identyfikator dzierżawy jednostki usługi. Nazwana również identyfikatorem "katalogu".

  • AZURE_CLIENT_ID: identyfikator klienta jednostki usługi

  • AZURE_CLIENT_CERTIFICATE_PATH: ścieżka do pliku certyfikatu PEM lub PKCS12, w tym klucza prywatnego.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (opcjonalnie) hasło pliku certyfikatu, jeśli istnieje.

  • AZURE_AUTHORITY_HOST: urząd punktu końcowego usługi Azure Active Directory, na przykład "login.microsoftonline.com", urząd dla chmury publicznej platformy Azure, który jest wartością domyślną, gdy nie zostanie podana żadna wartość.

Użytkownik z nazwą użytkownika i hasłem:

  • AZURE_CLIENT_ID: identyfikator klienta aplikacji

  • AZURE_USERNAME: nazwa użytkownika (zazwyczaj adres e-mail)

  • AZURE_PASSWORD: hasło użytkownika

  • AZURE_TENANT_ID: (opcjonalnie) identyfikator dzierżawy jednostki usługi. Nazwana również identyfikatorem "katalogu". Jeśli nie zostanie podana, domyślnie jest to dzierżawa "organizacji", która obsługuje tylko konta służbowe usługi Azure Active Directory.

  • AZURE_AUTHORITY_HOST: urząd punktu końcowego usługi Azure Active Directory, na przykład "login.microsoftonline.com", urząd dla chmury publicznej platformy Azure, który jest wartością domyślną, gdy nie zostanie podana żadna wartość.

Dziedziczenie
builtins.object
EnvironmentCredential

Konstruktor

EnvironmentCredential(**kwargs: Any)

Przykłady

Utwórz środowiskoUtwórz.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Metody

close

Zamknij sesję transportu poświadczeń.
get_token

Zażądaj tokenu dostępu dla zakresów.

Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK.

close

Zamknij sesję transportu poświadczeń.

close() -> None

get_token

Zażądaj tokenu dostępu dla zakresów.

Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK.

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

Parametry

scopes
str
Wymagane

żądane zakresy tokenu dostępu. Ta metoda wymaga co najmniej jednego zakresu. Aby uzyskać więcej informacji na temat zakresów, zobacz https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

dodatkowe oświadczenia wymagane w tokenie, takie jak te zwrócone w wyzwaniu oświadczeń dostawcy zasobów po niepowodzeniu autoryzacji.

tenant_id
str

opcjonalna dzierżawa do uwzględnienia w żądaniu tokenu.

Zwraca

Token dostępu z żądanymi zakresami.

Typ zwracany

AccessToken

Wyjątki

CredentialUnavailableError

konfiguracja zmiennej środowiskowej jest niekompletna