ClientCertificateCredential class

Paket:

@azure/identity

Ermöglicht die Authentifizierung zum 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/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Konstruktoren

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Erstellt eine instance von ClientCertificateCredential mit den Details, die für die Authentifizierung bei Microsoft Entra ID mit einem Zertifikat erforderlich sind.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Erstellt eine instance von ClientCertificateCredential mit den Details, die für die Authentifizierung bei Microsoft Entra ID mit einem Zertifikat erforderlich sind.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Erstellt eine instance von ClientCertificateCredential mit den Details, die für die Authentifizierung bei Microsoft Entra ID mit einem Zertifikat erforderlich sind.

Methoden

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit 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 instance von ClientCertificateCredential mit den Details, die für die Authentifizierung bei 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 (Verzeichnis)-ID.

clientId

string

Die Client- (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 stellt.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Erstellt eine instance von ClientCertificateCredential mit den Details, die für die Authentifizierung bei 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 (Verzeichnis)-ID.

clientId

string

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

configuration

ClientCertificatePEMCertificatePath

Andere erforderliche Parameter, 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 stellt.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Erstellt eine instance von ClientCertificateCredential mit den Details, die für die Authentifizierung bei 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 (Verzeichnis)-ID.

clientId

string

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

certificatePath

string

Der Pfad zu einem PEM-codierten öffentlichen/privaten Schlüsselzertifikat im Dateisystem.

options

ClientCertificateCredentialOptions

Optionen zum Konfigurieren des Clients, der die Authentifizierungsanforderung stellt.

Details zur Methode

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit 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, auf die das Token Zugriff hat.

options

GetTokenOptions

Die Optionen, die zum Konfigurieren von Anforderungen verwendet werden, die von dieser TokenCredential-Implementierung möglicherweise vorgenommen werden.

Gibt zurück

Promise<AccessToken>