Share via

DeviceCodeCredentialOptions interface

  • Odwołanie
Pakiet:
@azure/identity

Definiuje opcje klasy InteractiveBrowserCredential dla Node.js.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Właściwości

clientId

Identyfikator klienta (aplikacji) rejestracji aplikacji w dzierżawie.
tenantId

Identyfikator dzierżawy Microsoft Entra (katalogu).
userPromptCallback

Funkcja wywołania zwrotnego, która zostanie wywołana w celu wyświetlenia informacji DeviceCodeInfo użytkownikowi. W przypadku pozostawienia nieprzypisanego automatycznie zarejestrujemy informacje o kodzie urządzenia i instrukcje uwierzytelniania w konsoli programu .

Właściwości dziedziczone

additionallyAllowedTenants

W przypadku aplikacji z wieloma dzierżawami określa dodatkowe dzierżawy, dla których poświadczenia mogą uzyskiwać tokeny. Dodaj wartość symbolu wieloznakowego "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy, która jest zainstalowana przez aplikację.
additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.
allowInsecureConnection

Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS
authenticationRecord

Wynik poprzedniego uwierzytelniania, który może służyć do pobierania buforowanych poświadczeń poszczególnych kont. Jest to konieczne w przypadku, gdy aplikacja chce pracować z więcej niż jednym kontem na parę Identyfikator klienta i Identyfikator dzierżawy.

Ten rekord można pobrać, wywołując metodę poświadczeń authenticate() w następujący sposób:

const authenticationRecord = await credential.authenticate();
authorityHost

Host urzędu do użycia na potrzeby żądań uwierzytelniania. Możliwe wartości są dostępne za pośrednictwem usługi AzureAuthorityHosts. Wartość domyślna to "https://login.microsoftonline.com".
disableAutomaticAuthentication

Zgłasza błąd getToken, jeśli konieczne jest ręczne uwierzytelnianie. Deweloperzy będą musieli wywołać metodę , aby authenticate() kontrolować, kiedy ręcznie się uwierzytelniać.
disableInstanceDiscovery

Pole określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia. Ustawienie tego ustawienia true spowoduje całkowite wyłączenie zarówno odnajdywania wystąpień, jak i walidacji urzędu. W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i wiarygodny. Ta funkcja jest przeznaczona do użycia w scenariuszach, w których nie można uzyskać dostępu do punktu końcowego metadanych, na przykład w chmurach prywatnych lub w usłudze Azure Stack. Proces odnajdywania wystąpień wiąże się z pobieraniem metadanych urzędu z https://login.microsoft.com/ , aby zweryfikować urząd.
httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.
loggingOptions

Umożliwia użytkownikom konfigurowanie ustawień opcji zasad rejestrowania, zezwalanie na rejestrowanie informacji o koncie i dane osobowe na potrzeby obsługi klienta.
proxyOptions

Opcje konfigurowania serwera proxy dla żądań wychodzących.
redirectOptions

Opcje obsługi odpowiedzi przekierowania.
retryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
telemetryOptions

Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.
tlsOptions

Opcje konfigurowania uwierzytelniania TLS
tokenCachePersistenceOptions

Opcje udostępniania warstwy trwałości (jeśli jest dostępna) podczas przechowywania poświadczeń.

Najpierw musisz zarejestrować wtyczkę dostawcy trwałości. @azure/identity-cache-persistence Zobacz pakiet na serwerze NPM.

Przykład:

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

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

Szczegóły właściwości

clientId

Identyfikator klienta (aplikacji) rejestracji aplikacji w dzierżawie.

clientId?: string

Wartość właściwości

string

tenantId

Identyfikator dzierżawy Microsoft Entra (katalogu).

tenantId?: string

Wartość właściwości

string

userPromptCallback

Funkcja wywołania zwrotnego, która zostanie wywołana w celu wyświetlenia informacji DeviceCodeInfo użytkownikowi. W przypadku pozostawienia nieprzypisanego automatycznie zarejestrujemy informacje o kodzie urządzenia i instrukcje uwierzytelniania w konsoli programu .

userPromptCallback?: DeviceCodePromptCallback

Wartość właściwości

DeviceCodePromptCallback

Szczegóły właściwości dziedziczonej

additionallyAllowedTenants

W przypadku aplikacji z wieloma dzierżawami określa dodatkowe dzierżawy, dla których poświadczenia mogą uzyskiwać tokeny. Dodaj wartość symbolu wieloznakowego "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy, która jest zainstalowana przez aplikację.

additionallyAllowedTenants?: string[]

Wartość właściwości

string[]

Dziedziczone zinteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Wartość właściwości

AdditionalPolicyConfig[]

Dziedziczone zinteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS

allowInsecureConnection?: boolean

Wartość właściwości

boolean

Dziedziczone zinteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Wynik poprzedniego uwierzytelniania, który może służyć do pobierania buforowanych poświadczeń poszczególnych kont. Jest to konieczne w przypadku, gdy aplikacja chce pracować z więcej niż jednym kontem na parę Identyfikator klienta i Identyfikator dzierżawy.

Ten rekord można pobrać, wywołując metodę poświadczeń authenticate() w następujący sposób:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Wartość właściwości

AuthenticationRecord

Dziedziczone zinteractiveCredentialOptions.authenticationRecord

authorityHost

Host urzędu do użycia na potrzeby żądań uwierzytelniania. Możliwe wartości są dostępne za pośrednictwem usługi AzureAuthorityHosts. Wartość domyślna to "https://login.microsoftonline.com".

authorityHost?: string

Wartość właściwości

string

Dziedziczone zinteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Zgłasza błąd getToken, jeśli konieczne jest ręczne uwierzytelnianie. Deweloperzy będą musieli wywołać metodę , aby authenticate() kontrolować, kiedy ręcznie się uwierzytelniać.

disableAutomaticAuthentication?: boolean

Wartość właściwości

boolean

Dziedziczone zinteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Pole określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia. Ustawienie tego ustawienia true spowoduje całkowite wyłączenie zarówno odnajdywania wystąpień, jak i walidacji urzędu. W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i wiarygodny. Ta funkcja jest przeznaczona do użycia w scenariuszach, w których nie można uzyskać dostępu do punktu końcowego metadanych, na przykład w chmurach prywatnych lub w usłudze Azure Stack. Proces odnajdywania wystąpień wiąże się z pobieraniem metadanych urzędu z https://login.microsoft.com/ , aby zweryfikować urząd.

disableInstanceDiscovery?: boolean

Wartość właściwości

boolean

Dziedziczone zinteractiveCredentialOptions.disableInstanceDiscovery

httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.

httpClient?: HttpClient

Wartość właściwości

HttpClient

Dziedziczone zinteractiveCredentialOptions.httpClient

loggingOptions

Umożliwia użytkownikom konfigurowanie ustawień opcji zasad rejestrowania, zezwalanie na rejestrowanie informacji o koncie i dane osobowe na potrzeby obsługi klienta.

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

Wartość właściwości

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

Dziedziczone zinteractiveCredentialOptions.loggingOptions

proxyOptions

Opcje konfigurowania serwera proxy dla żądań wychodzących.

proxyOptions?: ProxySettings

Wartość właściwości

ProxySettings

Dziedziczone zinteractiveCredentialOptions.proxyOptions

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectPolicyOptions

Wartość właściwości

RedirectPolicyOptions

Dziedziczone zinteractiveCredentialOptions.redirectOptions

retryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.

retryOptions?: PipelineRetryOptions

Wartość właściwości

PipelineRetryOptions

Dziedziczone zinteractiveCredentialOptions.retryOptions

telemetryOptions

Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.

telemetryOptions?: TelemetryOptions

Wartość właściwości

TelemetryOptions

Dziedziczone zinteractiveCredentialOptions.telemetryOptions

tlsOptions

Opcje konfigurowania uwierzytelniania TLS

tlsOptions?: TlsSettings

Wartość właściwości

TlsSettings

Dziedziczone zinteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Opcje udostępniania warstwy trwałości (jeśli jest dostępna) podczas przechowywania poświadczeń.

Najpierw musisz zarejestrować wtyczkę dostawcy trwałości. @azure/identity-cache-persistence Zobacz pakiet na serwerze NPM.

Przykład:

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

Wartość właściwości

TokenCachePersistenceOptions

Dziedziczone zcredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

userAgentOptions?: UserAgentPolicyOptions

Wartość właściwości

UserAgentPolicyOptions

Dziedziczone zinteractiveCredentialOptions.userAgentOptions