InteractiveCredentialOptions interface

Pakiet:

@azure/identity

Typowe opcje konstruktora dla poświadczeń tożsamości, które wymagają interakcji użytkownika.

Rozszerzenie

MultiTenantTokenCredentialOptions,AuthorityValidationOptions

Właściwości

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ę authenticate() poświadczeń w następujący sposób: const authenticationRecord = await credential.authenticate();

disableAutomaticAuthentication

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

Właściwości dziedziczone

additionallyAllowedTenants	W przypadku aplikacji wielodostępnych 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 instalowanej przez aplikację.
additionalPolicies	Dodatkowe zasady do uwzględnienia w potoku HTTP.
agent	Opcje konfigurowania wystąpienia agenta dla żądań wychodzących
allowInsecureConnection	Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS
authorityHost	Host urzędu do użycia na potrzeby żądań uwierzytelniania. Możliwe wartości są dostępne za pośrednictwem AzureAuthorityHosts. Wartość domyślna to "https://login.microsoftonline.com".
disableInstanceDiscovery	Pole określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia. Ustawienie tej wartości na wartość true spowoduje całkowite wyłączenie zarówno odnajdywania wystąpień, jak i weryfikacji urzędu. W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i godny zaufania. 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/ w celu zweryfikowania urzędu.
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
userAgentOptions	Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

Szczegóły właściwości

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ę authenticate() poświadczeń w następujący sposób:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Wartość właściwości

AuthenticationRecord

disableAutomaticAuthentication

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

disableAutomaticAuthentication?: boolean

Wartość właściwości

boolean

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

additionallyAllowedTenants

W przypadku aplikacji wielodostępnych 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 instalowanej przez aplikację.

additionallyAllowedTenants?: string[]

Wartość właściwości

string[]

dziedziczone zMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Wartość właściwości

AdditionalPolicyConfig[]

dziedziczone zMultiTenantTokenCredentialOptions.additionalPolicies

agent

Opcje konfigurowania wystąpienia agenta dla żądań wychodzących

agent?: Agent

Wartość właściwości

Agent

dziedziczone zMultiTenantTokenCredentialOptions.agent

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

authorityHost

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

authorityHost?: string

Wartość właściwości

string

dziedziczone zMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

Pole określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia. Ustawienie tej wartości na wartość true spowoduje całkowite wyłączenie zarówno odnajdywania wystąpień, jak i weryfikacji urzędu. W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i godny zaufania. 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/ w celu zweryfikowania urzędu.

disableInstanceDiscovery?: boolean

Wartość właściwości

boolean

dziedziczone zAuthorityValidationOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

Wartość właściwości

HttpClient

dziedziczone zMultiTenantTokenCredentialOptions.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 zMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

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

proxyOptions?: ProxySettings

Wartość właściwości

ProxySettings

dziedziczone zMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectPolicyOptions

Wartość właściwości

RedirectPolicyOptions

dziedziczone zMultiTenantTokenCredentialOptions.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 zMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Wartość właściwości

TelemetryOptions

dziedziczone zMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

Opcje konfigurowania uwierzytelniania TLS

tlsOptions?: TlsSettings

Wartość właściwości

TlsSettings

dziedziczone zMultiTenantTokenCredentialOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Wartość właściwości

UserAgentPolicyOptions

dziedziczone zMultiTenantTokenCredentialOptions.userAgentOptions