CertificateCredential Klas

Verifieert als een service-principal met behulp van een certificaat.

Het certificaat moet een persoonlijke RSA-sleutel hebben, omdat deze referentie asserties ondertekent met behulp van RS256. Zie Documentatie voor Azure Active Directory voor meer informatie over het configureren van certificaatverificatie.

Overname

azure.identity.aio._internal.AsyncContextManager

CertificateCredential

azure.identity.aio._internal.get_token_mixin.GetTokenMixin

CertificateCredential

Constructor

CertificateCredential(tenant_id: str, client_id: str, certificate_path: str | None = None, **kwargs: Any)

Parameters

tenant_id

str

Vereist

Id van de tenant van de service-principal. Ook wel de map-id genoemd.

client_id

str

Vereist

De client-id van de service-principal

certificate_path

str

standaardwaarde: None

Pad naar een certificaatbestand met PEM-codering, inclusief de persoonlijke sleutel. Als dit niet wordt opgegeven, is certificate_data vereist.

authority

str

Instantie van een Azure Active Directory-eindpunt, bijvoorbeeld 'login.microsoftonline.com', de instantie voor de openbare Azure-cloud (dit is de standaardinstelling). AzureAuthorityHosts definieert instanties voor andere clouds.

certificate_data

bytes

De bytes van een certificaat in PEM-indeling, inclusief de persoonlijke sleutel

password

str of bytes

Het wachtwoord van het certificaat. Als er een Unicode-tekenreeks is, wordt deze gecodeerd als UTF-8. Als voor het certificaat een andere codering is vereist, geeft u in plaats daarvan de juiste gecodeerde bytes door.

cache_persistence_options

TokenCachePersistenceOptions

Configuratie voor permanente tokencache. Als dit niet wordt opgegeven, worden tokens in het geheugen opgeslagen in de cache van de referentie.

additionally_allowed_tenants

List[str]

Hiermee geeft u tenants op naast de opgegeven 'tenant_id' waarvoor de referentie tokens kan verkrijgen. Voeg de jokertekenwaarde '*' toe om de referentie toe te staan tokens te verkrijgen voor elke tenant waar de toepassing toegang toe heeft.

Voorbeelden

Maak een CertificateCredential.

   from azure.identity.aio 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>",
   )

Methoden

close	Sluit de transportsessie van de referentie.
get_token	Een toegangstoken aanvragen voor bereiken. Deze methode wordt automatisch aangeroepen door Azure SDK-clients.

close

Sluit de transportsessie van de referentie.

async close() -> None

get_token

Een toegangstoken aanvragen voor bereiken.

Deze methode wordt automatisch aangeroepen door Azure SDK-clients.

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

Parameters

scopes

str

Vereist

gewenste bereiken voor het toegangstoken. Voor deze methode is ten minste één bereik vereist. Zie voor meer informatie over bereiken https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

aanvullende claims die zijn vereist in het token, zoals de claims die worden geretourneerd in de claimvraag van een resourceprovider na een autorisatiefout.

tenant_id

str

optionele tenant die moet worden opgenomen in de tokenaanvraag.

enable_cae

bool

geeft aan of continue toegangsevaluatie (CAE) moet worden ingeschakeld voor het aangevraagde token. Standaard ingesteld op False.

Retouren

Een toegangstoken met de gewenste bereiken.

Retourtype

AccessToken

Uitzonderingen

CredentialUnavailableError

de referentie kan geen verificatie uitvoeren omdat de vereiste gegevens, status of platformondersteuning ontbreekt

ClientAuthenticationError

verificatie is mislukt. Het kenmerk van de message fout geeft een reden aan.