DefaultAzureCredential Klasa

Domyślne poświadczenia obsługujące większość scenariuszy uwierzytelniania zestawu Azure SDK.

Używana tożsamość zależy od środowiska. Gdy potrzebny jest token dostępu, żąda go z kolei przy użyciu tych tożsamości, zatrzymując się, gdy udostępnia token:

1. Jednostka usługi skonfigurowana przez zmienne środowiskowe. Zobacz EnvironmentCredential , aby uzyskać więcej informacji.

2. WorkloadIdentityCredential, jeśli konfiguracja zmiennej środowiskowej jest ustawiana przez element webhook tożsamości obciążenia platformy Azure.

3. Tożsamość zarządzana platformy Azure. Zobacz ManagedIdentityCredential , aby uzyskać więcej informacji.

4. Tylko w systemie Windows: użytkownik, który zalogował się przy użyciu aplikacji firmy Microsoft, takiej jak Visual Studio. Jeśli w pamięci podręcznej znajduje się wiele tożsamości, wartość zmiennej środowiskowej AZURE_USERNAME jest używana do wybierania tożsamości do użycia. Zobacz SharedTokenCacheCredential , aby uzyskać więcej informacji.

5. Tożsamość aktualnie zalogowana do interfejsu wiersza polecenia platformy Azure.

6. Tożsamość obecnie zalogowana do Azure PowerShell.

7. Tożsamość jest obecnie zalogowana do Azure Developer CLI.

To domyślne zachowanie można skonfigurować przy użyciu argumentów słów kluczowych.

Dziedziczenie

azure.identity._credentials.chained.ChainedTokenCredential

DefaultAzureCredential

Konstruktor

DefaultAzureCredential(**kwargs: Any)

Parametry

authority

str

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 domyślny). AzureAuthorityHosts definiuje władze dla innych chmur. Tożsamości zarządzane ignorują to, ponieważ znajdują się w jednej chmurze.

exclude_workload_identity_credential

bool

Określa, czy tożsamość obciążenia ma zostać wyklucz z poświadczenia. Wartość domyślna to False.

exclude_developer_cli_credential

bool

Czy wykluczyć Azure Developer CLI z poświadczenia. Wartość domyślna to False.

exclude_cli_credential

bool

Czy wykluczyć interfejs wiersza polecenia platformy Azure z poświadczeń. Wartość domyślna to False.

exclude_environment_credential

bool

Czy wykluczyć jednostkę usługi skonfigurowaną przez zmienne środowiskowe z poświadczenia. Wartość domyślna to False.

exclude_managed_identity_credential

bool

Czy wykluczyć tożsamość zarządzaną z poświadczenia. Wartość domyślna to False.

exclude_powershell_credential

bool

Czy wykluczyć Azure PowerShell. Wartość domyślna to False.

exclude_visual_studio_code_credential

bool

Czy wykluczyć przechowywane poświadczenia z programu VS Code. Wartość domyślna to True.

exclude_shared_token_cache_credential

bool

Czy wykluczyć udostępnioną pamięć podręczną tokenu. Wartość domyślna to False.

exclude_interactive_browser_credential

bool

Czy wykluczyć uwierzytelnianie interakcyjne przeglądarki (zobacz InteractiveBrowserCredential). Wartość domyślna to True.

interactive_browser_tenant_id

str

Identyfikator dzierżawy do użycia podczas uwierzytelniania użytkownika za pośrednictwem usługi InteractiveBrowserCredential. Domyślnie wartość zmiennej środowiskowej AZURE_TENANT_ID, jeśli istnieje. Jeśli nie zostanie określona, użytkownicy będą uwierzytelniać się w swoich dzierżawach domowych.

managed_identity_client_id

str

Identyfikator klienta tożsamości zarządzanej przypisanej przez użytkownika. Domyślnie wartość zmiennej środowiskowej AZURE_CLIENT_ID, jeśli istnieje. Jeśli nie zostanie określona, zostanie użyta tożsamość przypisana przez system.

workload_identity_client_id

str

Identyfikator klienta tożsamości przypisanej do zasobnika. Domyślnie wartość zmiennej środowiskowej AZURE_CLIENT_ID, jeśli istnieje. Jeśli nie zostanie określona, zostanie użyta domyślna tożsamość zasobnika.

workload_identity_tenant_id

str

Preferowana dzierżawa dla .WorkloadIdentityCredential Domyślnie wartość zmiennej środowiskowej AZURE_TENANT_ID, jeśli istnieje.

interactive_browser_client_id

str

Identyfikator klienta, który ma być używany w poświadczeniach przeglądarki interakcyjnej. Jeśli nie zostanie określony, użytkownicy będą uwierzytelniać się w aplikacji dewelopera platformy Azure.

shared_cache_username

str

Preferowana nazwa użytkownika dla .SharedTokenCacheCredential Wartość domyślna zmiennej środowiskowej AZURE_USERNAME, jeśli istnieje.

shared_cache_tenant_id

str

Preferowana dzierżawa dla .SharedTokenCacheCredential Domyślnie wartość zmiennej środowiskowej AZURE_TENANT_ID, jeśli istnieje.

visual_studio_code_tenant_id

str

Identyfikator dzierżawy do użycia podczas uwierzytelniania za pomocą VisualStudioCodeCredentialpolecenia . Domyślnie ustawienie "Azure: Dzierżawa" w ustawieniach użytkownika programu VS Code lub, jeśli to ustawienie nie ma wartości, dzierżawa "organizacje", która obsługuje tylko konta służbowe usługi Azure Active Directory.

process_timeout

int

Limit czasu w sekundach używany dla poświadczeń dewelopera, które uruchamiają podprocesy (np. AzureCliCredential, AzurePowerShellCredential). Wartość domyślna to 10 sekund.

Przykłady

Utwórz wartość domyślnąAzureCredential.

   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()

Metody

close	Zamknij sesję transportu każdego poświadczenia w łańcuchu.
get_token	Żądanie tokenu dostępu dla zakresów. Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK.

close

Zamknij sesję transportu każdego poświadczenia w łańcuchu.

close() -> None

get_token

Żądanie 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 żądaniu dostawcy zasobów wyzwanie 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

ClientAuthenticationError

uwierzytelnianie nie powiodło się. Wyjątek zawiera atrybut komunikatu zawierający listę każdej próby uwierzytelnienia i komunikat o błędzie.