ClientCertificateCredential class

Paket:

@azure/identity

Aktiviert die Authentifizierung für Microsoft Entra-ID mithilfe eines PEM-codierten Zertifikats, das einer App-Registrierung zugewiesen ist. Weitere Informationen zum Konfigurieren der Zertifikatauthentifizierung finden Sie hier:

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

Konstruktoren

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Erstellt eine Instanz der ClientCertificateCredential mit den Details, die für die Authentifizierung mit einer Microsoft Entra-ID mit einem Zertifikat erforderlich sind.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Erstellt eine Instanz der ClientCertificateCredential mit den Details, die für die Authentifizierung mit einer Microsoft Entra-ID mit einem Zertifikat erforderlich sind.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Erstellt eine Instanz der ClientCertificateCredential mit den Details, die für die Authentifizierung mit einer Microsoft Entra-ID mit einem Zertifikat erforderlich sind.

Methoden

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.

Details zum Konstruktor

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Erstellt eine Instanz der ClientCertificateCredential mit den Details, die für die Authentifizierung mit einer Microsoft Entra-ID mit einem Zertifikat erforderlich sind.

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

Parameter

tenantId

string

Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID).

clientId

string

Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.

configuration

ClientCertificatePEMCertificate

Andere parameter erforderlich, einschließlich des PEM-codierten Zertifikats als Zeichenfolge. Wenn der Typ ignoriert wird, wird der Wert des PEM-codierten Zertifikats ausgelöst.

options

ClientCertificateCredentialOptions

Optionen zum Konfigurieren des Clients, der die Authentifizierungsanforderung vorgibt.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Erstellt eine Instanz der ClientCertificateCredential mit den Details, die für die Authentifizierung mit einer Microsoft Entra-ID mit einem Zertifikat erforderlich sind.

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

Parameter

tenantId

string

Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID).

clientId

string

Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.

configuration

ClientCertificatePEMCertificatePath

Andere parameter erforderlich, einschließlich des Pfads des Zertifikats im Dateisystem. Wenn der Typ ignoriert wird, wird der Wert des Pfads zu einem PEM-Zertifikat ausgelöst.

options

ClientCertificateCredentialOptions

Optionen zum Konfigurieren des Clients, der die Authentifizierungsanforderung vorgibt.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Erstellt eine Instanz der ClientCertificateCredential mit den Details, die für die Authentifizierung mit einer Microsoft Entra-ID mit einem Zertifikat erforderlich sind.

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

Parameter

tenantId

string

Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID).

clientId

string

Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.

certificatePath

string

Der Pfad zu einem PEM-codierten öffentlichen/privaten Schlüsselzertifikat im Dateisystem. Stellen Sie sicher, dass das Zertifikat im PEM-Format vorliegt und sowohl den öffentlichen als auch den privaten Schlüssel enthält.

options

ClientCertificateCredentialOptions

Optionen zum Konfigurieren des Clients, der die Authentifizierungsanforderung vorgibt.

Details zur Methode

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.

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

Parameter

scopes

string | string[]

Die Liste der Bereiche, für die das Token Zugriff hat.

options

GetTokenOptions

Die Optionen zum Konfigurieren von Anforderungen, die diese TokenCredential-Implementierung möglicherweise vorgibt.

Gibt zurück

Promise<AccessToken>