ClientSecretCredential Klass

  • Referens

Autentiserar som tjänstens huvudnamn med hjälp av en klienthemlighet.

Arv
azure.identity._internal.client_credential_base.ClientCredentialBase
ClientSecretCredential

Konstruktor

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

Parametrar

tenant_id
str
Obligatorisk

ID för tjänstens huvudnamns klientorganisation. Kallas även dess "katalog"-ID.

client_id
str
Obligatorisk

Klient-ID för tjänstens huvudnamn

client_secret
str
Obligatorisk

En av tjänstens huvudnamns klienthemligheter

authority
str

Utfärdare av en Azure Active Directory-slutpunkt, till exempel "login.microsoftonline.com", utfärdaren för Azure Public Cloud (som är standard). AzureAuthorityHosts definierar myndigheter för andra moln.

cache_persistence_options
TokenCachePersistenceOptions

Konfiguration för beständig tokencachelagring. Om de inte anges cachelagrar autentiseringsuppgifterna token i minnet.

disable_instance_discovery
bool

Avgör om instansidentifiering utförs när du försöker autentisera. Om du anger värdet true inaktiveras både instansidentifiering och utfärdarvalidering helt. Den här funktionen är avsedd att användas i scenarier där metadataslutpunkten inte kan nås, till exempel i privata moln eller Azure Stack. Processen för instansidentifiering innebär att utfärdarmetadata hämtas från https://login.microsoft.com/ för att verifiera utfärdaren. Genom att ställa in värdet true inaktiveras verifieringen av utfärdaren. Därför är det viktigt att se till att den konfigurerade utfärdarvärden är giltig och tillförlitlig.

additionally_allowed_tenants
List[str]

Anger klientorganisationer utöver den angivna "tenant_id" som autentiseringsuppgifterna kan hämta token för. Lägg till jokertecknet "*" så att autentiseringsuppgifterna kan hämta token för alla klienter som programmet kan komma åt.

Exempel

Skapa en ClientSecretCredential.


   from azure.identity import ClientSecretCredential

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

Metoder

close
get_token

Begär en åtkomsttoken för omfång.

Den här metoden anropas automatiskt av Azure SDK-klienter.

close 

close() -> None

get_token

Begär en åtkomsttoken för omfång.

Den här metoden anropas automatiskt av Azure SDK-klienter.

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

Parametrar

scopes
str
Obligatorisk

önskade omfång för åtkomsttoken. Den här metoden kräver minst ett omfång. Mer information om omfång finns i https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

ytterligare anspråk som krävs i token, till exempel de som returneras i en resursproviders anspråksutmaning efter ett auktoriseringsfel.

tenant_id
str

valfri klientorganisation som ska ingå i tokenbegäran.

enable_cae
bool

anger om du vill aktivera kontinuerlig åtkomstutvärdering (CAE) för den begärda token. Standardvärdet är False.

Returer

En åtkomsttoken med önskade omfång.

Returtyp

AccessToken

Undantag

CredentialUnavailableError

autentiseringsuppgiften kan inte försöka autentisera eftersom den saknar nödvändiga data, tillstånd eller plattformsstöd

ClientAuthenticationError

autentiseringen misslyckades. Felets message attribut ger en orsak.