DefaultAzureCredentialOptions interface

Paquet:

@azure/identity

Fournit des options pour configurer la classe DefaultAzureCredential.

Extends

MultiTenantTokenCredentialOptions,AuthorityValidationOptions

Propriétés

processTimeoutInMs	Délai d’expiration configurable pour effectuer des demandes de jetons pour les informations d’identification du développeur, à savoir <xref:AzurePowershellCredential>, AzureDeveloperCliCredential et AzureCliCredential. Le délai d’expiration du processus pour les informations d’identification doit être fourni en millisecondes.
requiredEnvVars	Liste des variables d’environnement qui doivent être définies au moment de l’exécution. Si une variable de cette liste est manquante ou définie sur une valeur vide, le constructeur DefaultAzureCredential génère une erreur. Utilisez cette option pour vérifier que votre application dispose de la configuration d’environnement nécessaire avant de poursuivre l’exécution.
tenantId	Si vous le souhaitez, transmettez un ID de locataire à utiliser dans le cadre des informations d’identification. Par défaut, il peut utiliser un ID de locataire générique en fonction des informations d’identification sous-jacentes.

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.
agent	Options de configuration de l’instance de l’agent pour les demandes sortantes
allowInsecureConnection	Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS
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".
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
userAgentOptions	Options d’ajout de détails de l’agent utilisateur aux demandes sortantes.

Détails de la propriété

processTimeoutInMs

Délai d’expiration configurable pour effectuer des demandes de jetons pour les informations d’identification du développeur, à savoir <xref:AzurePowershellCredential>, AzureDeveloperCliCredential et AzureCliCredential. Le délai d’expiration du processus pour les informations d’identification doit être fourni en millisecondes.

processTimeoutInMs?: number

Valeur de propriété

number

requiredEnvVars

Liste des variables d’environnement qui doivent être définies au moment de l’exécution. Si une variable de cette liste est manquante ou définie sur une valeur vide, le constructeur DefaultAzureCredential génère une erreur. Utilisez cette option pour vérifier que votre application dispose de la configuration d’environnement nécessaire avant de poursuivre l’exécution.

requiredEnvVars?: DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

Valeur de propriété

DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

tenantId

Si vous le souhaitez, transmettez un ID de locataire à utiliser dans le cadre des informations d’identification. Par défaut, il peut utiliser un ID de locataire générique en fonction des informations d’identification sous-jacentes.

tenantId?: string

Valeur de propriété

string

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 deMultiTenantTokenCredentialOptions.en outreAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valeur de propriété

AdditionalPolicyConfig[]

héritée deMultiTenantTokenCredentialOptions.additionalPolicies

agent

Options de configuration de l’instance de l’agent pour les demandes sortantes

agent?: Agent

Valeur de propriété

Agent

héritée deMultiTenantTokenCredentialOptions.agent

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 deMultiTenantTokenCredentialOptions.allowInsecureConnection

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 deMultiTenantTokenCredentialOptions.authorityHost

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 deAuthorityValidationOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

Valeur de propriété

HttpClient

héritée deMultiTenantTokenCredentialOptions.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 deMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

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

proxyOptions?: ProxySettings

Valeur de propriété

ProxySettings

héritée deMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Options de gestion des réponses de redirection.

redirectOptions?: RedirectPolicyOptions

Valeur de propriété

RedirectPolicyOptions

héritée deMultiTenantTokenCredentialOptions.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 deMultiTenantTokenCredentialOptions.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 deMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Options de configuration de l’authentification TLS

tlsOptions?: TlsSettings

Valeur de propriété

TlsSettings

héritée deMultiTenantTokenCredentialOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Valeur de propriété

UserAgentPolicyOptions

héritée deMultiTenantTokenCredentialOptions.userAgentOptions