DefaultAzureCredential Osztály

Egy alapértelmezett hitelesítő adat, amely képes kezelni a legtöbb Azure SDK-hitelesítési forgatókönyvet.

A használt identitás a környezettől függ. Ha hozzáférési jogkivonatra van szükség, a rendszer ezeket az identitásokat használja, és leállítja, ha egy jogkivonatot ad meg:

1. Környezeti változók által konfigurált szolgáltatásnév. További részletekért lásd EnvironmentCredential : .

2. WorkloadIdentityCredential, ha a környezeti változó konfigurációját az Azure számításifeladat-identitás webhookja állítja be.

3. Azure-beli felügyelt identitás. További részletekért lásd ManagedIdentityCredential : .

4. Csak Windows rendszeren: olyan felhasználó, aki microsoftos alkalmazással, például Visual Studióval jelentkezett be. Ha több identitás van a gyorsítótárban, akkor a környezeti változó AZURE_USERNAME értéke alapján kell kiválasztani a használni kívánt identitást. További részletekért lásd SharedTokenCacheCredential : .

5. Az Azure CLI-be jelenleg bejelentkezett identitás.

6. Az identitás, amely jelenleg be van jelentkezve a Azure PowerShell.

7. Az identitás, amely jelenleg be van jelentkezve a Azure Developer CLI.

Ez az alapértelmezett viselkedés kulcsszóargumentumokkal konfigurálható.

Öröklődés

azure.identity._credentials.chained.ChainedTokenCredential

DefaultAzureCredential

Konstruktor

DefaultAzureCredential(**kwargs: Any)

Paraméterek

authority

str

Egy Azure Active Directory-végpont hatósága, például "login.microsoftonline.com", az Azure Public Cloud szolgáltatója (ez az alapértelmezett). AzureAuthorityHosts más felhőkre vonatkozó hatóságokat határoz meg. A felügyelt identitások ezt figyelmen kívül hagyják, mert egyetlen felhőben találhatók.

exclude_workload_identity_credential

bool

Ki kell-e zárni a számítási feladat identitását a hitelesítő adatokból. Alapértelmezés szerint Hamis.

exclude_developer_cli_credential

bool

Kizárja-e a Azure Developer CLI a hitelesítő adatokból. Alapértelmezés szerint Hamis.

exclude_cli_credential

bool

Ki kell-e zárni az Azure CLI-t a hitelesítő adatokból. Alapértelmezés szerint Hamis.

exclude_environment_credential

bool

A környezeti változók által konfigurált szolgáltatásnév kizárása a hitelesítő adatokból. Alapértelmezés szerint Hamis.

exclude_managed_identity_credential

bool

A felügyelt identitás kizárása a hitelesítő adatokból. Alapértelmezés szerint Hamis.

exclude_powershell_credential

bool

A Azure PowerShell kizárása. Alapértelmezés szerint Hamis.

exclude_visual_studio_code_credential

bool

A tárolt hitelesítő adatok kizárása a VS Code-ból. Alapértelmezés szerint Igaz.

exclude_shared_token_cache_credential

bool

A megosztott jogkivonat gyorsítótárának kizárása. Alapértelmezés szerint Hamis.

exclude_interactive_browser_credential

bool

Az interaktív böngészőhitelesítés kizárása (lásd: InteractiveBrowserCredential). Alapértelmezés szerint Igaz.

interactive_browser_tenant_id

str

A felhasználó hitelesítéséhez használandó bérlőazonosító a használatával InteractiveBrowserCredential. Alapértelmezés szerint a környezeti változó értéke AZURE_TENANT_ID, ha van ilyen. Ha nincs meghatározva, a felhasználók a saját bérlőikben fognak hitelesítést végezni.

managed_identity_client_id

str

Egy felhasználó által hozzárendelt felügyelt identitás ügyfél-azonosítója. Alapértelmezés szerint a környezeti változó értéke AZURE_CLIENT_ID, ha van ilyen. Ha nincs megadva, a rendszer egy rendszer által hozzárendelt identitást használ.

workload_identity_client_id

str

A podhoz rendelt identitás ügyfél-azonosítója. Alapértelmezés szerint a környezeti változó értéke AZURE_CLIENT_ID, ha van ilyen. Ha nincs megadva, a rendszer a pod alapértelmezett identitását használja.

workload_identity_tenant_id

str

A előnyben részesített bérlője.WorkloadIdentityCredential Alapértelmezés szerint a környezeti változó értéke AZURE_TENANT_ID, ha van ilyen.

interactive_browser_client_id

str

Az interaktív böngésző hitelesítő adataihoz használandó ügyfél-azonosító. Ha nincs megadva, a felhasználók hitelesítést fognak végezni egy Azure-beli fejlesztési alkalmazásban.

shared_cache_username

str

Előnyben részesített felhasználónév a következőhöz: SharedTokenCacheCredential. Alapértelmezés szerint a környezeti változó értéke AZURE_USERNAME, ha van ilyen.

shared_cache_tenant_id

str

A előnyben részesített bérlője.SharedTokenCacheCredential Alapértelmezés szerint a környezeti változó értéke AZURE_TENANT_ID, ha van ilyen.

visual_studio_code_tenant_id

str

A használatával történő VisualStudioCodeCredentialhitelesítéshez használandó bérlőazonosító. Alapértelmezés szerint a VS Code felhasználói beállításaiban az "Azure: Bérlő" beállítás, vagy ha a beállításnak nincs értéke, a "szervezeti" bérlő, amely csak az Azure Active Directory munkahelyi vagy iskolai fiókjait támogatja.

process_timeout

int

Az alfolyamatokat futtató fejlesztői hitelesítő adatokhoz (például AzureCliCredential, AzurePowerShellCredential) használandó időtúllépés másodpercben. Alapértelmezés szerint 10 másodperc.

Példák

Hozzon létre egy DefaultAzureCredential értéket.

   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()

Metódusok

close	Zárja be az egyes hitelesítő adatok átviteli munkamenetét a láncban.
get_token	Hozzáférési jogkivonat kérése a hatókörökhöz. Ezt a metódust az Azure SDK-ügyfelek automatikusan meghívják.

close

Zárja be az egyes hitelesítő adatok átviteli munkamenetét a láncban.

close() -> None

get_token

Hozzáférési jogkivonat kérése a hatókörökhöz.

Ezt a metódust az Azure SDK-ügyfelek automatikusan meghívják.

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

Paraméterek

scopes

str

Kötelező

a hozzáférési jogkivonat kívánt hatókörei. Ehhez a metódushoz legalább egy hatókör szükséges. További információ a hatókörökről: https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

a jogkivonatban szükséges további jogcímek, például az erőforrás-szolgáltató jogcímkontrasztjában az engedélyezési hiba után visszaadott jogcímek.

tenant_id

str

nem kötelező bérlő, amely szerepel a jogkivonat-kérelemben.

Válaszok

Hozzáférési jogkivonat a kívánt hatókörökkel.

Visszatérési típus

AccessToken

Kivételek

ClientAuthenticationError

a hitelesítés nem sikerült. A kivétel egy üzenetattribútummal rendelkezik, amely felsorolja az egyes hitelesítési kísérleteket és annak hibaüzenetét.