Delen via

@azure/identity package

  • Referentie

Klassen

AggregateAuthenticationError

Biedt een errors matrix met 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

Er is een fout opgetreden bij het afdwingen van verificatie nadat een token op de achtergrond is opgehaald.
AuthorizationCodeCredential

Hiermee schakelt u verificatie voor Microsoft Entra-id in met behulp van een autorisatiecode die is verkregen via de autorisatiecodestroom, zoals beschreven in de Documentatie voor Microsoft Entra-id:

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

Deze referentie gebruikt de momenteel aangemelde gebruikersaanmeldingsgegevens via het opdrachtregelprogramma van Azure CLI ('az'). Hiervoor wordt het toegangstoken van de gebruiker 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 basis van 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. AzureDeveloperCliCredential verifieert zich 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 die is aangemeld bij de gebruiker of service-principal en voert een Azure CLI-opdracht eronder uit om de toepassing te verifiëren bij 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 te verifiëren als gebruiker.
  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 een paar weken tot een paar maanden. AzureDeveloperCliCredential vraagt u zich opnieuw aan te melden.
AzurePipelinesCredential

Deze referentie is ontworpen voor gebruik in Azure Pipelines met serviceverbindingen als installatie voor federatie van workloadidentiteit.
AzurePowerShellCredential

Deze referentie gebruikt de momenteel aangemelde gebruikersgegevens uit de Azure PowerShell-module. Hiervoor wordt het toegangstoken van de gebruiker gelezen en verloopt de tijd met de Azure PowerShell-opdracht Get-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

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

Verifieert een service-principal met een JWT-assertie.
ClientCertificateCredential

Hiermee schakelt u verificatie in 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 in 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

Hiermee wordt aangegeven 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 moet stoppen, wordt deze onderschept en wordt de keten voortgezet
DefaultAzureCredential

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

Hiermee schakelt u verificatie voor Microsoft Entra-id in met behulp van een apparaatcode die de gebruiker in https://microsoft.com/deviceloginkan invoeren.
EnvironmentCredential

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

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

Hiermee probeert u verificatie uit te voeren 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 in 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 in met behulp van de Namens stroom.
UsernamePasswordCredential

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

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

Het is een bekend probleem dat deze referentie niet werkt met Azure-accountextensie nieuwere versies dan 0.9.11. Er wordt een langetermijnoplossing voor dit probleem uitgevoerd. 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 verifiëren toepassingen zichzelf met hun eigen identiteit in plaats van een gedeelde service-principal of beheerde identiteit te gebruiken. Onder de schermen maakt verificatie van workload-identiteit gebruik van het concept serviceaccountreferenties (SAC's), die automatisch worden gemaakt door Azure en veilig worden opgeslagen in de VIRTUELE machine. Met behulp van verificatie van workloadidentiteit kunt u voorkomen dat u service-principals of beheerde identiteiten voor elke toepassing op elke VIRTUELE machine moet beheren en roteren. Bovendien hoeft u zich geen zorgen te maken over het opslaan en beveiligen van gevoelige referenties zelf, omdat SAC's automatisch en beheerd worden door Azure. WorkloadIdentityCredential biedt ondersteuning voor Verificatie van Microsoft Entra-workload-id's in Azure Kubernetes en verkrijgt een token met behulp van de SAC's 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 om te configureren hoe 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-
AzurePipelinesCredentialOptions

Optionele parameters voor de klasse AzurePipelinesCredential.
AzurePowerShellCredentialOptions

Opties voor de AzurePowerShellCredential-
BrokerAuthOptions

Configuratieopties voor InteractiveBrowserCredential ter ondersteuning van WAM Broker Authentication.
BrokerDisabledOptions

Parameters wanneer WAM Broker-verificatie is uitgeschakeld.
BrokerEnabledOptions

Parameters wanneer WAM Broker-verificatie is ingeschakeld.
BrowserCustomizationOptions

Gedeelde configuratieopties voor browseraanpassing
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 permanente tokencaching ondersteunen.
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

Definieert opties voor de klasse InteractiveBrowserCredential voor Node.js.
DeviceCodeInfo

Biedt de gebruikerscode en verificatie-URI waar de code moet worden ingevoerd. Biedt ook een bericht om weer te geven aan de gebruiker die een instructie bevat met deze details.
EnvironmentCredentialOptions

Hiermee schakelt u verificatie naar Microsoft Entra-id in, afhankelijk van de beschikbare omgevingsvariabelen. Hiermee definieert u opties voor de klasse EnvironmentCredential.
ErrorResponse

Raadpleeg 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 ondersteuning voor v1 OAuth, 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 verzenden op de ManagedIdentityCredential constructor. Deze variatie ondersteunt clientId en niet resourceId, omdat slechts één van beide wordt ondersteund.
ManagedIdentityCredentialResourceIdOptions

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

Opties voor toepassingen met meerdere tenants waarmee aanvullende toegestane tenants kunnen worden toegestaan.
OnBehalfOfCredentialAssertionOptions

Definieert de parameters voor het verifiëren van de OnBehalfOfCredential- met een assertie.
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 doet voor 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 de WorkloadIdentityCredential-

Type-aliassen

BrokerOptions

Parameters die WAM Broker-verificatie inschakelen in interactiveBrowserCredential.
BrowserLoginStyle

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

  • Met 'omleiden' wordt de gebruiker omgeleid naar de verificatiepagina en wordt deze vervolgens teruggeleid naar de pagina zodra de verificatie is voltooid.
  • 'pop-up' opent een nieuw browservenster via de omleidingsstroom wordt gestart. Het bestaande browservenster van de gebruiker laat de huidige pagina niet staan
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 voor het weergeven van verificatiedetails aan de gebruiker.
IdentityPlugin

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

Optionele parameters voor de klasse OnBehalfOfCredential.

Enums

AzureAuthorityHosts

Een lijst met bekende Azure-instantiehosts

Functies

deserializeAuthenticationRecord(string)

Deserializeert een eerder geserialiseerde verificatierecord van een tekenreeks in een object.

De invoertekenreeks 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 is ingesteld wanneer de verificatierecord wordt geserialiseerd.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Retourneert een callback die een bearer-token biedt. 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)

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

  • @azure/identity-cache-persistence: biedt permanente tokencaching
  • @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)

Deserializeert een eerder geserialiseerde verificatierecord van een tekenreeks in een object.

De invoertekenreeks 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 is 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 biedt. 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)

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

  • @azure/identity-cache-persistence: biedt permanente tokencaching
  • @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 voor registratie