@azure/identity package
Klassen
AggregateAuthenticationError |
Stellt ein |
AuthenticationError |
Enthält Details zu einem Fehler bei der Authentifizierung bei Azure Active Directory. Das |
AuthenticationRequiredError |
Fehler, der verwendet wird, um die Authentifizierung zu erzwingen, nachdem versucht wurde, ein Token im Hintergrund abzurufen. |
AuthorizationCodeCredential |
Ermöglicht die Authentifizierung für Microsoft Entra ID mithilfe eines Autorisierungscodes, der über den Autorisierungscodeflow 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 Benutzeranmeldeinformationen über das Befehlszeilentool der Azure CLI ("az"). Dazu liest er das Benutzerzugriffstoken und die Ablaufzeit mit dem Azure CLI-Befehl "az account get-access-token". |
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 speziell für Azure-Entwickler. Es ermöglicht Benutzern, sich als Benutzer und/oder dienstprinzipal gegenüber 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 für Microsoft Entra ID zu authentifizieren. Konfigurieren von AzureDeveloperCliCredentialUm diese Anmeldeinformationen verwenden zu können, muss sich der Entwickler lokal in Azure Developer CLI mit einem der folgenden Befehle 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 die Ablaufzeit mit Azure PowerShell Befehl. |
ChainedTokenCredential |
Ermöglicht es, mehrere |
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: |
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: |
CredentialUnavailableError |
Dies bedeutet, dass die Anmeldeinformationen, die in einer verketteten Anmeldeinformation versucht wurden, nicht zur Verwendung als Anmeldeinformationen verfügbar waren. 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 in https://microsoft.com/devicelogineingeben kann. |
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 innerhalb des Webbrowsers mithilfe des interaktiven Anmeldeflows. |
ManagedIdentityCredential |
Versucht die Authentifizierung mithilfe einer verwalteten Identität, die in der Bereitstellungsumgebung verfügbar ist. Dieser Authentifizierungstyp funktioniert auf 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 mithilfe der von der VSCode-Erweiterung "Azure-Konto" bereitgestellten Anmeldeinformationen eine Verbindung mit Azure her. 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. Eine langfristige Lösung dieses Problems wird ausgeführt. In der Zwischenzeit sollten Sie die Authentifizierung mit AzureCliCredential in Erwägung ziehen. |
WorkloadIdentityCredential |
Die Workloadidentitätsauthentifizierung ist ein Feature in Azure, mit dem Anwendungen, die auf virtuellen Computern (VMs) ausgeführt werden, ohne dass ein Dienstprinzipal oder eine verwaltete Identität erforderlich ist, auf andere Azure-Ressourcen zugreifen können. Bei der Workloadidentitätsauthentifizierung authentifizieren sich Anwendungen selbst mit ihrer eigenen Identität, anstatt einen freigegebenen 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 der VM gespeichert werden. Durch die 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 mithilfe der in der Azure Kubernetes-Umgebung verfügbaren SACs ein Token ab. Weitere Informationen finden Sie unter Microsoft Entra Workload ID. |
Schnittstellen
AccessToken |
Stellt ein Zugriffstoken mit einer Ablaufzeit dar. |
AuthenticationRecord |
Der Datensatz, der verwendet werden soll, um die zwischengespeicherten Token im Cache zu suchen. |
AuthenticationRequiredErrorOptions |
Optionale Parameter für AuthenticationRequiredError |
AuthorityValidationOptions |
Bietet Optionen zum Konfigurieren der Überprüfung von Autoritäten durch die Identitätsbibliothek während der Authentifizierungsanforderungen an Microsoft Entra ID. |
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 |
DefaultAzureCredentialOptions |
Stellt Optionen zum Konfigurieren der DefaultAzureCredential-Klasse bereit. |
DefaultAzureCredentialResourceIdOptions |
Stellt Optionen zum Konfigurieren der DefaultAzureCredential-Klasse bereit.
Diese Variante unterstützt |
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 außerdem eine Meldung bereit, die dem Benutzer angezeigt werden soll, die eine Anweisung mit diesen Details enthält. |
EnvironmentCredentialOptions |
Ermöglicht die Authentifizierung, um abhängig von den verfügbaren Umgebungsvariablen Microsoft Entra ID. Definiert Optionen für die EnvironmentCredential-Klasse. |
ErrorResponse |
Weitere Informationen finden Sie in der offiziellen Dokumentation: HINWEIS: Diese Dokumentation bezieht sich auf die OAuth-Unterstützung von v1, aber die gleichen Fehlerantwortdetails gelten weiterhin für v2. |
GetBearerTokenProviderOptions |
Die Optionen zum Konfigurieren des Tokenanbieters. |
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 für den ManagedIdentityCredential-Konstruktor .
Diese Variante unterstützt |
ManagedIdentityCredentialResourceIdOptions |
Optionen zum Senden für den ManagedIdentityCredential-Konstruktor .
Diese Variante unterstützt |
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 Persistenz des Tokencaches in den Identitätsanmeldeinformationen aktivieren. |
TokenCredential |
Stellt anmeldeinformationen dar, die ein Authentifizierungstoken bereitstellen können. |
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:
|
ClientCertificateCredentialPEMConfiguration |
Erforderliche Konfigurationsoptionen für ClientCertificateCredential, entweder mit 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, eine Funktion, die einen Plug-In-Kontext akzeptiert. |
OnBehalfOfCredentialOptions |
Optionale Parameter für die OnBehalfOfCredential-Klasse . |
Enumerationen
AzureAuthorityHosts |
Eine Liste der bekannten Azure-Autoritätshosts |
Functions
deserialize |
Deserialisiert einen zuvor serialisierten Authentifizierungsdatensatz aus einer Zeichenfolge in ein -Objekt. Die Eingabezeichenfolge muss die folgenden Eigenschaften enthalten:
Wenn die empfangene Version nicht unterstützt wird, wird ein Fehler ausgelöst. Derzeit ist die einzige verfügbare Version "1.0", die immer festgelegt wird, wenn der Authentifizierungsdatensatz serialisiert wird. |
get |
Gibt einen Rückruf zurück, der ein Bearertoken bereitstellt. Beispielsweise kann das Bearertoken verwendet werden, um eine Anforderung wie folgt zu authentifizieren:
|
get |
Gibt eine neue instance von DefaultAzureCredential zurück. |
serialize |
Serialisiert eine Die Ausgabe eines serialisierten Authentifizierungsdatensatzes enthält die folgenden Eigenschaften:
Um diese Zeichenfolge später in eine serialisierte |
use |
Erweitern Sie Azure Identity um zusätzliche Funktionen. Übergeben Sie ein Plug-In aus einem Plug-In-Paket, z. B.:
Beispiel:
|
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 empfangene Version nicht unterstützt wird, wird ein Fehler ausgelöst.
Derzeit ist die einzige verfügbare Version "1.0", die immer festgelegt wird, wenn der Authentifizierungsdatensatz serialisiert wird.
function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord
Parameter
- serializedRecord
-
string
Authentifizierungsdatensatz, der zuvor in eine Zeichenfolge serialisiert wurde.
Gibt zurück
AuthenticationRecord.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)
Gibt einen Rückruf zurück, der ein Bearertoken bereitstellt. Beispielsweise kann das Bearertoken verwendet werden, um eine Anforderung wie folgt zu authentifizieren:
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const getAccessToken = getBearerTokenProvider(credential, scope);
const token = await getAccessToken();
// usage
const request = createPipelineRequest({ url: "https://example.com" });
request.headers.set("Authorization", `Bearer ${token}`);
function getBearerTokenProvider(credential: TokenCredential, scopes: string | string[], options?: GetBearerTokenProviderOptions): () => Promise<string>
Parameter
- credential
- TokenCredential
Die Anmeldeinformationen, die zum Authentifizieren der Anforderung verwendet werden.
- scopes
-
string | string[]
Die bereiche, die für das Bearertoken erforderlich sind.
- options
- GetBearerTokenProviderOptions
Optionen zum Konfigurieren des Tokenanbieters.
Gibt zurück
() => Promise<string>
ein Rückruf, der ein Bearertoken bereitstellt.
getDefaultAzureCredential()
Gibt eine neue instance von DefaultAzureCredential zurück.
function getDefaultAzureCredential(): TokenCredential
Gibt 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 AuthenticationRecord
zu 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 um zusätzliche 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 vonVisualStudioCodeCredential
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