Dela via

@azure/identity package

  • Referens

Klasser

AggregateAuthenticationError

Innehåller en errors matris som innehåller AuthenticationError instans för autentiseringsfel från autentiseringsuppgifter i en ChainedTokenCredential-.
AuthenticationError

Innehåller information om att det inte gick att autentisera med Azure Active Directory. Fältet errorResponse innehåller mer information om det specifika felet.
AuthenticationRequiredError

Fel som används för att framtvinga autentisering efter att ha försökt hämta en token tyst.
AuthorizationCodeCredential

Aktiverar autentisering till Microsoft Entra-ID med hjälp av en auktoriseringskod som erhölls via auktoriseringskodflödet, som beskrivs mer detaljerat i Dokumentationen om Microsoft Entra-ID:

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

Den här autentiseringsuppgiften använder inloggningsinformationen för inloggade användare via kommandoradsverktyget Azure CLI ('az'). För att göra det läser den användaråtkomsttoken och upphör att gälla med Azure CLI-kommandot "az account get-access-token".
AzureDeveloperCliCredential

Azure Developer CLI är ett kommandoradsgränssnittsverktyg som gör att utvecklare kan skapa, hantera och distribuera resurser i Azure. Den bygger på Azure CLI och ger ytterligare funktioner som är specifika för Azure-utvecklare. Det gör att användare kan autentisera som en användare och/eller ett huvudnamn för tjänsten mot Microsoft Entra-ID. AzureDeveloperCliCredential autentiserar i en utvecklingsmiljö och hämtar en token för den inloggade användaren eller tjänstens huvudnamn i Azure Developer CLI. Den fungerar som Azure Developer CLI som loggas i användarens eller tjänstens huvudnamn och kör ett Azure CLI-kommando under för att autentisera programmet mot Microsoft Entra-ID.

Konfigurera AzureDeveloperCliCredential

För att kunna använda den här autentiseringsuppgiften måste utvecklaren autentisera lokalt i Azure Developer CLI med något av kommandona nedan:

  1. Kör "azd auth login" i Azure Developer CLI för att autentisera interaktivt som användare.
  2. Kör "azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID" för att autentisera som tjänstens huvudnamn.

Du kan behöva upprepa den här processen efter en viss tidsperiod, beroende på giltigheten för uppdateringstoken i din organisation. I allmänhet är giltighetsperioden för uppdateringstoken några veckor till några månader. AzureDeveloperCliCredential uppmanar dig att logga in igen.
AzurePipelinesCredential

Den här autentiseringsuppgiften är utformad för att användas i Azure Pipelines med tjänstanslutningar som en konfiguration för arbetsbelastningsidentitetsfederation.
AzurePowerShellCredential

Den här autentiseringsuppgiften använder den för närvarande inloggade användarinformationen från Azure PowerShell-modulen. Det gör den genom att läsa användaråtkomsttoken och förfalla tiden med Azure PowerShell-kommandot Get-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Gör att flera TokenCredential implementeringar kan provas i ordning tills någon av getToken-metoderna returnerar en åtkomsttoken.
ClientAssertionCredential

Autentiserar ett huvudnamn för tjänsten med en JWT-försäkran.
ClientCertificateCredential

Aktiverar autentisering till Microsoft Entra-ID med hjälp av ett PEM-kodat certifikat som har tilldelats till en appregistrering. Mer information om hur du konfigurerar certifikatautentisering finns här:

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

Aktiverar autentisering till Microsoft Entra-ID med hjälp av en klienthemlighet som genererades för en appregistrering. Mer information om hur du konfigurerar en klienthemlighet finns här:

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

Detta innebär att autentiseringsuppgifterna som provades i en länkad autentiseringsuppgift inte var tillgängliga för att användas som autentiseringsuppgifter. I stället för att behandla detta som ett fel som bör stoppa kedjan fångas den och kedjan fortsätter
DefaultAzureCredential

Tillhandahåller en standardkonfiguration ChainedTokenCredCredential som ska fungera för de flesta program som använder Azure SDK.
DeviceCodeCredential

Aktiverar autentisering till Microsoft Entra-ID med hjälp av en enhetskod som användaren kan ange i https://microsoft.com/devicelogin.
EnvironmentCredential

Aktiverar autentisering till Microsoft Entra-ID med hjälp av en klienthemlighet eller ett certifikat, eller som en användare med användarnamn och lösenord.
InteractiveBrowserCredential

Aktiverar autentisering till Microsoft Entra-ID i webbläsaren med hjälp av det interaktiva inloggningsflödet.
ManagedIdentityCredential

Försöker autentisering med hjälp av en hanterad identitet som är tillgänglig i distributionsmiljön. Den här autentiseringstypen fungerar i virtuella Azure-datorer, App Service-instanser, Azure Functions-program, Azure Kubernetes Services, Azure Service Fabric-instanser och inuti Azure Cloud Shell.

Mer information om hur du konfigurerar hanterade identiteter finns här: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Aktiverar autentisering till Microsoft Entra-ID med hjälp av På uppdrag av flödet.
UsernamePasswordCredential

Aktiverar autentisering till Microsoft Entra-ID med användarens användarnamn och lösenord. Den här autentiseringsuppgiften kräver en hög grad av förtroende, så du bör bara använda den när andra, säkrare typer av autentiseringsuppgifter inte kan användas.
VisualStudioCodeCredential

Ansluter till Azure med hjälp av autentiseringsuppgifterna som tillhandahålls av VSCode-tillägget "Azure-konto". När användaren har loggat in via tillägget kan den här autentiseringsuppgiften dela samma uppdateringstoken som cachelagras av tillägget.

Det är ett känt problem att den här autentiseringsuppgiften inte fungerar med Azure-kontotillägg versioner som är nyare än 0.9.11. En långsiktig korrigering av det här problemet pågår. Under tiden bör du överväga att autentisera med AzureCliCredential.
WorkloadIdentityCredential

Autentisering av arbetsbelastningsidentitet är en funktion i Azure som gör att program som körs på virtuella datorer (VM) kan komma åt andra Azure-resurser utan att det behövs ett huvudnamn för tjänsten eller en hanterad identitet. Med autentisering av arbetsbelastningsidentitet autentiserar sig program med sin egen identitet i stället för att använda ett huvudnamn för delad tjänst eller hanterad identitet. Under huven använder autentisering av arbetsbelastningsidentitet begreppet autentiseringsuppgifter för tjänstkonton som skapas automatiskt av Azure och lagras säkert på den virtuella datorn. Genom att använda autentisering av arbetsbelastningsidentitet kan du undvika behovet av att hantera och rotera tjänstens huvudnamn eller hanterade identiteter för varje program på varje virtuell dator. Eftersom SAN skapas automatiskt och hanteras av Azure behöver du inte bekymra dig om att lagra och skydda känsliga autentiseringsuppgifter själva. WorkloadIdentityCredential stöder Microsoft Entra-arbetsbelastnings-ID-autentisering i Azure Kubernetes och hämtar en token med hjälp av de SAC:er som är tillgängliga i Azure Kubernetes-miljön. Mer information finns i Microsoft Entra-arbetsbelastnings-ID.

Gränssnitt

AccessToken

Representerar en åtkomsttoken med en förfallotid.
AuthenticationRecord

Posten som ska användas för att hitta cachelagrade token i cacheminnet.
AuthenticationRequiredErrorOptions

Valfria parametrar för AuthenticationRequiredError
AuthorityValidationOptions

Innehåller alternativ för att konfigurera hur identitetsbiblioteket utfärdar verifiering vid autentiseringsbegäranden till Microsoft Entra-ID.
AuthorizationCodeCredentialOptions

Alternativ för AuthorizationCodeCredential
AzureCliCredentialOptions

Alternativ för AzureCliCredential
AzureDeveloperCliCredentialOptions

Alternativ för AzureDeveloperCliCredential
AzurePipelinesCredentialOptions

Valfria parametrar för klassen AzurePipelinesCredential.
AzurePowerShellCredentialOptions

Alternativ för AzurePowerShellCredential-
BrokerAuthOptions

Konfigurationsalternativ för InteractiveBrowserCredential för att stödja WAM Broker Authentication.
BrokerDisabledOptions

Parametrar när WAM-asynkron autentisering är inaktiverad.
BrokerEnabledOptions

Parametrar när WAM-asynkron autentisering är aktiverat.
BrowserCustomizationOptions

Delade konfigurationsalternativ för webbläsaranpassning
ClientAssertionCredentialOptions

Alternativ för ClientAssertionCredential
ClientCertificateCredentialOptions

Valfria parametrar för klassen ClientCertificateCredential.
ClientCertificatePEMCertificate

Nödvändiga konfigurationsalternativ för ClientCertificateCredential, med stränginnehållet i ett PEM-certifikat
ClientCertificatePEMCertificatePath

Nödvändiga konfigurationsalternativ för ClientCertificateCredential, med sökvägen till ett PEM-certifikat.
ClientSecretCredentialOptions

Valfria parametrar för klassen ClientSecretCredential.
CredentialPersistenceOptions

Delade konfigurationsalternativ för autentiseringsuppgifter som stöder beständig tokencachelagring.
DefaultAzureCredentialClientIdOptions

Innehåller alternativ för att konfigurera klassen DefaultAzureCredential. Den här varianten stöder managedIdentityClientId och inte managedIdentityResourceIdeftersom endast en av båda stöds.
DefaultAzureCredentialOptions

Innehåller alternativ för att konfigurera klassen DefaultAzureCredential.
DefaultAzureCredentialResourceIdOptions

Innehåller alternativ för att konfigurera klassen DefaultAzureCredential. Den här varianten stöder managedIdentityResourceId och inte managedIdentityClientIdeftersom endast en av båda stöds.
DeviceCodeCredentialOptions

Definierar alternativ för klassen InteractiveBrowserCredential för Node.js.
DeviceCodeInfo

Tillhandahåller användarkoden och verifierings-URI:n där koden måste anges. Innehåller också ett meddelande som ska visas för användaren som innehåller en instruktion med den här informationen.
EnvironmentCredentialOptions

Aktiverar autentisering till Microsoft Entra-ID beroende på tillgängliga miljövariabler. Definierar alternativ för klassen EnvironmentCredential.
ErrorResponse

Mer information finns i den officiella dokumentationen:

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

Obs! Den här dokumentationen gäller för v1 OAuth-stöd, men samma felsvarsinformation gäller fortfarande för v2.
GetBearerTokenProviderOptions

Alternativen för att konfigurera tokenprovidern.
GetTokenOptions

Definierar alternativ för TokenCredential.getToken.
InteractiveBrowserCredentialInBrowserOptions

Definierar de vanliga alternativen för klassen InteractiveBrowserCredential.
InteractiveBrowserCredentialNodeOptions

Definierar de vanliga alternativen för klassen InteractiveBrowserCredential.
InteractiveCredentialOptions

Vanliga konstruktoralternativ för identitetsautentiseringsuppgifter som kräver användarinteraktion.
ManagedIdentityCredentialClientIdOptions

Alternativ för att skicka på konstruktorn ManagedIdentityCredential. Den här varianten stöder clientId och inte resourceIdeftersom endast en av båda stöds.
ManagedIdentityCredentialObjectIdOptions

Alternativ för att skicka på konstruktorn ManagedIdentityCredential. Den här varianten stöder objectId som ett konstruktorargument.
ManagedIdentityCredentialResourceIdOptions

Alternativ för att skicka på konstruktorn ManagedIdentityCredential. Den här varianten stöder resourceId och inte clientIdeftersom endast en av båda stöds.
MultiTenantTokenCredentialOptions

Alternativ för program med flera klientorganisationer som tillåter ytterligare tillåtna klientorganisationer.
OnBehalfOfCredentialAssertionOptions

Definierar parametrarna för att autentisera OnBehalfOfCredential- med en försäkran.
OnBehalfOfCredentialCertificateOptions

Definierar parametrarna för att autentisera OnBehalfOfCredential- med ett certifikat.
OnBehalfOfCredentialSecretOptions

Definierar parametrarna för att autentisera OnBehalfOfCredential- med en hemlighet.
TokenCachePersistenceOptions

Parametrar som aktiverar cachepersistence för token i identitetsautentiseringsuppgifterna.
TokenCredential

Representerar en autentiseringsuppgift som kan tillhandahålla en autentiseringstoken.
TokenCredentialOptions

Innehåller alternativ för att konfigurera hur identitetsbiblioteket gör autentiseringsbegäranden till Microsoft Entra-ID.
UsernamePasswordCredentialOptions

Definierar alternativ för klassen UsernamePasswordCredential.
VisualStudioCodeCredentialOptions

Innehåller alternativ för att konfigurera Visual Studio Code-autentiseringsuppgifterna.
WorkloadIdentityCredentialOptions

Alternativ för WorkloadIdentityCredential

Typalias

BrokerOptions

Parametrar som aktiverar WAM-asynkron autentisering i InteractiveBrowserCredential.
BrowserLoginStyle

(Endast webbläsarfunktion) Inloggningsformatet som ska användas i autentiseringsflödet:

  • "omdirigera" omdirigerar användaren till autentiseringssidan och omdirigerar dem sedan tillbaka till sidan när autentiseringen har slutförts.
  • "popup" öppnar ett nytt webbläsarfönster med omdirigeringsflödet initierat. Användarens befintliga webbläsarfönster lämnar inte den aktuella sidan
ClientCertificateCredentialPEMConfiguration

Nödvändiga konfigurationsalternativ för ClientCertificateCredential, med antingen stränginnehållet i ett PEM-certifikat eller sökvägen till ett PEM-certifikat.
DeviceCodePromptCallback

Definierar signaturen för ett återanrop som skickas till DeviceCodeCredential i syfte att visa autentiseringsinformation för användaren.
IdentityPlugin

Typen av ett Azure Identity-plugin-program, en funktion som accepterar en plugin-kontext.
OnBehalfOfCredentialOptions

Valfria parametrar för klassen OnBehalfOfCredential.

Uppräkningar

AzureAuthorityHosts

En lista över kända Azure-utfärdarvärdar

Funktioner

deserializeAuthenticationRecord(string)

Deserialiserar en tidigare serialiserad autentiseringspost från en sträng till ett objekt.

Indatasträngen måste innehålla följande egenskaper:

  • "auktoritet"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "användarnamn"
  • "version"

Om den version som vi får inte stöds utlöses ett fel.

För närvarande är den enda tillgängliga versionen: "1.0", som alltid anges när autentiseringsposten serialiseras.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Returnerar ett återanrop som tillhandahåller en ägartoken. Till exempel kan ägartoken användas för att autentisera en begäran på följande sätt:

import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
import { createPipelineRequest } from "@azure/core-rest-pipeline";

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}`);
getDefaultAzureCredential()

Returnerar en ny instans av DefaultAzureCredential.
serializeAuthenticationRecord(AuthenticationRecord)

Serialiserar en AuthenticationRecord till en sträng.

Utdata från en serialiserad autentiseringspost innehåller följande egenskaper:

  • "auktoritet"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "användarnamn"
  • "version"

Om du senare vill konvertera strängen till en serialiserad AuthenticationRecordanvänder du den exporterade funktionen deserializeAuthenticationRecord().
useIdentityPlugin(IdentityPlugin)

Utöka Azure Identity med ytterligare funktioner. Skicka ett plugin-program från ett plugin-paket, till exempel:

  • @azure/identity-cache-persistence: tillhandahåller beständig tokencachelagring
  • @azure/identity-vscode: tillhandahåller beroenden för VisualStudioCodeCredential och aktiverar det

Exempel:

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

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

Funktionsinformation

deserializeAuthenticationRecord(string)

Deserialiserar en tidigare serialiserad autentiseringspost från en sträng till ett objekt.

Indatasträngen måste innehålla följande egenskaper:

  • "auktoritet"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "användarnamn"
  • "version"

Om den version som vi får inte stöds utlöses ett fel.

För närvarande är den enda tillgängliga versionen: "1.0", som alltid anges när autentiseringsposten serialiseras.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Parametrar

serializedRecord

string

Autentiseringsposten serialiserades tidigare till sträng.

Returer

AuthenticationRecord

AuthenticationRecord.

getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Returnerar ett återanrop som tillhandahåller en ägartoken. Till exempel kan ägartoken användas för att autentisera en begäran på följande sätt:

import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
import { createPipelineRequest } from "@azure/core-rest-pipeline";

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>

Parametrar

credential
TokenCredential

Autentiseringsuppgifterna som används för att autentisera begäran.

scopes

string | string[]

De omfång som krävs för ägartoken.

options
GetBearerTokenProviderOptions

Alternativ för att konfigurera tokenprovidern.

Returer

() => Promise<string>

ett återanrop som tillhandahåller en ägartoken.

getDefaultAzureCredential()

Returnerar en ny instans av DefaultAzureCredential.

function getDefaultAzureCredential(): TokenCredential

Returer

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Serialiserar en AuthenticationRecord till en sträng.

Utdata från en serialiserad autentiseringspost innehåller följande egenskaper:

  • "auktoritet"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "användarnamn"
  • "version"

Om du senare vill konvertera strängen till en serialiserad AuthenticationRecordanvänder du den exporterade funktionen deserializeAuthenticationRecord().

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Parametrar

record
AuthenticationRecord

Returer

string

useIdentityPlugin(IdentityPlugin)

Utöka Azure Identity med ytterligare funktioner. Skicka ett plugin-program från ett plugin-paket, till exempel:

  • @azure/identity-cache-persistence: tillhandahåller beständig tokencachelagring
  • @azure/identity-vscode: tillhandahåller beroenden för VisualStudioCodeCredential och aktiverar det

Exempel:

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

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

function useIdentityPlugin(plugin: IdentityPlugin)

Parametrar

plugin
IdentityPlugin

plugin-programmet för att registrera