ClientCertificateCredential class

Balíček:: @azure/identity

Umožňuje autentizaci k Microsoft Entra ID pomocí certifikátu kódovaného PEM, který je přiřazen k App Registration. Další informace o konfiguraci ověřování certifikátů najdete tady:

https://learn.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Konstruktory

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Vytváří instanci ClientCertificateCredential s detaily potřebnými k autentizaci proti Microsoft Entra ID s certifikátem.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Vytváří instanci ClientCertificateCredential s detaily potřebnými k autentizaci proti Microsoft Entra ID s certifikátem.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Vytváří instanci ClientCertificateCredential s detaily potřebnými k autentizaci proti Microsoft Entra ID s certifikátem.

Metody

getToken(string | string[], GetTokenOptions)

Autentizuje se pomocí Microsoft Entra ID a pokud je úspěšný, vrací přístupový token. Pokud se ověření nezdaří, zobrazí se CredentialUnavailableError s podrobnostmi o selhání.

Podrobnosti konstruktoru

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Vytváří instanci ClientCertificateCredential s detaily potřebnými k autentizaci proti Microsoft Entra ID s certifikátem.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)

Parametry

tenantId: string

ID nájemce (adresář) Microsoft Entra.

clientId: string

ID klienta (aplikace) registrace aplikace v tenantovi.

configuration: ClientCertificatePEMCertificate

Další požadované parametry, včetně certifikátu s kódováním PEM jako řetězce. Pokud je typ ignorován, vyvoláme hodnotu certifikátu s kódováním PEM.

options: ClientCertificateCredentialOptions

Možnosti konfigurace klienta, který provádí žádost o ověření.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Vytváří instanci ClientCertificateCredential s detaily potřebnými k autentizaci proti Microsoft Entra ID s certifikátem.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)

Parametry

tenantId: string

ID nájemce (adresář) Microsoft Entra.

clientId: string

ID klienta (aplikace) registrace aplikace v tenantovi.

configuration: ClientCertificatePEMCertificatePath

Další požadované parametry, včetně cesty certifikátu v systému souborů. Pokud je typ ignorován, vyvoláme hodnotu cesty k certifikátu PEM.

options: ClientCertificateCredentialOptions

Možnosti konfigurace klienta, který provádí žádost o ověření.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Vytváří instanci ClientCertificateCredential s detaily potřebnými k autentizaci proti Microsoft Entra ID s certifikátem.

new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)

Parametry

tenantId: string

ID nájemce (adresář) Microsoft Entra.

clientId: string

ID klienta (aplikace) registrace aplikace v tenantovi.

certificatePath: string

Cesta k certifikátu veřejného/privátního klíče s kódováním PEM v systému souborů. Ujistěte se, že certifikát je ve formátu PEM a obsahuje veřejný i soukromý klíč.

options: ClientCertificateCredentialOptions

Možnosti konfigurace klienta, který provádí žádost o ověření.

Podrobnosti metody

getToken(string | string[], GetTokenOptions)

Autentizuje se pomocí Microsoft Entra ID a pokud je úspěšný, vrací přístupový token. Pokud se ověření nezdaří, zobrazí se CredentialUnavailableError s podrobnostmi o selhání.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parametry

scopes: string | string[]

Seznam oborů, pro které bude mít token přístup.

options: GetTokenOptions

Možnosti použité ke konfiguraci všech požadavků, které tato implementace TokenCredential může provést.

Návraty

Promise<AccessToken>