Delen via

ClientAssertionCredential Klas

  • Referentie

Hiermee wordt een service-principal geverifieerd met een JWT-assertie.

Deze referentie is voor geavanceerde scenario's. CertificateCredential heeft een handigere API voor het meest voorkomende assertiescenario, waarbij een service-principal wordt geverifieerd met een certificaat.

Overname
azure.identity._internal.get_token_mixin.GetTokenMixin
ClientAssertionCredential

Constructor

ClientAssertionCredential(tenant_id: str, client_id: str, func: Callable[[], str], **kwargs: Any)

Parameters

tenant_id
str
Vereist

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

client_id
str
Vereist

De client-id van de principal

func
Vereist

Een aanroepbare die een tekenreeksbevestiging retourneert. De referentie roept dit aan telkens wanneer er een nieuw token wordt verkregen.

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.

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 die de toepassing kan openen.

Voorbeelden

Maak een ClientAssertionCredential.


   from azure.identity import ClientAssertionCredential

   def get_assertion():
       return "<client-assertion>"

   credential = ClientAssertionCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       func=get_assertion,
   )

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
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 vereist zijn in het token, zoals 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.