Share via

UsernamePasswordCredentialOptions interface

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

Définit les options de la classe UsernamePasswordCredential .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

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.
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.
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 @azure/identity-cache-persistence package sur NPM.

Exemple :

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});
userAgentOptions

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

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é deMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valeur de propriété

AdditionalPolicyConfig[]

Hérité deMultiTenantTokenCredentialOptions.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é 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é deMultiTenantTokenCredentialOptions.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ée deAuthorityValidationOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

Valeur de propriété

HttpClient

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

proxyOptions

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

proxyOptions?: ProxySettings

Valeur de propriété

ProxySettings

Hérité deMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Options de gestion des réponses de redirection.

redirectOptions?: RedirectPolicyOptions

Valeur de propriété

RedirectPolicyOptions

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

tlsOptions

Options de configuration de l’authentification TLS

tlsOptions?: TlsSettings

Valeur de propriété

TlsSettings

Hérité deMultiTenantTokenCredentialOptions.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 @azure/identity-cache-persistence package sur NPM.

Exemple :

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Valeur de propriété

TokenCachePersistenceOptions

Hérité deCredentialPersistenceOptions.tokenCachePersistenceOptions

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é deMultiTenantTokenCredentialOptions.userAgentOptions