ClientSecretCredential Třída

  • Reference

Ověřuje se jako instanční objekt pomocí tajného klíče klienta.

Dědičnost
azure.identity._internal.client_credential_base.ClientCredentialBase
ClientSecretCredential

Konstruktor

ClientSecretCredential(tenant_id: str, client_id: str, client_secret: str, **kwargs: Any)

Parametry

tenant_id
str
Vyžadováno

ID tenanta instančního objektu Označuje se také jako ID adresáře.

client_id
str
Vyžadováno

ID klienta instančního objektu

client_secret
str
Vyžadováno

Jeden z tajných klíčů klienta instančního objektu

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.

cache_persistence_options
TokenCachePersistenceOptions

Konfigurace pro ukládání trvalých tokenů do mezipaměti. Pokud ho nezadáte, přihlašovací údaje uloží tokeny do mezipaměti.

disable_instance_discovery
bool

Určuje, zda se při pokusu o ověření provádí zjišťování instancí. Pokud tuto hodnotu nastavíte na true, zjišťování instancí i ověření autority se úplně zakáže. Tato funkce je určená pro použití ve scénářích, kdy není dostupný koncový bod metadat, například v privátních cloudech nebo ve službě Azure Stack. Proces zjišťování instance zahrnuje načtení metadat autority z, https://login.microsoft.com/ aby se autorita ověřila. Když tuto hodnotu nastavíte na True, ověření autority se zakáže. Proto je důležité zajistit, aby nakonfigurovaný hostitel autority byl platný a důvěryhodný.

additionally_allowed_tenants
List[str]

Určuje tenanty kromě zadaného "tenant_id", pro které přihlašovací údaje můžou získat tokeny. Přidejte hodnotu se zástupným znakem *, aby přihlašovací údaje mohly získat tokeny pro všechny tenanty, ke které má aplikace přístup.

Příklady

Vytvořte ClientSecretCredential.


   from azure.identity import ClientSecretCredential

   credential = ClientSecretCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       client_secret="<client_secret>",
   )

Metody

close
get_token

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

Klienti sady Azure SDK volali tuto metodu automaticky.

close 

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.

enable_cae
bool

určuje, jestli se má pro požadovaný token povolit průběžné vyhodnocování přístupu (CAE). Výchozí hodnota je False.

Návraty

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

Návratový typ

AccessToken

Výjimky

CredentialUnavailableError

přihlašovací údaje se nemůžou pokusit o ověření, protože jim chybí požadovaná data, stav nebo podpora platformy

ClientAuthenticationError

ověření se nezdařilo. Atribut chyby message uvádí důvod.