@azure/identity package

  • Referenz

Klassen

AggregateAuthenticationError

Stellt ein errors Array mit AuthenticationError-instance für Authentifizierungsfehler durch Anmeldeinformationen in einem ChainedTokenCredential bereit.
AuthenticationError

Enthält Details zu einem Fehler bei der Authentifizierung bei Azure Active Directory. Das errorResponse Feld enthält weitere Details zum spezifischen Fehler.
AuthenticationRequiredError

Fehler, der zum Erzwingen der Authentifizierung verwendet wird, nachdem versucht wurde, ein Token im Hintergrund abzurufen.
AuthorizationCodeCredential

Ermöglicht die Authentifizierung zum Microsoft Entra ID mithilfe eines Autorisierungscodes, der über den Autorisierungscodefluss abgerufen wurde, der in der Microsoft Entra ID-Dokumentation ausführlicher beschrieben wird:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
AzureCliCredential

Diese Anmeldeinformationen verwenden die aktuell angemeldeten Benutzeranmeldungsinformationen über das Befehlszeilentool der Azure CLI ('az'). Dazu liest es das Benutzerzugriffstoken und läuft die Zeit mit dem Azure CLI-Befehl "az account get-access-token" ab.
AzureDeveloperCliCredential

Azure Developer CLI ist ein Befehlszeilenschnittstellentool, mit dem Entwickler Ressourcen in Azure erstellen, verwalten und bereitstellen können. Es basiert auf der Azure CLI und bietet zusätzliche Funktionen, die für Azure-Entwickler spezifisch sind. Es ermöglicht Benutzern, sich als Benutzer und/oder Dienstprinzipal bei Microsoft Entra ID zu authentifizieren. AzureDeveloperCliCredential authentifiziert sich in einer Entwicklungsumgebung und ruft ein Token im Namen des angemeldeten Benutzers oder Dienstprinzipals im Azure Developer CLI ab. Er fungiert als Azure Developer CLI angemeldeter Benutzer oder Dienstprinzipal und führt einen Azure CLI-Befehl darunter aus, um die Anwendung bei Microsoft Entra ID zu authentifizieren.

Konfigurieren von AzureDeveloperCliCredential

Um diese Anmeldeinformationen verwenden zu können, muss sich der Entwickler lokal in Azure Developer CLI mit einem der folgenden Befehle authentifizieren:

  1. Führen Sie "azd auth login" in Azure Developer CLI aus, um sich interaktiv als Benutzer zu authentifizieren.
  2. Führen Sie "azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID" aus, um sich als Dienstprinzipal zu authentifizieren.

Abhängig von der Gültigkeit des Aktualisierungstokens in Ihrer Organisation müssen Sie diesen Vorgang möglicherweise nach einem bestimmten Zeitraum wiederholen. Im Allgemeinen beträgt die Gültigkeitsdauer des Aktualisierungstokens einige Wochen bis hin zu einigen Monaten. AzureDeveloperCliCredential fordert Sie auf, sich erneut anzumelden.
AzurePowerShellCredential

Diese Anmeldeinformationen verwenden die aktuell angemeldeten Benutzerinformationen aus dem modul Azure PowerShell. Dazu liest er das Benutzerzugriffstoken und läuft die Zeit mit Azure PowerShell-Befehl ab.Get-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Ermöglicht es, mehrere TokenCredential Implementierungen in der richtigen Reihenfolge zu versuchen, bis eine der getToken-Methoden ein Zugriffstoken zurückgibt.
ClientAssertionCredential

Authentifiziert einen Dienstprinzipal mit einer JWT-Assertion.
ClientCertificateCredential

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
ClientSecretCredential

Ermöglicht die Authentifizierung zum Microsoft Entra ID mithilfe eines geheimen Clientschlüssels, der für eine App-Registrierung generiert wurde. Weitere Informationen zum Konfigurieren eines geheimen Clientschlüssels finden Sie hier:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application
CredentialUnavailableError

Dies bedeutet, dass die Anmeldeinformationen, die in einer verketteten Anmeldeinformation versucht wurden, nicht verfügbar waren, um als Anmeldeinformationen verwendet zu werden. Anstatt dies als Fehler zu behandeln, der die Kette anhalten sollte, wird sie abgefangen und die Kette wird fortgesetzt.
DefaultAzureCredential

Stellt eine standardmäßige ChainedTokenCredential-Konfiguration bereit, die für die meisten Anwendungen funktionieren sollte, die das Azure SDK verwenden.
DeviceCodeCredential

Ermöglicht die Authentifizierung zum Microsoft Entra ID mithilfe eines Gerätecodes, den der Benutzer eingeben https://microsoft.com/deviceloginkann.
EnvironmentCredential

Ermöglicht die Authentifizierung zum Microsoft Entra ID mithilfe eines geheimen Clientschlüssels oder Zertifikats oder als Benutzer mit einem Benutzernamen und Kennwort.
InteractiveBrowserCredential

Ermöglicht die Authentifizierung zum Microsoft Entra ID im Webbrowser mithilfe des interaktiven Anmeldeflows.
ManagedIdentityCredential

Versucht die Authentifizierung mithilfe einer verwalteten Identität, die in der Bereitstellungsumgebung verfügbar ist. Dieser Authentifizierungstyp funktioniert in Azure-VMs, App Service-Instanzen, Azure Functions-Anwendungen, Azure Kubernetes Services, Azure Service Fabric-Instanzen und innerhalb der Azure-Cloud Shell.

Weitere Informationen zum Konfigurieren verwalteter Identitäten finden Sie hier: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Ermöglicht die Authentifizierung zum Microsoft Entra ID mithilfe des Flusses Im Auftrag von.
UsernamePasswordCredential

Ermöglicht die Authentifizierung zum Microsoft Entra ID mit dem Benutzernamen und Kennwort eines Benutzers. Diese Anmeldeinformationen erfordern ein hohes Maß an Vertrauenswürdigkeit, sodass Sie sie nur verwenden sollten, wenn andere, sicherere Anmeldeinformationstypen nicht verwendet werden können.
VisualStudioCodeCredential

Stellt eine Verbindung mit Azure mithilfe der Anmeldeinformationen her, die von der VSCode-Erweiterung "Azure-Konto" bereitgestellt werden. Nachdem sich der Benutzer über die Erweiterung angemeldet hat, können diese Anmeldeinformationen dasselbe Aktualisierungstoken verwenden, das von der Erweiterung zwischengespeichert wird.

Es ist ein bekanntes Problem , dass diese Anmeldeinformationen nicht mit Azure-Kontoerweiterungsversionen funktionieren, die neuer als 0.9.11 sind. Es wird eine langfristige Lösung für dieses Problem ausgeführt. Erwägen Sie in der Zwischenzeit die Authentifizierung mit AzureCliCredential.
WorkloadIdentityCredential

Die Workloadidentitätsauthentifizierung ist ein Feature in Azure, mit dem Anwendungen, die auf virtuellen Computern (VMs) ausgeführt werden, auf andere Azure-Ressourcen zugreifen können, ohne dass ein Dienstprinzipal oder eine verwaltete Identität erforderlich ist. Bei der Workloadidentitätsauthentifizierung authentifizieren sich Anwendungen mit ihrer eigenen Identität, anstatt einen gemeinsamen Dienstprinzipal oder eine verwaltete Identität zu verwenden. Unter der Haube verwendet die Workloadidentitätsauthentifizierung das Konzept der Dienstkontoanmeldeinformationen (Service Account Credentials, SACs), die automatisch von Azure erstellt und sicher auf dem virtuellen Computer gespeichert werden. Mithilfe der Workloadidentitätsauthentifizierung können Sie die Notwendigkeit vermeiden, Dienstprinzipale oder verwaltete Identitäten für jede Anwendung auf jedem virtuellen Computer zu verwalten und zu rotieren. Da SACs automatisch erstellt und von Azure verwaltet werden, müssen Sie sich darüber hinaus keine Gedanken über das Speichern und Schützen vertraulicher Anmeldeinformationen selbst machen. WorkloadIdentityCredential unterstützt Microsoft Entra Workload ID Authentifizierung in Azure Kubernetes und ruft ein Token mithilfe der in der Azure Kubernetes-Umgebung verfügbaren SACs ab. Weitere Informationen finden Sie unter Microsoft Entra Workload ID.

Schnittstellen

AccessToken

Stellt ein Zugriffstoken mit einer Ablaufzeit dar.
AuthenticationRecord

Der Datensatz, der zum Suchen der zwischengespeicherten Token im Cache verwendet werden soll.
AuthenticationRequiredErrorOptions

Optionale Parameter für authenticationRequiredError
AuthorityValidationOptions

Bietet Optionen zum Konfigurieren, wie die Identitätsbibliothek die Autoritätsüberprüfung bei Authentifizierungsanforderungen an Microsoft Entra ID durchführt.
AuthorizationCodeCredentialOptions

Optionen für authorizationCodeCredential
AzureCliCredentialOptions

Optionen für azureCliCredential
AzureDeveloperCliCredentialOptions

Optionen für azureDeveloperCliCredential
AzurePowerShellCredentialOptions

Optionen für azurePowerShellCredential
BrokerAuthOptions

Konfigurationsoptionen für InteractiveBrowserCredential zur Unterstützung der WAM-Brokerauthentifizierung.
BrokerDisabledOptions

Parameter, wenn die WAM-Brokerauthentifizierung deaktiviert ist.
BrokerEnabledOptions

Parameter, wenn die WAM-Brokerauthentifizierung aktiviert ist.
BrowserCustomizationOptions

Freigegebene Konfigurationsoptionen für die Browseranpassung
ClientAssertionCredentialOptions

Optionen für clientAssertionCredential
ClientCertificateCredentialOptions

Optionale Parameter für die ClientCertificateCredential-Klasse .
ClientCertificatePEMCertificate

Erforderliche Konfigurationsoptionen für clientCertificateCredential mit dem Zeichenfolgeninhalt eines PEM-Zertifikats
ClientCertificatePEMCertificatePath

Erforderliche Konfigurationsoptionen für clientCertificateCredential mit dem Pfad zu einem PEM-Zertifikat.
ClientSecretCredentialOptions

Optionale Parameter für die ClientSecretCredential-Klasse .
CredentialPersistenceOptions

Freigegebene Konfigurationsoptionen für Anmeldeinformationen, die die persistente Tokenzwischenspeicherung unterstützen.
DefaultAzureCredentialClientIdOptions

Stellt Optionen zum Konfigurieren der DefaultAzureCredential-Klasse bereit. Diese Variante unterstützt managedIdentityClientId und nicht managedIdentityResourceId, da nur eine von beiden unterstützt wird.
DefaultAzureCredentialOptions

Stellt Optionen zum Konfigurieren der DefaultAzureCredential-Klasse bereit.
DefaultAzureCredentialResourceIdOptions

Stellt Optionen zum Konfigurieren der DefaultAzureCredential-Klasse bereit. Diese Variante unterstützt managedIdentityResourceId und nicht managedIdentityClientId, da nur eine von beiden unterstützt wird.
DeviceCodeCredentialOptions

Definiert Optionen für die InteractiveBrowserCredential-Klasse für Node.js.
DeviceCodeInfo

Stellt den Benutzercode und den Überprüfungs-URI bereit, in den der Code eingegeben werden muss. Stellt auch eine Meldung bereit, die dem Benutzer angezeigt werden soll, die eine Anweisung mit diesen Details enthält.
EnvironmentCredentialOptions

Ermöglicht die Authentifizierung Microsoft Entra ID abhängig von den verfügbaren Umgebungsvariablen. Definiert Optionen für die EnvironmentCredential-Klasse.
ErrorResponse

Weitere Informationen finden Sie in der offiziellen Dokumentation:

https://learn.microsoft.com/en-us/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1

HINWEIS: Diese Dokumentation bezieht sich auf die OAuth-Unterstützung v1, aber die gleichen Fehlerantwortdetails gelten weiterhin für v2.
GetTokenOptions

Definiert Optionen für TokenCredential.getToken.
InteractiveBrowserCredentialInBrowserOptions

Definiert die allgemeinen Optionen für die InteractiveBrowserCredential-Klasse.
InteractiveBrowserCredentialNodeOptions

Definiert die allgemeinen Optionen für die InteractiveBrowserCredential-Klasse.
InteractiveCredentialOptions

Allgemeine Konstruktoroptionen für die Identitätsanmeldeinformationen, die eine Benutzerinteraktion erfordern.
ManagedIdentityCredentialClientIdOptions

Optionen zum Senden auf dem ManagedIdentityCredential-Konstruktor . Diese Variante unterstützt clientId und nicht resourceId, da nur eine von beiden unterstützt wird.
ManagedIdentityCredentialResourceIdOptions

Optionen zum Senden auf dem ManagedIdentityCredential-Konstruktor . Diese Variante unterstützt resourceId und nicht clientId, da nur eine von beiden unterstützt wird.
MultiTenantTokenCredentialOptions

Optionen für mehrinstanzenfähige Anwendungen, die zusätzlich zulässige Mandanten ermöglichen.
OnBehalfOfCredentialCertificateOptions

Definiert die Parameter zum Authentifizieren von OnBehalfOfCredential mit einem Zertifikat.
OnBehalfOfCredentialSecretOptions

Definiert die Parameter zum Authentifizieren von OnBehalfOfCredential mit einem Geheimnis.
TokenCachePersistenceOptions

Parameter, die die Tokencachepersistenz in den Identitätsanmeldeinformationen aktivieren.
TokenCredential

Stellt eine Anmeldeinformation dar, die ein Authentifizierungstoken bereitstellen kann.
TokenCredentialOptions

Bietet Optionen zum Konfigurieren, wie die Identitätsbibliothek Authentifizierungsanforderungen an Microsoft Entra ID sendet.
UsernamePasswordCredentialOptions

Definiert Optionen für die UsernamePasswordCredential-Klasse .
VisualStudioCodeCredentialOptions

Stellt Optionen zum Konfigurieren der Visual Studio Code-Anmeldeinformationen bereit.
WorkloadIdentityCredentialOptions

Optionen für WorkloadIdentityCredential

Typaliase

BrokerOptions

Parameter, die die WAM-Brokerauthentifizierung in InteractiveBrowserCredential aktivieren.
BrowserLoginStyle

(Nur Browserfunktion) Der "Anmeldestil", der im Authentifizierungsflow verwendet werden soll:

  • "redirect" leitet den Benutzer zur Authentifizierungsseite um und leitet sie nach Abschluss der Authentifizierung wieder zur Seite um.
  • "popup" öffnet ein neues Browserfenster, durch das der Umleitungsflow initiiert wird. Das vorhandene Browserfenster des Benutzers verlässt die aktuelle Seite nicht.
ClientCertificateCredentialPEMConfiguration

Erforderliche Konfigurationsoptionen für ClientCertificateCredential mit entweder dem Zeichenfolgeninhalt eines PEM-Zertifikats oder dem Pfad zu einem PEM-Zertifikat.
DeviceCodePromptCallback

Definiert die Signatur eines Rückrufs, der an DeviceCodeCredential übergeben wird, um dem Benutzer Authentifizierungsdetails anzuzeigen.
IdentityPlugin

Der Typ eines Azure Identity-Plug-Ins, einer Funktion, die einen Plug-In-Kontext akzeptiert.
OnBehalfOfCredentialOptions

Optionale Parameter für die OnBehalfOfCredential-Klasse .

Enumerationen

AzureAuthorityHosts

Eine Liste bekannter Azure-Autoritätshosts

Functions

deserializeAuthenticationRecord(string)

Deserialisiert einen zuvor serialisierten Authentifizierungsdatensatz aus einer Zeichenfolge in ein -Objekt.

Die Eingabezeichenfolge muss die folgenden Eigenschaften enthalten:

  • "Autorität"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "Benutzername"
  • "Version"

Wenn die erhaltene Version nicht unterstützt wird, wird ein Fehler ausgelöst.

Derzeit ist nur "1.0" verfügbar, die immer festgelegt wird, wenn der Authentifizierungsdatensatz serialisiert wird.
getDefaultAzureCredential()

Gibt einen neuen instance der DefaultAzureCredential zurück.
serializeAuthenticationRecord(AuthenticationRecord)

Serialisiert eine AuthenticationRecord in eine Zeichenfolge.

Die Ausgabe eines serialisierten Authentifizierungsdatensatzes enthält die folgenden Eigenschaften:

  • "Autorität"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "Benutzername"
  • "Version"

Um diese Zeichenfolge später in eine serialisierte AuthenticationRecordzu konvertieren, verwenden Sie die exportierte Funktion deserializeAuthenticationRecord().
useIdentityPlugin(IdentityPlugin)

Erweitern Sie Azure Identity mit zusätzlichen Funktionen. Übergeben Sie ein Plug-In aus einem Plug-In-Paket, z. B.:

  • @azure/identity-cache-persistence: bietet persistente Tokenzwischenspeicherung
  • @azure/identity-vscode: stellt die Abhängigkeiten von VisualStudioCodeCredential bereit und aktiviert sie

Beispiel:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

Details zur Funktion

deserializeAuthenticationRecord(string)

Deserialisiert einen zuvor serialisierten Authentifizierungsdatensatz aus einer Zeichenfolge in ein -Objekt.

Die Eingabezeichenfolge muss die folgenden Eigenschaften enthalten:

  • "Autorität"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "Benutzername"
  • "Version"

Wenn die erhaltene Version nicht unterstützt wird, wird ein Fehler ausgelöst.

Derzeit ist nur "1.0" verfügbar, die immer festgelegt wird, wenn der Authentifizierungsdatensatz serialisiert wird.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Parameter

serializedRecord

string

Authentifizierungsdatensatz, der zuvor in Zeichenfolge serialisiert wurde.

Gibt zurück

AuthenticationRecord

AuthenticationRecord.

getDefaultAzureCredential()

Gibt einen neuen instance der DefaultAzureCredential zurück.

function getDefaultAzureCredential(): TokenCredential

Gibt zurück

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Serialisiert eine AuthenticationRecord in eine Zeichenfolge.

Die Ausgabe eines serialisierten Authentifizierungsdatensatzes enthält die folgenden Eigenschaften:

  • "Autorität"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "Benutzername"
  • "Version"

Um diese Zeichenfolge später in eine serialisierte AuthenticationRecordzu konvertieren, verwenden Sie die exportierte Funktion deserializeAuthenticationRecord().

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Parameter

record
AuthenticationRecord

Gibt zurück

string

useIdentityPlugin(IdentityPlugin)

Erweitern Sie Azure Identity mit zusätzlichen Funktionen. Übergeben Sie ein Plug-In aus einem Plug-In-Paket, z. B.:

  • @azure/identity-cache-persistence: bietet persistente Tokenzwischenspeicherung
  • @azure/identity-vscode: stellt die Abhängigkeiten von VisualStudioCodeCredential bereit und aktiviert sie

Beispiel:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

function useIdentityPlugin(plugin: IdentityPlugin)

Parameter

plugin
IdentityPlugin

das zu registrierende Plug-In