Dela via

DeviceCodeCredentialOptions interface

  • Referens
Paket:
@azure/identity

Definierar alternativ för klassen InteractiveBrowserCredential för Node.js.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Egenskaper

clientId

Klient-ID för Microsoft Entra-programmet som användarna loggar in på. Vi rekommenderar att utvecklare registrerar sina program och tilldelar lämpliga roller. Mer information finns i https://aka.ms/identity/AppRegistrationAndRoleAssignment. Om det inte anges autentiseras användarna till ett Azure-utvecklingsprogram, vilket inte rekommenderas för produktionsscenarier.
tenantId

Microsoft Entra-klientorganisationens (katalog)-ID.
userPromptCallback

En återanropsfunktion som anropas för att visa DeviceCodeInfo för användaren. Om den lämnas otilldelade loggar vi automatiskt enhetsinformationen och autentiseringsinstruktionerna i konsolen.

Ärvda egenskaper

additionallyAllowedTenants

För program med flera klientorganisationer anger ytterligare klienter för vilka autentiseringsuppgifterna kan hämta token. Lägg till jokertecknets värde "*" så att autentiseringsuppgifterna kan hämta token för alla klientorganisationer som programmet är installerat.
additionalPolicies

Ytterligare principer som ska ingå i HTTP-pipelinen.
allowInsecureConnection

Ange sant om begäran skickas via HTTP i stället för HTTPS
authenticationRecord

Resultatet av en tidigare autentisering som kan användas för att hämta cachelagrade autentiseringsuppgifter för varje enskilt konto. Detta är nödvändigt för att ange om programmet vill arbeta med mer än ett konto per klient-ID och klient-ID-par.

Den här posten kan hämtas genom att anropa till autentiseringsuppgifternas authenticate() metod enligt följande:

const authenticationRecord = await credential.authenticate();
authorityHost

Den utfärdarvärd som ska användas för autentiseringsbegäranden. Möjliga värden är tillgängliga via AzureAuthorityHosts. Standardvärdet är "https://login.microsoftonline.com".
disableAutomaticAuthentication

Gör att getToken utlöser om en manuell autentisering krävs. Utvecklare måste anropa authenticate() för att styra när de ska autentiseras manuellt.
disableInstanceDiscovery

Fältet avgör om instansidentifiering utförs vid försök att autentisera. Om du anger detta till true inaktiveras både identifiering av instanser och verifiering av utfärdare helt. Därför är det viktigt att se till att den konfigurerade utfärdarvärden är giltig och tillförlitlig. Den här funktionen är avsedd att användas i scenarier där metadataslutpunkten inte kan nås, till exempel i privata moln eller Azure Stack. Processen för instansidentifiering innebär att auktoritetsmetadata hämtas från https://login.microsoft.com/ för att verifiera utfärdaren.
httpClient

Den HttpClient som ska användas för att skicka HTTP-begäranden.
loggingOptions

Tillåter användare att konfigurera inställningar för alternativ för loggningsprinciper, tillåta loggning av kontoinformation och personligt identifierbar information för kundsupport.
proxyOptions

Alternativ för att konfigurera en proxy för utgående begäranden.
redirectOptions

Alternativ för hur omdirigeringssvar hanteras.
retryOptions

Alternativ som styr hur du försöker utföra misslyckade begäranden igen.
telemetryOptions

Alternativ för att ange vanlig telemetri och spårningsinformation för utgående begäranden.
tlsOptions

Alternativ för att konfigurera TLS-autentisering
tokenCachePersistenceOptions

Alternativ för att ange beständighetsskiktet (om ett är tillgängligt) vid lagring av autentiseringsuppgifter.

Du måste först registrera ett plugin-program för beständighetsprovider. Se @azure/identity-cache-persistence-paketet på NPM.

Exempel:

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

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

Alternativ för att lägga till information om användaragenten i utgående begäranden.

Egenskapsinformation

clientId

Klient-ID för Microsoft Entra-programmet som användarna loggar in på. Vi rekommenderar att utvecklare registrerar sina program och tilldelar lämpliga roller. Mer information finns i https://aka.ms/identity/AppRegistrationAndRoleAssignment. Om det inte anges autentiseras användarna till ett Azure-utvecklingsprogram, vilket inte rekommenderas för produktionsscenarier.

clientId?: string

Egenskapsvärde

string

tenantId

Microsoft Entra-klientorganisationens (katalog)-ID.

tenantId?: string

Egenskapsvärde

string

userPromptCallback

En återanropsfunktion som anropas för att visa DeviceCodeInfo för användaren. Om den lämnas otilldelade loggar vi automatiskt enhetsinformationen och autentiseringsinstruktionerna i konsolen.

userPromptCallback?: DeviceCodePromptCallback

Egenskapsvärde

DeviceCodePromptCallback

Information om ärvda egenskaper

additionallyAllowedTenants

För program med flera klientorganisationer anger ytterligare klienter för vilka autentiseringsuppgifterna kan hämta token. Lägg till jokertecknets värde "*" så att autentiseringsuppgifterna kan hämta token för alla klientorganisationer som programmet är installerat.

additionallyAllowedTenants?: string[]

Egenskapsvärde

string[]

ärvs frånInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Ytterligare principer som ska ingå i HTTP-pipelinen.

additionalPolicies?: AdditionalPolicyConfig[]

Egenskapsvärde

AdditionalPolicyConfig[]

ärvs frånInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Ange sant om begäran skickas via HTTP i stället för HTTPS

allowInsecureConnection?: boolean

Egenskapsvärde

boolean

ärvd frånInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Resultatet av en tidigare autentisering som kan användas för att hämta cachelagrade autentiseringsuppgifter för varje enskilt konto. Detta är nödvändigt för att ange om programmet vill arbeta med mer än ett konto per klient-ID och klient-ID-par.

Den här posten kan hämtas genom att anropa till autentiseringsuppgifternas authenticate() metod enligt följande:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Egenskapsvärde

AuthenticationRecord

ärvd frånInteractiveCredentialOptions.authenticationRecord

authorityHost

Den utfärdarvärd som ska användas för autentiseringsbegäranden. Möjliga värden är tillgängliga via AzureAuthorityHosts. Standardvärdet är "https://login.microsoftonline.com".

authorityHost?: string

Egenskapsvärde

string

ärvd frånInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Gör att getToken utlöser om en manuell autentisering krävs. Utvecklare måste anropa authenticate() för att styra när de ska autentiseras manuellt.

disableAutomaticAuthentication?: boolean

Egenskapsvärde

boolean

ärvd frånInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Fältet avgör om instansidentifiering utförs vid försök att autentisera. Om du anger detta till true inaktiveras både identifiering av instanser och verifiering av utfärdare helt. Därför är det viktigt att se till att den konfigurerade utfärdarvärden är giltig och tillförlitlig. Den här funktionen är avsedd att användas i scenarier där metadataslutpunkten inte kan nås, till exempel i privata moln eller Azure Stack. Processen för instansidentifiering innebär att auktoritetsmetadata hämtas från https://login.microsoft.com/ för att verifiera utfärdaren.

disableInstanceDiscovery?: boolean

Egenskapsvärde

boolean

ärvd frånInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

Den HttpClient som ska användas för att skicka HTTP-begäranden.

httpClient?: HttpClient

Egenskapsvärde

HttpClient

ärvd frånInteractiveCredentialOptions.httpClient

loggingOptions

Tillåter användare att konfigurera inställningar för alternativ för loggningsprinciper, tillåta loggning av kontoinformation och personligt identifierbar information för kundsupport.

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

Egenskapsvärde

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

ärvd frånInteractiveCredentialOptions.loggingOptions

proxyOptions

Alternativ för att konfigurera en proxy för utgående begäranden.

proxyOptions?: ProxySettings

Egenskapsvärde

ProxySettings

ärvd frånInteractiveCredentialOptions.proxyOptions

redirectOptions

Alternativ för hur omdirigeringssvar hanteras.

redirectOptions?: RedirectPolicyOptions

Egenskapsvärde

RedirectPolicyOptions

ärvs frånInteractiveCredentialOptions.redirectOptions

retryOptions

Alternativ som styr hur du försöker utföra misslyckade begäranden igen.

retryOptions?: PipelineRetryOptions

Egenskapsvärde

PipelineRetryOptions

ärvd frånInteractiveCredentialOptions.retryOptions

telemetryOptions

Alternativ för att ange vanlig telemetri och spårningsinformation för utgående begäranden.

telemetryOptions?: TelemetryOptions

Egenskapsvärde

TelemetryOptions

ärvd frånInteractiveCredentialOptions.telemetryOptions

tlsOptions

Alternativ för att konfigurera TLS-autentisering

tlsOptions?: TlsSettings

Egenskapsvärde

TlsSettings

ärvs frånInteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Alternativ för att ange beständighetsskiktet (om ett är tillgängligt) vid lagring av autentiseringsuppgifter.

Du måste först registrera ett plugin-program för beständighetsprovider. Se @azure/identity-cache-persistence-paketet på NPM.

Exempel:

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

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

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Egenskapsvärde

TokenCachePersistenceOptions

ärvd frånCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Alternativ för att lägga till information om användaragenten i utgående begäranden.

userAgentOptions?: UserAgentPolicyOptions

Egenskapsvärde

UserAgentPolicyOptions

ärvd frånInteractiveCredentialOptions.userAgentOptions