CertificateCredential Klass

  • Referens

Autentiserar som tjänstens huvudnamn med hjälp av ett certifikat.

Certifikatet måste ha en privat RSA-nyckel eftersom den här autentiseringsuppgiften signerar intyg med RS256. Mer information om hur du konfigurerar certifikatautentisering finns i Azure Active Directory-dokumentationen .

Arv
azure.identity._internal.client_credential_base.ClientCredentialBase
CertificateCredential

Konstruktor

CertificateCredential(tenant_id: str, client_id: str, certificate_path: str | None = None, **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

certificate_path
str
standardvärde: None

Valfri sökväg till en certifikatfil i PEM- eller PKCS12-format, inklusive den privata nyckeln. Om inget anges krävs certificate_data .

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.

certificate_data
bytes

Byte för ett certifikat i PEM- eller PKCS12-format, inklusive den privata nyckeln

password
str eller bytes

Certifikatets lösenord. Om en unicode-sträng kodas den som UTF-8. Om certifikatet kräver en annan kodning skickar du i stället lämpligt kodade byte.

send_certificate_chain
bool

Om det är sant skickar autentiseringsuppgifterna den offentliga certifikatkedjan i x5c-huvudet för varje tokenbegärans JWT. Detta krävs för autentisering med ämnesnamn/utfärdare (SNI). Standardvärdet är False.

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 CertificateCredential.


   from azure.identity import CertificateCredential

   credential = CertificateCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       certificate_path="<path to PEM/PKCS12 certificate>",
       password="<certificate password if necessary>",
   )

   # Certificate/private key byte data can also be passed directly
   credential = CertificateCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       certificate_data=b"<cert data>",
   )

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.