Поделиться через

DeviceCodeCredentialOptions interface

  • Ссылка
Пакет:
@azure/identity

Определяет параметры для класса InteractiveBrowserCredential для Node.js.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Свойства

clientId

Идентификатор клиента приложения Microsoft Entra, в которое пользователи будут входить. Рекомендуется, чтобы разработчики регистрируют свои приложения и назначают соответствующие роли. Дополнительные сведения см. в https://aka.ms/identity/AppRegistrationAndRoleAssignment. Если это не указано, пользователи будут проходить проверку подлинности в приложении разработки Azure, которое не рекомендуется для рабочих сценариев.
tenantId

Идентификатор клиента Microsoft Entra (каталог).
userPromptCallback

Функция обратного вызова, которая будет вызываться для отображения DeviceCodeInfo пользователю. Если не назначено, мы автоматически заносим сведения о коде устройства и инструкции по проверке подлинности в консоли.

Унаследованные свойства

additionallyAllowedTenants

Для мультитенантных приложений указывает дополнительные клиенты, для которых учетные данные могут получать маркеры. Добавьте подстановочное значение "*", чтобы разрешить учетным данным получать маркеры для любого клиента, установленного приложением.
additionalPolicies

Дополнительные политики для включения в конвейер HTTP.
allowInsecureConnection

Задайте значение true, если запрос отправляется по протоколу HTTP вместо HTTPS
authenticationRecord

Результат предыдущей проверки подлинности, который можно использовать для получения кэшированных учетных данных каждой отдельной учетной записи. Это необходимо для предоставления в случае, если приложение хочет работать с несколькими учетными записями для каждой пары идентификатора клиента и идентификатора клиента.

Эту запись можно получить, вызвав метод authenticate() учетных данных следующим образом:

const authenticationRecord = await credential.authenticate();
authorityHost

Узел центра, используемый для запросов проверки подлинности. Возможные значения доступны через AzureAuthorityHosts. Значение по умолчанию — "https://login.microsoftonline.com".
disableAutomaticAuthentication

Создает вызов getToken, если требуется ручная проверка подлинности. Разработчикам потребуется вызвать authenticate(), чтобы управлять выполнением проверки подлинности вручную.
disableInstanceDiscovery

Поле определяет, выполняется ли обнаружение экземпляров при попытке проверки подлинности. При установке этого значения значение true полностью отключается как обнаружение экземпляров, так и проверка центра. В результате важно убедиться, что настроенный узел центра является допустимым и надежным. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных не может быть достигнута, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров подразумевает получение метаданных центра из https://login.microsoft.com/ для проверки центра.
httpClient

HttpClient, который будет использоваться для отправки HTTP-запросов.
loggingOptions

Позволяет пользователям настраивать параметры для параметров политики ведения журнала, разрешать сведения о учетной записи ведения журнала и личные сведения для поддержки клиентов.
proxyOptions

Параметры настройки прокси-сервера для исходящих запросов.
redirectOptions

Параметры обработки ответов перенаправления.
retryOptions

Параметры, управляющие повторными неудачными запросами.
telemetryOptions

Параметры настройки общих данных телеметрии и трассировки для исходящих запросов.
tlsOptions

Параметры настройки проверки подлинности TLS
tokenCachePersistenceOptions

Параметры для предоставления уровня сохраняемости (если он доступен) при хранении учетных данных.

Сначала необходимо зарегистрировать подключаемый модуль поставщика сохраняемости. См. пакет @azure/identity-cache-persistence в NPM.

Пример:

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

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

Параметры добавления сведений об агенте пользователя в исходящие запросы.

Сведения о свойстве

clientId

Идентификатор клиента приложения Microsoft Entra, в которое пользователи будут входить. Рекомендуется, чтобы разработчики регистрируют свои приложения и назначают соответствующие роли. Дополнительные сведения см. в https://aka.ms/identity/AppRegistrationAndRoleAssignment. Если это не указано, пользователи будут проходить проверку подлинности в приложении разработки Azure, которое не рекомендуется для рабочих сценариев.

clientId?: string

Значение свойства

string

tenantId

Идентификатор клиента Microsoft Entra (каталог).

tenantId?: string

Значение свойства

string

userPromptCallback

Функция обратного вызова, которая будет вызываться для отображения DeviceCodeInfo пользователю. Если не назначено, мы автоматически заносим сведения о коде устройства и инструкции по проверке подлинности в консоли.

userPromptCallback?: DeviceCodePromptCallback

Значение свойства

DeviceCodePromptCallback

Сведения об унаследованном свойстве

additionallyAllowedTenants

Для мультитенантных приложений указывает дополнительные клиенты, для которых учетные данные могут получать маркеры. Добавьте подстановочное значение "*", чтобы разрешить учетным данным получать маркеры для любого клиента, установленного приложением.

additionallyAllowedTenants?: string[]

Значение свойства

string[]

наследуется отInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Дополнительные политики для включения в конвейер HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Значение свойства

AdditionalPolicyConfig[]

наследуется отInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Задайте значение true, если запрос отправляется по протоколу HTTP вместо HTTPS

allowInsecureConnection?: boolean

Значение свойства

boolean

наследуется отInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Результат предыдущей проверки подлинности, который можно использовать для получения кэшированных учетных данных каждой отдельной учетной записи. Это необходимо для предоставления в случае, если приложение хочет работать с несколькими учетными записями для каждой пары идентификатора клиента и идентификатора клиента.

Эту запись можно получить, вызвав метод authenticate() учетных данных следующим образом:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Значение свойства

AuthenticationRecord

наследуется отInteractiveCredentialOptions.authenticationRecord

authorityHost

Узел центра, используемый для запросов проверки подлинности. Возможные значения доступны через AzureAuthorityHosts. Значение по умолчанию — "https://login.microsoftonline.com".

authorityHost?: string

Значение свойства

string

наследуется отInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Создает вызов getToken, если требуется ручная проверка подлинности. Разработчикам потребуется вызвать authenticate(), чтобы управлять выполнением проверки подлинности вручную.

disableAutomaticAuthentication?: boolean

Значение свойства

boolean

наследуется отInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Поле определяет, выполняется ли обнаружение экземпляров при попытке проверки подлинности. При установке этого значения значение true полностью отключается как обнаружение экземпляров, так и проверка центра. В результате важно убедиться, что настроенный узел центра является допустимым и надежным. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных не может быть достигнута, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров подразумевает получение метаданных центра из https://login.microsoft.com/ для проверки центра.

disableInstanceDiscovery?: boolean

Значение свойства

boolean

наследуется отInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient, который будет использоваться для отправки HTTP-запросов.

httpClient?: HttpClient

Значение свойства

HttpClient

наследуется отInteractiveCredentialOptions.httpClient

loggingOptions

Позволяет пользователям настраивать параметры для параметров политики ведения журнала, разрешать сведения о учетной записи ведения журнала и личные сведения для поддержки клиентов.

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

Значение свойства

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

наследуется отInteractiveCredentialOptions.loggingOptions

proxyOptions

Параметры настройки прокси-сервера для исходящих запросов.

proxyOptions?: ProxySettings

Значение свойства

ProxySettings

наследуется отInteractiveCredentialOptions.proxyOptions

redirectOptions

Параметры обработки ответов перенаправления.

redirectOptions?: RedirectPolicyOptions

Значение свойства

RedirectPolicyOptions

наследуется отInteractiveCredentialOptions.redirectOptions

retryOptions

Параметры, управляющие повторными неудачными запросами.

retryOptions?: PipelineRetryOptions

Значение свойства

PipelineRetryOptions

наследуется отInteractiveCredentialOptions.retryOptions

telemetryOptions

Параметры настройки общих данных телеметрии и трассировки для исходящих запросов.

telemetryOptions?: TelemetryOptions

Значение свойства

TelemetryOptions

наследуется отInteractiveCredentialOptions.telemetryOptions

tlsOptions

Параметры настройки проверки подлинности TLS

tlsOptions?: TlsSettings

Значение свойства

TlsSettings

наследуется отInteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Параметры для предоставления уровня сохраняемости (если он доступен) при хранении учетных данных.

Сначала необходимо зарегистрировать подключаемый модуль поставщика сохраняемости. См. пакет @azure/identity-cache-persistence в NPM.

Пример:

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

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

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Значение свойства

TokenCachePersistenceOptions

наследуется отCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Параметры добавления сведений об агенте пользователя в исходящие запросы.

userAgentOptions?: UserAgentPolicyOptions

Значение свойства

UserAgentPolicyOptions

Наследуется отInteractiveCredentialOptions.userAgentOptions