Share via

@azure/identity package

  • Referentie

Klassen

AggregateAuthenticationError

Biedt een errors matrix met het AuthenticationError-exemplaar voor verificatiefouten van referenties in een ChainedTokenCredential.
AuthenticationError

Hier vindt u informatie over een mislukte verificatie met Azure Active Directory. Het errorResponse veld bevat meer informatie over de specifieke fout.
AuthenticationRequiredError

Fout die wordt gebruikt om verificatie af te dwingen na een poging om een token op de achtergrond op te halen.
AuthorizationCodeCredential

Hiermee schakelt u verificatie voor Microsoft Entra ID met behulp van een autorisatiecode die is verkregen via de autorisatiecodestroom, die in meer detail wordt beschreven in de Microsoft Entra ID documentatie:

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

Deze referentie maakt gebruik van de aanmeldingsgegevens van de momenteel aangemelde gebruiker via het opdrachtregelprogramma van Azure CLI ('az'). Om dit te doen, wordt het gebruikerstoegangstoken gelezen en verloopt de tijd met de Azure CLI-opdracht 'az account get-access-token'.
AzureDeveloperCliCredential

Azure Developer CLI is een opdrachtregelinterfaceprogramma waarmee ontwikkelaars resources in Azure kunnen maken, beheren en implementeren. Het is gebouwd op de Azure CLI en biedt aanvullende functionaliteit die specifiek is voor Azure-ontwikkelaars. Hiermee kunnen gebruikers zich verifiëren als een gebruiker en/of een service-principal op basis van Microsoft Entra ID. De AzureDeveloperCliCredential wordt geverifieerd in een ontwikkelomgeving en verkrijgt een token namens de aangemelde gebruiker of service-principal in de Azure Developer CLI. Het fungeert als de Azure Developer CLI aangemelde gebruiker of service-principal en voert een Azure CLI-opdracht eronder uit om de toepassing te verifiëren op basis van Microsoft Entra ID.

AzureDeveloperCliCredential configureren

Als u deze referentie wilt gebruiken, moet de ontwikkelaar zich lokaal verifiëren in Azure Developer CLI met behulp van een van de onderstaande opdrachten:

  1. Voer azd auth login uit in Azure Developer CLI om interactief als gebruiker te verifiëren.
  2. Voer azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID uit om te verifiëren als een service-principal.

Mogelijk moet u dit proces na een bepaalde periode herhalen, afhankelijk van de geldigheid van het vernieuwingstoken in uw organisatie. Over het algemeen is de geldigheidsperiode van het vernieuwingstoken enkele weken tot enkele maanden. AzureDeveloperCliCredential vraagt u om u opnieuw aan te melden.
AzurePowerShellCredential

Deze referentie gebruikt de momenteel aangemelde gebruikersgegevens uit de module Azure PowerShell. Om dit te doen, wordt het gebruikerstoegangstoken gelezen en verloopt de tijd met Azure PowerShell opdrachtGet-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Hiermee kunnen meerdere TokenCredential implementaties op volgorde worden geprobeerd totdat een van de getToken-methoden een toegangstoken retourneert.
ClientAssertionCredential

Hiermee wordt een service-principal geverifieerd met een JWT-assertie.
ClientCertificateCredential

Hiermee schakelt u verificatie voor Microsoft Entra ID met behulp van een PEM-gecodeerd certificaat dat is toegewezen aan een app-registratie. Meer informatie over het configureren van certificaatverificatie vindt u hier:

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

Hiermee schakelt u verificatie voor Microsoft Entra ID met behulp van een clientgeheim dat is gegenereerd voor een app-registratie. Meer informatie over het configureren van een clientgeheim vindt u hier:

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

Dit geeft aan dat de referentie die is geprobeerd in een gekoppelde referentie niet beschikbaar was om als referentie te worden gebruikt. In plaats van dit te behandelen als een fout die de keten zou moeten stoppen, wordt het ondervangen en gaat de keten door
DefaultAzureCredential

Biedt een standaardconfiguratie ChainedTokenCredential die moet werken voor de meeste toepassingen die gebruikmaken van de Azure SDK.
DeviceCodeCredential

Hiermee wordt verificatie voor Microsoft Entra ID ingeschakeld met behulp van een apparaatcode die de gebruiker kan invoeren in https://microsoft.com/devicelogin.
EnvironmentCredential

Hiermee schakelt u verificatie voor Microsoft Entra ID met behulp van een clientgeheim of certificaat, of als gebruiker met een gebruikersnaam en wachtwoord.
InteractiveBrowserCredential

Hiermee kunt u verificatie Microsoft Entra ID in de webbrowser met behulp van de interactieve aanmeldingsstroom.
ManagedIdentityCredential

Verificatie wordt geprobeerd met behulp van een beheerde identiteit die beschikbaar is in de implementatieomgeving. Dit verificatietype werkt in Azure-VM's, App Service-exemplaren, Azure Functions toepassingen, Azure Kubernetes Services, Azure Service Fabric-exemplaren en binnen de Azure Cloud Shell.

Meer informatie over het configureren van beheerde identiteiten vindt u hier: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Hiermee schakelt u verificatie voor Microsoft Entra ID met behulp van de stroom Namens van.
UsernamePasswordCredential

Hiermee schakelt u verificatie in voor Microsoft Entra ID met de gebruikersnaam en het wachtwoord van een gebruiker. Deze referentie vereist een hoge mate van vertrouwen, dus u moet deze alleen gebruiken wanneer andere, veiligere referentietypen niet kunnen worden gebruikt.
VisualStudioCodeCredential

Maakt verbinding met Azure met behulp van de referentie van de VSCode-extensie 'Azure-account'. Zodra de gebruiker zich heeft aangemeld via de extensie, kan deze referentie hetzelfde vernieuwingstoken delen dat door de extensie in de cache is opgeslagen.

Het is een bekend probleem dat deze referentie niet werkt met azure-accountextensieversies nieuwer dan 0.9.11. Er wordt gewerkt aan een oplossing voor de lange termijn voor dit probleem. In de tussentijd kunt u zich verifiëren met AzureCliCredential.
WorkloadIdentityCredential

Verificatie van workloadidentiteit is een functie in Azure waarmee toepassingen die worden uitgevoerd op virtuele machines (VM's) toegang hebben tot andere Azure-resources zonder dat er een service-principal of beheerde identiteit nodig is. Met verificatie van workloadidentiteit worden toepassingen geverifieerd met behulp van hun eigen identiteit, in plaats van een gedeelde service-principal of beheerde identiteit. Verificatie van workloadidentiteit maakt gebruik van het concept serviceaccountreferenties (SAC's), die automatisch worden gemaakt door Azure en veilig worden opgeslagen in de VIRTUELE machine. Door verificatie van workloadidentiteit te gebruiken, kunt u voorkomen dat u service-principals of beheerde identiteiten voor elke toepassing op elke VM moet beheren en roteren. Omdat SACs automatisch worden gemaakt en beheerd door Azure, hoeft u zich bovendien geen zorgen te maken over het opslaan en beveiligen van gevoelige referenties zelf. WorkloadIdentityCredential ondersteunt Microsoft Entra Workload-ID verificatie in Azure Kubernetes en verkrijgt een token met behulp van de SACs die beschikbaar zijn in de Azure Kubernetes-omgeving. Raadpleeg Microsoft Entra Workload-ID voor meer informatie.

Interfaces

AccessToken

Vertegenwoordigt een toegangstoken met een verlooptijd.
AuthenticationRecord

De record die moet worden gebruikt om de tokens in de cache te vinden.
AuthenticationRequiredErrorOptions

Optionele parameters voor de AuthenticationRequiredError
AuthorityValidationOptions

Biedt opties voor het configureren van de wijze waarop de identiteitsbibliotheek autorisatievalidatie uitvoert tijdens verificatieaanvragen voor Microsoft Entra ID.
AuthorizationCodeCredentialOptions

Opties voor de AuthorizationCodeCredential
AzureCliCredentialOptions

Opties voor de AzureCliCredential
AzureDeveloperCliCredentialOptions

Opties voor de AzureDeveloperCliCredential
AzurePowerShellCredentialOptions

Opties voor de AzurePowerShellCredential
BrokerAuthOptions

Configuratieopties voor InteractiveBrowserCredential ter ondersteuning van WAM Broker Authentication.
BrokerDisabledOptions

Parameters wanneer WAM-brokerverificatie is uitgeschakeld.
BrokerEnabledOptions

Parameters wanneer WAM-brokerverificatie is ingeschakeld.
BrowserCustomizationOptions

Gedeelde configuratieopties voor het aanpassen van de browser
ClientAssertionCredentialOptions

Opties voor de ClientAssertionCredential
ClientCertificateCredentialOptions

Optionele parameters voor de klasse ClientCertificateCredential .
ClientCertificatePEMCertificate

Vereiste configuratieopties voor de ClientCertificateCredential, met de tekenreeksinhoud van een PEM-certificaat
ClientCertificatePEMCertificatePath

Vereiste configuratieopties voor de ClientCertificateCredential, met het pad naar een PEM-certificaat.
ClientSecretCredentialOptions

Optionele parameters voor de klasse ClientSecretCredential .
CredentialPersistenceOptions

Gedeelde configuratieopties voor referenties die ondersteuning bieden voor permanente tokencache.
DefaultAzureCredentialClientIdOptions

Biedt opties voor het configureren van de klasse DefaultAzureCredential . Deze variatie ondersteunt managedIdentityClientId en niet managedIdentityResourceId, omdat slechts één van beide wordt ondersteund.
DefaultAzureCredentialOptions

Biedt opties voor het configureren van de klasse DefaultAzureCredential .
DefaultAzureCredentialResourceIdOptions

Biedt opties voor het configureren van de klasse DefaultAzureCredential . Deze variatie ondersteunt managedIdentityResourceId en niet managedIdentityClientId, omdat slechts één van beide wordt ondersteund.
DeviceCodeCredentialOptions

Hiermee definieert u opties voor de klasse InteractiveBrowserCredential voor Node.js.
DeviceCodeInfo

Geeft de gebruikerscode en verificatie-URI op waar de code moet worden ingevoerd. Biedt ook een bericht dat aan de gebruiker moet worden weergegeven met een instructie met deze details.
EnvironmentCredentialOptions

Hiermee schakelt u verificatie voor Microsoft Entra ID afhankelijk van de beschikbare omgevingsvariabelen. Hiermee definieert u opties voor de klasse EnvironmentCredential.
ErrorResponse

Zie de officiële documentatie voor meer informatie:

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

OPMERKING: deze documentatie is bedoeld voor OAuth-ondersteuning voor v1, maar dezelfde foutreactiedetails zijn nog steeds van toepassing op v2.
GetBearerTokenProviderOptions

De opties voor het configureren van de tokenprovider.
GetTokenOptions

Definieert opties voor TokenCredential.getToken.
InteractiveBrowserCredentialInBrowserOptions

Definieert de algemene opties voor de klasse InteractiveBrowserCredential.
InteractiveBrowserCredentialNodeOptions

Definieert de algemene opties voor de klasse InteractiveBrowserCredential.
InteractiveCredentialOptions

Algemene constructoropties voor de identiteitsreferenties waarvoor gebruikersinteractie is vereist.
ManagedIdentityCredentialClientIdOptions

Opties voor verzending op de constructor ManagedIdentityCredential . Deze variatie ondersteunt clientId en niet resourceId, omdat slechts één van beide wordt ondersteund.
ManagedIdentityCredentialResourceIdOptions

Opties voor verzending op de constructor ManagedIdentityCredential . Deze variatie ondersteunt resourceId en niet clientId, omdat slechts één van beide wordt ondersteund.
MultiTenantTokenCredentialOptions

Opties voor toepassingen met meerdere tenants die extra toegestane tenants mogelijk maken.
OnBehalfOfCredentialCertificateOptions

Definieert de parameters voor het verifiëren van de OnBehalfOfCredential met een certificaat.
OnBehalfOfCredentialSecretOptions

Definieert de parameters voor het verifiëren van de OnBehalfOfCredential met een geheim.
TokenCachePersistenceOptions

Parameters die persistentie van tokencache inschakelen in de identiteitsreferenties.
TokenCredential

Vertegenwoordigt een referentie die een verificatietoken kan leveren.
TokenCredentialOptions

Biedt opties voor het configureren van de wijze waarop de identiteitsbibliotheek verificatieaanvragen naar Microsoft Entra ID.
UsernamePasswordCredentialOptions

Hiermee definieert u opties voor de klasse UsernamePasswordCredential .
VisualStudioCodeCredentialOptions

Biedt opties voor het configureren van de Visual Studio Code-referentie.
WorkloadIdentityCredentialOptions

Opties voor WorkloadIdentityCredential

Type-aliassen

BrokerOptions

Parameters die WAM-brokerverificatie inschakelen in de InteractiveBrowserCredential.
BrowserLoginStyle

(Browserfunctie) De aanmeldingsstijl die moet worden gebruikt in de verificatiestroom:

  • 'omleiden' leidt de gebruiker om naar de verificatiepagina en leidt deze vervolgens terug naar de pagina zodra de verificatie is voltooid.
  • 'Pop-up' opent een nieuw browservenster door, waarbij de omleidingsstroom wordt gestart. Het bestaande browservenster van de gebruiker verlaat de huidige pagina niet
ClientCertificateCredentialPEMConfiguration

Vereiste configuratieopties voor de ClientCertificateCredential, met de tekenreeksinhoud van een PEM-certificaat of het pad naar een PEM-certificaat.
DeviceCodePromptCallback

Definieert de handtekening van een callback die wordt doorgegeven aan DeviceCodeCredential om verificatiedetails weer te geven aan de gebruiker.
IdentityPlugin

Het type van een Azure Identity-invoegtoepassing, een functie die de context van een invoegtoepassing accepteert.
OnBehalfOfCredentialOptions

Optionele parameters voor de klasse OnBehalfOfCredential .

Enums

AzureAuthorityHosts

Een lijst met bekende Azure Authority-hosts

Functies

deserializeAuthenticationRecord(string)

Verwijdert een eerder geserialiseerde verificatierecord van een tekenreeks naar een -object.

De invoerreeks moet de volgende eigenschappen bevatten:

  • "autoriteit"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "gebruikersnaam"
  • "versie"

Als de versie die we ontvangen niet wordt ondersteund, wordt er een fout gegenereerd.

Op dit moment is de enige beschikbare versie: "1.0", die altijd wordt ingesteld wanneer de verificatierecord wordt geserialiseerd.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Retourneert een callback die een Bearer-token levert. Het bearer-token kan bijvoorbeeld als volgt worden gebruikt om een aanvraag te verifiëren:

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

Retourneert een nieuw exemplaar van de DefaultAzureCredential.
serializeAuthenticationRecord(AuthenticationRecord)

Serialiseert een AuthenticationRecord in een tekenreeks.

De uitvoer van een geserialiseerde verificatierecord bevat de volgende eigenschappen:

  • "autoriteit"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "gebruikersnaam"
  • "versie"

Als u deze tekenreeks later wilt converteren naar een geserialiseerde AuthenticationRecord, gebruikt u de geëxporteerde functie deserializeAuthenticationRecord().
useIdentityPlugin(IdentityPlugin)

Azure Identity uitbreiden met extra functionaliteit. Geef een invoegtoepassing door vanuit een invoegtoepassingspakket, zoals:

  • @azure/identity-cache-persistence: biedt permanente tokencache
  • @azure/identity-vscode: biedt de afhankelijkheden van VisualStudioCodeCredential en schakelt deze in

Voorbeeld:

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

Functiedetails

deserializeAuthenticationRecord(string)

Verwijdert een eerder geserialiseerde verificatierecord van een tekenreeks naar een -object.

De invoerreeks moet de volgende eigenschappen bevatten:

  • "autoriteit"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "gebruikersnaam"
  • "versie"

Als de versie die we ontvangen niet wordt ondersteund, wordt er een fout gegenereerd.

Op dit moment is de enige beschikbare versie: "1.0", die altijd wordt ingesteld wanneer de verificatierecord wordt geserialiseerd.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Parameters

serializedRecord

string

Verificatierecord eerder geserialiseerd in tekenreeks.

Retouren

AuthenticationRecord

AuthenticationRecord.

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

Retourneert een callback die een Bearer-token levert. Het bearer-token kan bijvoorbeeld als volgt worden gebruikt om een aanvraag te verifiëren:

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>

Parameters

credential
TokenCredential

De referentie die wordt gebruikt om de aanvraag te verifiëren.

scopes

string | string[]

De bereiken die vereist zijn voor het bearer-token.

options
GetBearerTokenProviderOptions

Opties voor het configureren van de tokenprovider.

Retouren

() => Promise<string>

een callback die een Bearer-token biedt.

getDefaultAzureCredential()

Retourneert een nieuw exemplaar van de DefaultAzureCredential.

function getDefaultAzureCredential(): TokenCredential

Retouren

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Serialiseert een AuthenticationRecord in een tekenreeks.

De uitvoer van een geserialiseerde verificatierecord bevat de volgende eigenschappen:

  • "autoriteit"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "gebruikersnaam"
  • "versie"

Als u deze tekenreeks later wilt converteren naar een geserialiseerde AuthenticationRecord, gebruikt u de geëxporteerde functie deserializeAuthenticationRecord().

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Parameters

record
AuthenticationRecord

Retouren

string

useIdentityPlugin(IdentityPlugin)

Azure Identity uitbreiden met extra functionaliteit. Geef een invoegtoepassing door vanuit een invoegtoepassingspakket, zoals:

  • @azure/identity-cache-persistence: biedt permanente tokencache
  • @azure/identity-vscode: biedt de afhankelijkheden van VisualStudioCodeCredential en schakelt deze in

Voorbeeld:

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)

Parameters

plugin
IdentityPlugin

de invoegtoepassing om te registreren