DefaultAzureCredential Třída

Výchozí přihlašovací údaje schopné zpracovat většinu scénářů ověřování sady Azure SDK.

Identita, která se používá, závisí na prostředí. Když je potřeba přístupový token, vyžádá si ho pomocí těchto identit a zastaví se, když jedna poskytne token:

1. Instanční objekt nakonfigurovaný proměnnými prostředí. Další podrobnosti najdete EnvironmentCredential v tématu .

2. WorkloadIdentityCredential, pokud konfiguraci proměnné prostředí nastavuje webhook identity úlohy Azure.

3. Spravovaná identita Azure. Další podrobnosti najdete ManagedIdentityCredential v tématu .

4. Pouze ve Windows: Uživatel, který se přihlásil pomocí aplikace Microsoftu, jako je například Visual Studio. Pokud je v mezipaměti více identit, použije se hodnota proměnné AZURE_USERNAME prostředí k výběru identity, která se má použít. Další podrobnosti najdete SharedTokenCacheCredential v tématu .

5. Identita, která je aktuálně přihlášená k Azure CLI.

6. Identita aktuálně přihlášená k Azure PowerShell.

7. Identita aktuálně přihlášená k Azure Developer CLI.

Toto výchozí chování lze konfigurovat pomocí argumentů klíčových slov.

Dědičnost

azure.identity._credentials.chained.ChainedTokenCredential

DefaultAzureCredential

Konstruktor

DefaultAzureCredential(**kwargs: Any)

Parametry

authority

str

Autorita koncového bodu Azure Active Directory, například login.microsoftonline.com, autorita pro veřejný cloud Azure (která je výchozí). AzureAuthorityHosts definuje autority pro jiné cloudy. Spravované identity to ignorují, protože se nacházejí v jednom cloudu.

exclude_workload_identity_credential

bool

Jestli se má identita úlohy vyloučit z přihlašovacích údajů. Výchozí hodnota je False.

exclude_developer_cli_credential

bool

Jestli se mají Azure Developer CLI vyloučit z přihlašovacích údajů. Výchozí hodnota je False.

exclude_cli_credential

bool

Jestli se má Azure CLI vyloučit z přihlašovacích údajů. Výchozí hodnota je False.

exclude_environment_credential

bool

Jestli se má z přihlašovacích údajů vyloučit instanční objekt nakonfigurovaný proměnnými prostředí. Výchozí hodnota je False.

exclude_managed_identity_credential

bool

Jestli se má spravovaná identita vyloučit z přihlašovacích údajů. Výchozí hodnota je False.

exclude_powershell_credential

bool

Určuje, jestli se mají vyloučit Azure PowerShell. Výchozí hodnota je False.

exclude_visual_studio_code_credential

bool

Jestli se mají z VS Code vyloučit uložené přihlašovací údaje. Výchozí hodnota je True.

exclude_shared_token_cache_credential

bool

Jestli se má vyloučit sdílená mezipaměť tokenů. Výchozí hodnota je False.

exclude_interactive_browser_credential

bool

Jestli se má vyloučit interaktivní ověřování prohlížečem (viz InteractiveBrowserCredential). Výchozí hodnota je True.

interactive_browser_tenant_id

str

ID tenanta, které se má použít při ověřování uživatele prostřednictvím InteractiveBrowserCredential. Výchozí hodnota je hodnota proměnné prostředí AZURE_TENANT_ID, pokud existuje. V případě nespecifikovaného stavu se uživatelé budou ověřovat ve svých domovských tenantech.

managed_identity_client_id

str

ID klienta spravované identity přiřazené uživatelem. Výchozí hodnota je hodnota proměnné prostředí AZURE_CLIENT_ID, pokud existuje. Pokud není zadána, použije se identita přiřazená systémem.

workload_identity_client_id

str

ID klienta identity přiřazené k podu. Výchozí hodnota je hodnota proměnné prostředí AZURE_CLIENT_ID, pokud existuje. Pokud ji nezadáte, použije se výchozí identita podu.

workload_identity_tenant_id

str

Upřednostňovaný tenant pro WorkloadIdentityCredential. Výchozí hodnota je hodnota proměnné prostředí AZURE_TENANT_ID, pokud existuje.

interactive_browser_client_id

str

ID klienta, které se má použít v interaktivních přihlašovacích údajích prohlížeče. Pokud tento parametr nezadáte, budou se uživatelé ověřovat ve vývojové aplikaci Azure.

shared_cache_username

str

Upřednostňované uživatelské jméno pro SharedTokenCacheCredential. Výchozí hodnota je hodnota proměnné prostředí AZURE_USERNAME, pokud existuje.

shared_cache_tenant_id

str

Upřednostňovaný tenant pro SharedTokenCacheCredential. Výchozí hodnota je hodnota proměnné prostředí AZURE_TENANT_ID, pokud existuje.

visual_studio_code_tenant_id

str

ID tenanta, které se má použít při ověřování pomocí VisualStudioCodeCredential. Ve výchozím nastavení se použije nastavení Azure: Tenant v uživatelských nastaveních nástroje VS Code, nebo pokud toto nastavení nemá žádnou hodnotu, tenant organizace, který podporuje jenom pracovní nebo školní účty Azure Active Directory.

process_timeout

int

Časový limit v sekundách, který se má použít pro přihlašovací údaje vývojáře, které spouští podprocesy (např. AzureCliCredential, AzurePowerShellCredential). Výchozí hodnota je 10 sekund.

Příklady

Vytvořte DefaultAzureCredential.

   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()

Metody

close	Ukončete relaci přenosu jednotlivých přihlašovacích údajů v řetězci.
get_token	Vyžádejte si přístupový token pro obory. Klienti sady Azure SDK volali tuto metodu automaticky.

close

Ukončete relaci přenosu jednotlivých přihlašovacích údajů v řetězci.

close() -> None

get_token

Vyžádejte si přístupový token pro obory.

Klienti sady Azure SDK volali tuto metodu automaticky.

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

Parametry

scopes

str

Vyžadováno

požadované obory přístupového tokenu. Tato metoda vyžaduje alespoň jeden obor. Další informace o oborech najdete v tématu https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

Další deklarace identity vyžadované v tokenu, například ty, které se vrací při výzvě k deklaraci identity poskytovatele prostředků po selhání autorizace.

tenant_id

str

volitelného tenanta, který se má zahrnout do žádosti o token.

Návraty

Přístupový token s požadovanými obory.

Návratový typ

AccessToken

Výjimky

ClientAuthenticationError

ověření se nezdařilo. Výjimka obsahuje atribut zprávy se seznamem každého pokusu o ověření a jeho chybové zprávy.