Partager via

DeviceCodeCredentialOptions interface

  • Référence
Paquet:
@azure/identity

Définit les options de la classe InteractiveBrowserCredential pour Node.js.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Propriétés

clientId

ID client de l’application Microsoft Entra que les utilisateurs se connectent. Il est recommandé aux développeurs d’inscrire leurs applications et d’attribuer des rôles appropriés. Pour plus d’informations, visitez https://aka.ms/identity/AppRegistrationAndRoleAssignment. S’il n’est pas spécifié, les utilisateurs s’authentifient auprès d’une application de développement Azure, ce qui n’est pas recommandé pour les scénarios de production.
tenantId

ID du locataire Microsoft Entra (répertoire).
userPromptCallback

Fonction de rappel qui sera appelée pour afficher DeviceCodeInfo à l’utilisateur. Si elle n’est pas attribuée, nous journaliserons automatiquement les informations de code de l’appareil et les instructions d’authentification dans la console.

Propriétés héritées

additionallyAllowedTenants

Pour les applications multilocataires, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons. Ajoutez la valeur générique « * » pour permettre aux informations d’identification d’acquérir des jetons pour n’importe quel locataire que l’application est installé.
additionalPolicies

Stratégies supplémentaires à inclure dans le pipeline HTTP.
allowInsecureConnection

Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS
authenticationRecord

Résultat d’une authentification précédente qui peut être utilisée pour récupérer les informations d’identification mises en cache de chaque compte individuel. Cela est nécessaire pour fournir dans le cas où l’application souhaite utiliser plusieurs comptes par ID client et paire ID de locataire.

Cet enregistrement peut être récupéré en appelant la méthode authenticate() des informations d’identification, comme suit :

const authenticationRecord = await credential.authenticate();
authorityHost

Hôte d’autorité à utiliser pour les demandes d’authentification. Les valeurs possibles sont disponibles via AzureAuthorityHosts. La valeur par défaut est «https://login.microsoftonline.com".
disableAutomaticAuthentication

Génère getToken si une authentification manuelle est nécessaire. Les développeurs devront appeler authenticate() pour contrôler quand s’authentifier manuellement.
disableInstanceDiscovery

Le champ détermine si la découverte d’instances est effectuée lors de la tentative d’authentification. La définition de ce paramètre sur true désactive complètement la découverte d’instances et la validation de l’autorité. Par conséquent, il est essentiel de s’assurer que l’hôte d’autorité configuré est valide et fiable. Cette fonctionnalité est destinée à être utilisée dans les scénarios où le point de terminaison de métadonnées ne peut pas être atteint, comme dans des clouds privés ou Azure Stack. Le processus de découverte d’instance implique la récupération des métadonnées d’autorité à partir de https://login.microsoft.com/ pour valider l’autorité.
httpClient

HttpClient qui sera utilisé pour envoyer des requêtes HTTP.
loggingOptions

Permet aux utilisateurs de configurer des paramètres pour les options de stratégie de journalisation, d’autoriser la journalisation des informations de compte et des informations d’identification personnelle pour le support client.
proxyOptions

Options de configuration d’un proxy pour les demandes sortantes.
redirectOptions

Options de gestion des réponses de redirection.
retryOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.
telemetryOptions

Options permettant de définir les informations de télémétrie et de suivi courantes sur les requêtes sortantes.
tlsOptions

Options de configuration de l’authentification TLS
tokenCachePersistenceOptions

Options à fournir à la couche de persistance (le cas échéant) lors du stockage des informations d’identification.

Vous devez d’abord inscrire un plug-in de fournisseur de persistance. Consultez le package @azure/identity-cache-persistence sur NPM.

Exemple:

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

useIdentityPlugin(cachePersistencePlugin);
const credential = new DeviceCodeCredential({
  tokenCachePersistenceOptions: {
    enabled: true,
  },
});
userAgentOptions

Options d’ajout de détails de l’agent utilisateur aux demandes sortantes.

Détails de la propriété

clientId

ID client de l’application Microsoft Entra que les utilisateurs se connectent. Il est recommandé aux développeurs d’inscrire leurs applications et d’attribuer des rôles appropriés. Pour plus d’informations, visitez https://aka.ms/identity/AppRegistrationAndRoleAssignment. S’il n’est pas spécifié, les utilisateurs s’authentifient auprès d’une application de développement Azure, ce qui n’est pas recommandé pour les scénarios de production.

clientId?: string

Valeur de propriété

string

tenantId

ID du locataire Microsoft Entra (répertoire).

tenantId?: string

Valeur de propriété

string

userPromptCallback

Fonction de rappel qui sera appelée pour afficher DeviceCodeInfo à l’utilisateur. Si elle n’est pas attribuée, nous journaliserons automatiquement les informations de code de l’appareil et les instructions d’authentification dans la console.

userPromptCallback?: DeviceCodePromptCallback

Valeur de propriété

DeviceCodePromptCallback

Détails de la propriété héritée

additionallyAllowedTenants

Pour les applications multilocataires, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons. Ajoutez la valeur générique « * » pour permettre aux informations d’identification d’acquérir des jetons pour n’importe quel locataire que l’application est installé.

additionallyAllowedTenants?: string[]

Valeur de propriété

string[]

héritée deInteractiveCredentialOptions.en outreAllowedTenants

additionalPolicies

Stratégies supplémentaires à inclure dans le pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valeur de propriété

AdditionalPolicyConfig[]

héritée deInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS

allowInsecureConnection?: boolean

Valeur de propriété

boolean

héritée deInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Résultat d’une authentification précédente qui peut être utilisée pour récupérer les informations d’identification mises en cache de chaque compte individuel. Cela est nécessaire pour fournir dans le cas où l’application souhaite utiliser plusieurs comptes par ID client et paire ID de locataire.

Cet enregistrement peut être récupéré en appelant la méthode authenticate() des informations d’identification, comme suit :

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Valeur de propriété

AuthenticationRecord

héritée deInteractiveCredentialOptions.authenticationRecord

authorityHost

Hôte d’autorité à utiliser pour les demandes d’authentification. Les valeurs possibles sont disponibles via AzureAuthorityHosts. La valeur par défaut est «https://login.microsoftonline.com".

authorityHost?: string

Valeur de propriété

string

héritée deInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Génère getToken si une authentification manuelle est nécessaire. Les développeurs devront appeler authenticate() pour contrôler quand s’authentifier manuellement.

disableAutomaticAuthentication?: boolean

Valeur de propriété

boolean

héritée deInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Le champ détermine si la découverte d’instances est effectuée lors de la tentative d’authentification. La définition de ce paramètre sur true désactive complètement la découverte d’instances et la validation de l’autorité. Par conséquent, il est essentiel de s’assurer que l’hôte d’autorité configuré est valide et fiable. Cette fonctionnalité est destinée à être utilisée dans les scénarios où le point de terminaison de métadonnées ne peut pas être atteint, comme dans des clouds privés ou Azure Stack. Le processus de découverte d’instance implique la récupération des métadonnées d’autorité à partir de https://login.microsoft.com/ pour valider l’autorité.

disableInstanceDiscovery?: boolean

Valeur de propriété

boolean

héritée deInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient qui sera utilisé pour envoyer des requêtes HTTP.

httpClient?: HttpClient

Valeur de propriété

HttpClient

héritée deInteractiveCredentialOptions.httpClient

loggingOptions

Permet aux utilisateurs de configurer des paramètres pour les options de stratégie de journalisation, d’autoriser la journalisation des informations de compte et des informations d’identification personnelle pour le support client.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Valeur de propriété

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

héritée deInteractiveCredentialOptions.loggingOptions

proxyOptions

Options de configuration d’un proxy pour les demandes sortantes.

proxyOptions?: ProxySettings

Valeur de propriété

ProxySettings

héritée deInteractiveCredentialOptions.proxyOptions

redirectOptions

Options de gestion des réponses de redirection.

redirectOptions?: RedirectPolicyOptions

Valeur de propriété

RedirectPolicyOptions

héritée deInteractiveCredentialOptions.redirectOptions

retryOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.

retryOptions?: PipelineRetryOptions

Valeur de propriété

PipelineRetryOptions

héritée deInteractiveCredentialOptions.retryOptions

telemetryOptions

Options permettant de définir les informations de télémétrie et de suivi courantes sur les requêtes sortantes.

telemetryOptions?: TelemetryOptions

Valeur de propriété

TelemetryOptions

héritée deInteractiveCredentialOptions.telemetryOptions

tlsOptions

Options de configuration de l’authentification TLS

tlsOptions?: TlsSettings

Valeur de propriété

TlsSettings

héritée deInteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Options à fournir à la couche de persistance (le cas échéant) lors du stockage des informations d’identification.

Vous devez d’abord inscrire un plug-in de fournisseur de persistance. Consultez le package @azure/identity-cache-persistence sur NPM.

Exemple:

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

useIdentityPlugin(cachePersistencePlugin);
const credential = new DeviceCodeCredential({
  tokenCachePersistenceOptions: {
    enabled: true,
  },
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Valeur de propriété

TokenCachePersistenceOptions

héritée deCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Options d’ajout de détails de l’agent utilisateur aux demandes sortantes.

userAgentOptions?: UserAgentPolicyOptions

Valeur de propriété

UserAgentPolicyOptions

héritée deInteractiveCredentialOptions.userAgentOptions