DefaultAzureCredentialClientIdOptions interface

Paquet:

@azure/identity

Fournit des options pour configurer la classe DefaultAzureCredential . Cette variante prend en charge managedIdentityClientId et non managedIdentityResourceId, car une seule des deux est prise en charge.

Extends

DefaultAzureCredentialOptions

Propriétés

managedIdentityClientId	Si vous le souhaitez, transmettez un ID client affecté par l’utilisateur à utiliser par ManagedIdentityCredential. Cet ID client peut également être transmis à ManagedIdentityCredential via la variable d’environnement : AZURE_CLIENT_ID.
workloadIdentityClientId	Transmettez éventuellement un ID client attribué par l’utilisateur à utiliser par workloadIdentityCredential. Cet ID client peut également être transmis à workloadIdentityCredential via la variable d’environnement : AZURE_CLIENT_ID.

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ée.
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
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 instance détection est effectuée lors de la tentative d’authentification. La définition de true cette valeur désactive complètement la découverte instance 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 digne de confiance. Cette fonctionnalité est destinée à être utilisée dans les scénarios où le point de terminaison de métadonnées n’est pas accessible, par exemple dans des clouds privés ou Azure Stack. Le processus de découverte 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.
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.
proxyOptions	Options permettant de configurer un proxy pour les requêtes 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 données de télémétrie et de suivi courantes sur les requêtes sortantes.
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.
tlsOptions	Options de configuration de l’authentification TLS
userAgentOptions	Options permettant d’ajouter des détails de l’agent utilisateur aux requêtes sortantes.

Détails de la propriété

managedIdentityClientId

Si vous le souhaitez, transmettez un ID client affecté par l’utilisateur à utiliser par ManagedIdentityCredential. Cet ID client peut également être transmis à ManagedIdentityCredential via la variable d’environnement : AZURE_CLIENT_ID.

managedIdentityClientId?: string

Valeur de propriété

string

workloadIdentityClientId

Transmettez éventuellement un ID client attribué par l’utilisateur à utiliser par workloadIdentityCredential. Cet ID client peut également être transmis à workloadIdentityCredential via la variable d’environnement : AZURE_CLIENT_ID.

workloadIdentityClientId?: 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ée.

additionallyAllowedTenants?: string[]

Valeur de propriété

string[]

Hérité deDefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valeur de propriété

AdditionalPolicyConfig[]

Hérité deDefaultAzureCredentialOptions.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é deDefaultAzureCredentialOptions.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é deDefaultAzureCredentialOptions.authorityHost

disableInstanceDiscovery

Le champ détermine si instance détection est effectuée lors de la tentative d’authentification. La définition de true cette valeur désactive complètement la découverte instance 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 digne de confiance. Cette fonctionnalité est destinée à être utilisée dans les scénarios où le point de terminaison de métadonnées n’est pas accessible, par exemple dans des clouds privés ou Azure Stack. Le processus de découverte 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é deDefaultAzureCredentialOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

Valeur de propriété

HttpClient

Hérité deDefaultAzureCredentialOptions.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é deDefaultAzureCredentialOptions.loggingOptions

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

Hérité deDefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

Options permettant de configurer un proxy pour les requêtes sortantes.

proxyOptions?: ProxySettings

Valeur de propriété

ProxySettings

Hérité deDefaultAzureCredentialOptions.proxyOptions

redirectOptions

Options de gestion des réponses de redirection.

redirectOptions?: RedirectPolicyOptions

Valeur de propriété

RedirectPolicyOptions

Hérité deDefaultAzureCredentialOptions.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é deDefaultAzureCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Valeur de propriété

TelemetryOptions

Hérité deDefaultAzureCredentialOptions.telemetryOptions

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

Hérité deDefaultAzureCredentialOptions.tenantId

tlsOptions

Options de configuration de l’authentification TLS

tlsOptions?: TlsSettings

Valeur de propriété

TlsSettings

Hérité deDefaultAzureCredentialOptions.tlsOptions

userAgentOptions

Options permettant d’ajouter des détails de l’agent utilisateur aux requêtes sortantes.

userAgentOptions?: UserAgentPolicyOptions

Valeur de propriété

UserAgentPolicyOptions

Hérité deDefaultAzureCredentialOptions.userAgentOptions