@azure/identity package

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

Ger detaljer om ett misslyckande att autentisera sig med Azure Active Directory. Fältet errorResponse innehåller mer information om det specifika felet.

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

Möjliggör autentisering till Microsoft Entra ID med en auktoriseringskod som erhölls via auktoriseringskodflödet, beskriven mer i detalj i Microsoft Entra ID-dokumentationen:

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

Denna inloggning kommer att använda den inloggade användarinloggningsinformationen via kommandoradsverktyget Azure CLI ('az'). För att göra detta läser den användaråtkomsttoken och går ut tiden med Azure CLI-kommandot "az account get-access-token".

Azure Developer CLI är ett kommandoradsgränssnitt som gör det möjligt för utvecklare att skapa, hantera och distribuera resurser i Azure. Det är byggt ovanpå Azure CLI och erbjuder ytterligare funktionalitet specifik för Azure-utvecklare. Den tillåter användare att autentisera sig som användare och/eller tjänstehuvudman mot Microsoft Entra ID. AzureDeveloperCliCredential autentiseras i en utvecklingsmiljö och förvärvar en token på uppdrag av den inloggade användaren eller tjänstehuvudpersonen i Azure Developer CLI. Den fungerar som Azure Developer CLI som är inloggad användare eller tjänstehuvudperson och kör ett Azure CLI-kommando under för att autentisera applikationen mot Microsoft Entra ID.

Konfigurera AzureDeveloperCliCredential

För att använda denna behörighet måste utvecklaren autentisera sig lokalt i Azure Developer CLI med ett 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.

Denna behörighet är utformad för att användas i Azure-pipelines med serviceanslutningar som en setup för arbetsbelastningsidentitetsfederation.

Denna behörighet kommer att använda den för närvarande inloggade användarinformationen från Azure PowerShell-modulen. För att göra detta kommer den att läsa användaråtkomsttoken och förfallstiden med Azure PowerShell kommando Get-AzAccessToken -ResourceUrl {ResourceScope}

Gör att flera TokenCredential implementeringar kan provas i ordning tills någon av getToken-metoderna returnerar en åtkomsttoken. Mer information finns i översikten ChainedTokenCredential.

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

Möjliggör autentisering till Microsoft Entra ID med ett PEM-kodat certifikat som tilldelas en appregistrering. Mer information om hur du konfigurerar certifikatautentisering finns här:

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

Möjliggör autentisering till Microsoft Entra ID med hjälp av en klienthemlighet som genererats 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

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

Tillhandahåller en standardkonfiguration ChainedTokenCredential som fungerar för de flesta applikationer som använder Azure SDKs klientbibliotek. Mer information finns i Översikt över DefaultAzureCredential.

Följande typer av autentiseringsuppgifter kommer att provas i ordning:

• MiljöCredential
• WorkloadIdentityCredential
• HanteradIdentitetsautentisering
• VisualStudioCodeCredential
• AzureCliCredential
• AzurePowerShellCredential
• AzureDeveloperCliCredential
• BrokerCredential (en asynkron aktiverad autentiseringsuppgift som kräver @azure/identity-broker att den installeras)

Mer information om hur de försöker autentisering finns i dokumentationen för dessa typer av autentiseringsuppgifter.

I följande exempel visas hur du requiredEnvVars använder alternativet för att se till att vissa miljövariabler anges innan instansieras DefaultAzureCredential . Om någon av de angivna miljövariablerna saknas eller är tom genereras ett fel, vilket förhindrar att programmet fortsätter körningen utan den nödvändiga konfigurationen. Den visar också hur du ställer in miljövariabeln AZURE_TOKEN_CREDENTIALS för att styra vilka autentiseringsuppgifter som ingår i kedjan.

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});

Möjliggör autentisering för att Microsoft Entra ID med en enhetskod som användaren kan mata in i https://microsoft.com/devicelogin.

Möjliggör autentisering till Microsoft Entra ID med hjälp av en klienthemlighet eller certifikat.

Möjliggör autentisering till Microsoft Entra ID i webbläsaren via det interaktiva inloggningsflödet.

Försöker autentisering med hjälp av en hanterad identitet som är tillgänglig i distributionsmiljön. Denna autentiseringstyp fungerar i Azure-VM:er, App Service-instanser, Azure Functions-applikationer, 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/azure/active-directory/managed-identities-azure-resources/overview

Möjliggör autentisering för att Microsoft Entra ID med hjälp av På uppdrag av flödet.

Möjliggör autentisering mot 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.

Ansluter till Azure med användarkontot som är inloggat via Azure Resources-tillägget i Visual Studio Code. När användaren har loggat in via tillägget kan den här autentiseringsuppgiften dela samma uppdateringstoken som cachelagras av tillägget.

Autentisering av arbetsbelastningsidentitet är en funktion i Azure som gör det möjligt för applikationer som körs på virtuella maskiner (VM) att komma åt andra Azure-resurser utan behov av en tjänstehuvudperson eller 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 Workload Identity-autentisering konceptet Service Account Credentials (SACs), som automatiskt skapas av Azure och lagras säkert i VM:n. 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. Dessutom, eftersom SACs skapas automatiskt och hanteras av Azure, behöver du inte oroa dig för att lagra och säkra känsliga inloggningsuppgifter själva. WorkloadIdentityCredential stöder Microsoft Entra Workload ID-autentisering på Azure Kubernetes och förvärvar en token med hjälp av SACs som finns tillgängliga i Azure Kubernetes-miljön. Se Microsoft Entra Workload ID för mer information.

Representerar en åtkomsttoken med en förfallotid.

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

Valfria parametrar för AuthenticationRequiredError

Erbjuder alternativ för att konfigurera hur Identity-biblioteket gör auktoritetsvalidering under autentiseringsförfrågningar till Microsoft Entra ID.

Alternativ för AuthorizationCodeCredential

Alternativ för AzureCliCredential

Alternativ för AzureDeveloperCliCredential

Valfria parametrar för klassen AzurePipelinesCredential.

Alternativ för AzurePowerShellCredential-

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

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

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

Delade konfigurationsalternativ för webbläsaranpassning

Alternativ för ClientAssertionCredential

Valfria parametrar för klassen ClientCertificateCredential.

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

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

Valfria parametrar för klassen ClientSecretCredential.

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

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.

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

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.

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

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.

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

Mer information finns i den officiella dokumentationen:

https://learn.microsoft.com/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.

Alternativen för att konfigurera tokenprovidern.

Definierar alternativ för TokenCredential.getToken.

Definierar de vanliga alternativen för klassen InteractiveBrowserCredential.

Definierar de vanliga alternativen för klassen InteractiveBrowserCredential.

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

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.

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

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.

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

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

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

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

Parametrar som aktiverar cachepersistence för token i identitetsautentiseringsuppgifterna.

Representerar en autentiseringsuppgift som kan tillhandahålla en autentiseringstoken.

Ger alternativ för att konfigurera hur Identity-biblioteket gör autentiseringsförfrågningar till Microsoft Entra ID.

Definierar alternativ för klassen UsernamePasswordCredential.

Erbjuder alternativ för att konfigurera Visual Studio Code-behörigheten.

Alternativ för WorkloadIdentityCredential

Parametrar som aktiverar WAM-asynkron autentisering i InteractiveBrowserCredential.

(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

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

De miljövariabler som ofta stöds för DefaultAzureCredential klassen.

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

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

Valfria parametrar för klassen OnBehalfOfCredential.

En lista över kända Azure-auktoritetsvärdar

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.

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

Returnerar en ny instans av DefaultAzureCredential.

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().

Utöka Azure Identity med ytterligare funktionalitet. 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,
  },
});

Det Error.name värdet av en AggregateAuthenticationError

Det Error.name värdet av en AuthenticationError

Det Error.name värdet av en legitimation som inte finns tillgänglig

AzureLogger som används för alla klienter inom identitetspaketet