@azure/identity package

Fornisce una matrice di errors contenente 'istanza di AuthenticationError per gli errori di autenticazione delle credenziali in un ChainedTokenCredential.

Fornisce dettagli su un fallimento nell'autenticazione con Azure Active Directory. Il campo errorResponse contiene altri dettagli sull'errore specifico.

Errore usato per applicare l'autenticazione dopo aver tentato di recuperare un token in modo invisibile all'utente.

Abilita l'autenticazione di Microsoft Entra ID utilizzando un codice di autorizzazione ottenuto tramite il flusso di codice di autorizzazione, descritto in modo più dettagliato nella documentazione di Microsoft Entra ID:

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

Questa credenziale utilizzerà le informazioni di accesso utente attualmente logate tramite lo strumento a linea di comando interfaccia della riga di comando di Azure ('az'). Per farlo, leggerà il token di accesso utente e il tempo di scadenza con il comando interfaccia della riga di comando di Azure "az account get-access-token".

Azure Developer CLI è uno strumento di interfaccia a riga di comandi che permette agli sviluppatori di creare, gestire e distribuire risorse in Azure. È costruito sopra la interfaccia della riga di comando di Azure e offre funzionalità aggiuntive specifiche per gli sviluppatori Azure. Permette agli utenti di autenticarsi come utente e/o come principale di servizio contro Microsoft Entra ID. L'AzureDeveloperClidential si autentica in un ambiente di sviluppo e acquisisce un token per conto dell'utente o del principale del servizio effettuato l'accesso nella CLI di Azure Developer. Agisce come Azure Developer CLI per l'utente o il principale del servizio ed esegue un comando interfaccia della riga di comando di Azure sottostante per autenticare l'applicazione contro Microsoft Entra ID.

Configurare AzureDeveloperCliCredential

Per utilizzare questa credenziali, lo sviluppatore deve autenticarsi localmente nella CLI di Azure Developer utilizzando uno dei comandi riportati di seguito:

1. Esegui "azd auth login" nella CLI di Azure Developer per autenticarti interattivamente come utente.
2. Eseguire "azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID" per eseguire l'autenticazione come entità servizio.

Potrebbe essere necessario ripetere questo processo dopo un determinato periodo di tempo, a seconda della validità del token di aggiornamento nell'organizzazione. In genere, il periodo di validità del token di aggiornamento è di alcune settimane a pochi mesi. AzureDeveloperCliCredential richiederà di eseguire di nuovo l'accesso.

Questa credenziale è progettata per essere utilizzata in Azure Pipelines con connessioni di servizio come configurazione per la federazione dell'identità del carico di lavoro.

Questa credenziale utilizzerà le informazioni utente attualmente logate dal modulo Azure PowerShell. Per farlo, leggerà il token di accesso utente e il tempo di scadenza con Azure PowerShell comando Get-AzAccessToken -ResourceUrl {ResourceScope}

Consente di provare più implementazioni di TokenCredential in ordine fino a quando uno dei metodi getToken non restituisce un token di accesso. Per altre informazioni, vedere Panoramica di ChainedTokenCredential.

Autentica un'entità servizio con un'asserzione JWT.

Abilita l'autenticazione su Microsoft Entra ID utilizzando un certificato codificato in PEM assegnato a una registrazione app. Altre informazioni su come configurare l'autenticazione del certificato sono disponibili qui:

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

Abilita l'autenticazione a Microsoft Entra ID utilizzando un client secret generato per una registrazione dell'app. Altre informazioni su come configurare un segreto client sono disponibili qui:

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

Ciò significa che le credenziali tentate in una credenziale concatenato non erano disponibili per l'uso come credenziale. Invece di trattare questo come un errore che dovrebbe interrompere la catena, viene catturato e la catena continua

Fornisce una configurazione predefinita ChainedTokenCredential che funziona per la maggior parte delle applicazioni che utilizzano librerie client Azure SDK. Per altre informazioni, vedere Panoramica di DefaultAzureCredential.

Verranno provati i tipi di credenziali seguenti, in ordine:

• EnvironmentCredential
• WorkloadIdentityCredential
• ManagedIdentityCredential
• VisualStudioCodeCredential
• AzureCliCredential
• AzurePowerShellCredential
• AzureDeveloperCliCredential
• BrokerCredential (una credenziale abilitata per il broker che richiede @azure/identity-broker è installata)

Per altre informazioni su come tentano l'autenticazione, vedere la documentazione di questi tipi di credenziali.

Nell'esempio seguente viene illustrato come utilizzare l'opzione requiredEnvVars per assicurarsi che vengano impostate determinate variabili di ambiente prima che venga creata un'istanza DefaultAzureCredential . Se una delle variabili di ambiente specificate è mancante o vuota, verrà generato un errore, impedendo all'applicazione di continuare l'esecuzione senza la configurazione necessaria. Viene inoltre illustrato come impostare la AZURE_TOKEN_CREDENTIALS variabile di ambiente per controllare quali credenziali sono incluse nella catena.

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

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

Abilita l'autenticazione Microsoft Entra ID utilizzando un codice dispositivo che l'utente può inserire in https://microsoft.com/devicelogin.

Abilita l'autenticazione su Microsoft Entra ID utilizzando un client secret o certificato.

Abilita l'autenticazione a Microsoft Entra ID all'interno del browser web tramite il flusso di login interattivo.

Tenta di eseguire l'autenticazione usando un'identità gestita disponibile nell'ambiente di distribuzione. Questo tipo di autenticazione funziona in VM Azure, istanze App Service, applicazioni Funzioni di Azure, Azure Kubernetes Services, istanze Azure Service Fabric e all'interno di Azure Cloud Shell.

Altre informazioni sulla configurazione delle identità gestite sono disponibili qui: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview

Abilita l'autenticazione per Microsoft Entra ID utilizzando il On Behalf Of flow.

Abilita l'autenticazione a Microsoft Entra ID con il nome utente e la password dell'utente. Questa credenziale richiede un livello elevato di attendibilità, pertanto è consigliabile usarla solo quando non è possibile usare altri tipi di credenziali più sicuri.

Si connette ad Azure utilizzando l'account utente effettuato l'accesso tramite l'estensione Azure Resources in Visual Studio Code. Dopo che l'utente ha eseguito l'accesso tramite l'estensione, questa credenziale può condividere lo stesso token di aggiornamento memorizzato nella cache dall'estensione.

L'autenticazione dell'identità del carico di lavoro è una funzionalità in Azure che consente alle applicazioni in esecuzione su macchine virtuali (VM) di accedere ad altre risorse Azure senza la necessità di un principale di servizio o di un'identità gestita. Con l'autenticazione dell'identità del carico di lavoro, le applicazioni si autenticano usando la propria identità, invece di usare un'entità servizio condivisa o un'identità gestita. Sotto il cofano, l'autenticazione con Identità di Carico di Lavoro utilizza il concetto di Service Account Credentials (SAC), che vengono creati automaticamente da Azure e memorizzati in modo sicuro nella VM. Usando l'autenticazione dell'identità del carico di lavoro, è possibile evitare la necessità di gestire e ruotare entità servizio o identità gestite per ogni applicazione in ogni macchina virtuale. Inoltre, poiché i SAC vengono creati automaticamente e gestiti da Azure, non devi preoccuparti di memorizzare e proteggere le credenziali sensibili stesse. WorkloadIdentityCredential supporta l'autenticazione ID dei carichi di lavoro di Microsoft Entra su Azure Kubernetes e acquisisce un token utilizzando i SC disponibili nell'ambiente Azure Kubernetes. Consulta ID dei carichi di lavoro di Microsoft Entra per maggiori informazioni.

Rappresenta un token di accesso con una scadenza.

Record da usare per trovare i token memorizzati nella cache.

Parametri facoltativi per AuthenticationRequiredError

Fornisce opzioni per configurare come la libreria Identity effettua la validazione dell'autorità durante le richieste di autenticazione a Microsoft Entra ID.

Opzioni per il AuthorizationCodeCredential

Opzioni per AzureCliCredential

Opzioni per AzureDeveloperCliCredential

Parametri facoltativi per la classe azurePipelinesCredential .

Opzioni per AzurePowerShellCredential

Opzioni di configurazione per InteractiveBrowserCredential per supportare l'autenticazione del broker WAM.

Parametri quando l'autenticazione del broker WAM è disabilitata.

Parametri quando è abilitata l'autenticazione del broker WAM.

Opzioni di configurazione condivise per la personalizzazione del browser

Opzioni per ClientAssertionCredential

Parametri facoltativi per la classe clientCertificateCredential .

Opzioni di configurazione necessarie per il ClientCertificateCredential, con il contenuto stringa di un certificato PEM

Opzioni di configurazione necessarie per ClientCertificateCredential, con il percorso di un certificato PEM.

Parametri facoltativi per la classe clientSecretCredential .

Opzioni di configurazione condivise per le credenziali che supportano la memorizzazione nella cache dei token persistenti.

Fornisce opzioni per configurare la classe DefaultAzureCredential. Questa variante supporta managedIdentityClientId e non managedIdentityResourceId, poiché è supportata una sola di entrambe.

Fornisce opzioni per configurare la classe DefaultAzureCredential.

Fornisce opzioni per configurare la classe DefaultAzureCredential. Questa variante supporta managedIdentityResourceId e non managedIdentityClientId, poiché è supportata una sola di entrambe.

Definisce le opzioni per la classe InteractiveBrowserCredential per Node.js.

Fornisce il codice utente e l'URI di verifica in cui deve essere immesso il codice. Fornisce inoltre un messaggio da visualizzare all'utente che contiene un'istruzione con questi dettagli.

Abilita l'autenticazione su Microsoft Entra ID a seconda delle variabili di ambiente disponibili. Definisce le opzioni per la classe EnvironmentCredential.

Per altri dettagli, vedere la documentazione ufficiale:

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

NOTA: questa documentazione riguarda il supporto OAuth v1, ma gli stessi dettagli della risposta di errore si applicano comunque alla versione 2.

Opzioni per configurare il provider di token.

Definisce le opzioni per TokenCredential.getToken.

Definisce le opzioni comuni per la classe InteractiveBrowserCredential.

Definisce le opzioni comuni per la classe InteractiveBrowserCredential.

Opzioni comuni del costruttore per le credenziali di identità che richiedono l'interazione dell'utente.

Opzioni da inviare nel costruttore ManagedIdentityCredential . Questa variante supporta clientId e non resourceId, poiché è supportata una sola di entrambe.

Opzioni da inviare nel costruttore ManagedIdentityCredential . Questa variante supporta objectId come argomento del costruttore.

Opzioni da inviare nel costruttore ManagedIdentityCredential . Questa variante supporta resourceId e non clientId, poiché è supportata una sola di entrambe.

Opzioni per le applicazioni multi-tenant che consentono altri tenant consentiti.

Definisce i parametri per autenticare il OnBehalfOfCredential con un'asserzione.

Definisce i parametri per autenticare il OnBehalfOfCredential con un certificato.

Definisce i parametri per autenticare il OnBehalfOfCredential con un segreto.

Parametri che abilitano la persistenza della cache dei token nelle credenziali di identità.

Rappresenta una credenziale in grado di fornire un token di autenticazione.

Fornisce opzioni per configurare come la libreria Identity effettua richieste di autenticazione a Microsoft Entra ID.

Definisce le opzioni per la classe UsernamePasswordCredential.

Fornisce opzioni per configurare la credenziale Visual Studio Code.

Opzioni per il WorkloadIdentityCredential

Parametri che abilitano l'autenticazione del broker WAM in InteractiveBrowserCredential.

(Funzionalità solo browser) Lo "stile di accesso" da usare nel flusso di autenticazione:

• "redirect" reindirizza l'utente alla pagina di autenticazione e quindi li reindirizza alla pagina al termine dell'autenticazione.
• "popup" apre una nuova finestra del browser attraverso con il flusso di reindirizzamento viene avviato. La finestra del browser esistente dell'utente non lascia la pagina corrente

Opzioni di configurazione necessarie per il ClientCertificateCredential, con il contenuto stringa di un certificato PEM o il percorso di un certificato PEM.

Variabili di ambiente comunemente supportate per la classe DefaultAzureCredential .

Definisce la firma di un callback che verrà passato a DeviceCodeCredential allo scopo di visualizzare i dettagli di autenticazione all'utente.

Il tipo di plugin Azure Identity, una funzione che accetta un contesto di plugin.

Parametri facoltativi per la classe OnBehalfOfCredential.

Un elenco degli host di autorità Azure noti

Deserializza un record di autenticazione serializzato in precedenza da una stringa in un oggetto .

La stringa di input deve contenere le proprietà seguenti:

• "autorità"
• "homeAccountId"
• "ID cliente"
• "tenantId"
• "nome utente"
• "versione"

Se la versione ricevuta non è supportata, verrà generato un errore.

Al momento, l'unica versione disponibile è: "1.0", che viene sempre impostata quando il record di autenticazione viene serializzato.

Restituisce un callback che fornisce un token di connessione. Ad esempio, il token di connessione può essere usato per autenticare una richiesta come indicato di seguito:

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

Restituisce una nuova istanza del DefaultAzureCredential.

Serializza un AuthenticationRecord in una stringa.

L'output di un record di autenticazione serializzato conterrà le proprietà seguenti:

• "autorità"
• "homeAccountId"
• "ID cliente"
• "tenantId"
• "nome utente"
• "versione"

Per convertire successivamente questa stringa in un AuthenticationRecordserializzato, usare la funzione esportata deserializeAuthenticationRecord().

Estendi Azure Identity con funzionalità aggiuntive. Passare un plug-in da un pacchetto di plug-in, ad esempio:

• @azure/identity-cache-persistence: fornisce la memorizzazione nella cache dei token persistente
• @azure/identity-vscode: fornisce le dipendenze di VisualStudioCodeCredential e la abilita

Esempio:

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

Il valore Error.name di un AggregateAuthenticationError

Il valore Error.name di un AutenticationError

Il valore Error.name di una CredenzaNon disponibile

L'AzureLogger utilizzato per tutti i client all'interno del pacchetto identità