ClientCertificateCredential class

Pacchetto:

@azure/identity

Abilita l'autenticazione all'ID Microsoft Entra usando un certificato con codifica PEM assegnato a una registrazione dell'app. Altre informazioni su come configurare l'autenticazione del certificato sono disponibili qui:

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

Costruttori

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Crea un'istanza di ClientCertificateCredential con i dettagli necessari per l'autenticazione in Microsoft Entra ID con un certificato.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Crea un'istanza di ClientCertificateCredential con i dettagli necessari per l'autenticazione in Microsoft Entra ID con un certificato.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Crea un'istanza di ClientCertificateCredential con i dettagli necessari per l'autenticazione in Microsoft Entra ID con un certificato.

Metodi

getToken(string | string[], GetTokenOptions)

Esegue l'autenticazione con Microsoft Entra ID e restituisce un token di accesso in caso di esito positivo. Se l'autenticazione non riesce, verrà generata una CredentialUnavailableError con i dettagli dell'errore.

Dettagli costruttore

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Crea un'istanza di ClientCertificateCredential con i dettagli necessari per l'autenticazione in Microsoft Entra ID con un certificato.

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

Parametri

tenantId

string

ID tenant di Microsoft Entra (directory).

clientId

string

ID client (applicazione) di una registrazione dell'app nel tenant.

configuration

ClientCertificatePEMCertificate

Altri parametri obbligatori, incluso il certificato con codifica PEM come stringa. Se il tipo viene ignorato, verrà generato il valore del certificato con codifica PEM.

options

ClientCertificateCredentialOptions

Opzioni per la configurazione del client che effettua la richiesta di autenticazione.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Crea un'istanza di ClientCertificateCredential con i dettagli necessari per l'autenticazione in Microsoft Entra ID con un certificato.

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

Parametri

tenantId

string

ID tenant di Microsoft Entra (directory).

clientId

string

ID client (applicazione) di una registrazione dell'app nel tenant.

configuration

ClientCertificatePEMCertificatePath

Altri parametri obbligatori, incluso il percorso del certificato nel file system. Se il tipo viene ignorato, verrà generato il valore del percorso di un certificato PEM.

options

ClientCertificateCredentialOptions

Opzioni per la configurazione del client che effettua la richiesta di autenticazione.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Crea un'istanza di ClientCertificateCredential con i dettagli necessari per l'autenticazione in Microsoft Entra ID con un certificato.

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

Parametri

tenantId

string

ID tenant di Microsoft Entra (directory).

clientId

string

ID client (applicazione) di una registrazione dell'app nel tenant.

certificatePath

string

Percorso di un certificato di chiave pubblica/privata con codifica PEM nel file system.

options

ClientCertificateCredentialOptions

Opzioni per la configurazione del client che effettua la richiesta di autenticazione.

Dettagli metodo

getToken(string | string[], GetTokenOptions)

Esegue l'autenticazione con Microsoft Entra ID e restituisce un token di accesso in caso di esito positivo. Se l'autenticazione non riesce, verrà generata una CredentialUnavailableError con i dettagli dell'errore.

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

Parametri

scopes

string | string[]

Elenco di ambiti per i quali il token avrà accesso.

options

GetTokenOptions

Le opzioni usate per configurare le richieste che potrebbero essere eseguite da questa implementazione di TokenCredential.

Restituisce

Promise<AccessToken>