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._internal.client_credential_base.ClientCredentialBaseCertificateCredential
Constructor
CertificateCredential(tenant_id: str, client_id: str, certificate_path: str | None = None, **kwargs: Any)
Parameters
- certificate_path
- str
Optioneel pad naar een certificaatbestand in PEM- of PKCS12-indeling, 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- of PKCS12-indeling, inclusief de persoonlijke sleutel
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.
- send_certificate_chain
- bool
Als waar is, verzendt de referentie de openbare certificaatketen in de x5c-header van de JWT van elke tokenaanvraag. Dit is vereist voor de verificatie van de onderwerpnaam/verlener (SNI). Standaard ingesteld op False.
- 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.
- disable_instance_discovery
- bool
Bepaalt of exemplaardetectie wordt uitgevoerd bij een verificatiepoging. Als u dit instelt op true, wordt zowel exemplaardetectie als instantievalidatie volledig uitgeschakeld. Deze functionaliteit is bedoeld voor gebruik in scenario's waarin het eindpunt voor metagegevens niet kan worden bereikt, zoals in privéclouds of Azure Stack. Het proces van exemplaardetectie omvat het ophalen van instantiemetagegevens van https://login.microsoft.com/ om de instantie te valideren. Als u dit instelt op Waar, wordt de validatie van de instantie uitgeschakeld. Als gevolg hiervan is het van cruciaal belang om ervoor te zorgen dat de geconfigureerde instantiehost geldig en betrouwbaar is.
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 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 | |
get_token |
Een toegangstoken aanvragen voor bereiken. Deze methode wordt automatisch aangeroepen door Azure SDK-clients. |
close
close() -> None
get_token
Een toegangstoken aanvragen voor bereiken.
Deze methode wordt automatisch aangeroepen door Azure SDK-clients.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken
Parameters
- scopes
- str
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
Uitzonderingen
de referentie kan geen verificatie uitvoeren omdat de vereiste gegevens, status of platformondersteuning ontbreekt
verificatie is mislukt. Het kenmerk van de message
fout geeft een reden aan.