ClientSecretCredential Osztály

A hitelesítés szolgáltatásnévként ügyfélkód használatával történik.

Öröklődés

azure.identity._internal.client_credential_base.ClientCredentialBase

ClientSecretCredential

Konstruktor

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

Paraméterek

tenant_id

str

Kötelező

A szolgáltatásnév bérlőjének azonosítója. Más néven a "könyvtár" azonosítója.

client_id

str

Kötelező

A szolgáltatásnév ügyfél-azonosítója

client_secret

str

Kötelező

A szolgáltatásnév egyik titkos ügyfélkódja

authority

str

Egy Azure Active Directory-végpont szolgáltatója, például "login.microsoftonline.com", az Azure Public Cloud szolgáltatója (ez az alapértelmezett). AzureAuthorityHosts más felhők hatóságait határozza meg.

cache_persistence_options

TokenCachePersistenceOptions

Konfigurálás állandó jogkivonat-gyorsítótárazáshoz. Ha nincs meghatározva, a hitelesítő adat gyorsítótárazza a tokeneket a memóriában.

disable_instance_discovery

bool

Meghatározza, hogy a példányfelderítés a hitelesítés megkísérlésekor történik-e. Ha ezt igaz értékre állítja, az teljesen letiltja a példányfelderítést és a hitelesítést. Ez a funkció olyan esetekben használható, amikor a metaadat-végpont nem érhető el, például magánfelhőkben vagy az Azure Stackben. A példányfelderítés folyamata magában foglalja a szolgáltató metaadatainak https://login.microsoft.com/ lekérését a szolgáltató ellenőrzéséhez. Ha ezt Igaz értékre állítja, a szolgáltató ellenőrzése le van tiltva. Ennek eredményeképpen elengedhetetlen annak biztosítása, hogy a konfigurált szolgáltatói gazdagép érvényes és megbízható legyen.

additionally_allowed_tenants

List[str]

A megadott "tenant_id" mellett olyan bérlőket is meghatároz, amelyekhez a hitelesítő adatok jogkivonatokat szerezhetnek be. Adja hozzá a "*" helyettesítő karaktert, hogy a hitelesítő adatok jogkivonatokat szerezzenek be minden olyan bérlőhöz, amelyhez az alkalmazás hozzáférhet.

Példák

Hozzon létre egy ClientSecretCredential azonosítót.

   from azure.identity import ClientSecretCredential

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

Metódusok

close
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

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. A hatókörökről további információt a következő témakörben talál https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc: .

claims

str

a jogkivonathoz szükséges további jogcímek, például az erőforrás-szolgáltató jogcímekkel kapcsolatos kihívásá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.

enable_cae

bool

azt jelzi, hogy engedélyezi-e a folyamatos hozzáférés-kiértékelést (CAE) a kért jogkivonathoz. Alapértelmezés szerint Hamis.

Válaszok

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

Visszatérési típus

AccessToken

Kivételek

CredentialUnavailableError

a hitelesítő adat nem tud hitelesítést kísérelni, mert nem rendelkezik a szükséges adatokkal, állapottal vagy platformtámogatással

ClientAuthenticationError

a hitelesítés nem sikerült. A hiba attribútuma message okot ad.