InteractiveBrowserCredentialNodeOptions interface

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

Определяет общие параметры для класса InteractiveBrowserCredential.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions,BrowserCustomizationOptions,BrokerAuthOptions

Свойства

clientId

Идентификатор клиента (приложения) регистрации приложения в клиенте.
loginHint

loginHint позволяет предварительно выбрать имя пользователя для интерактивных имен входа. Установка этого параметра пропускает запрос на выбор учетной записи и немедленно пытается войти с указанной учетной записью.
redirectUri

Возвращает URI перенаправления приложения. Это значение должно совпадать со значением на портале регистрации приложений. По умолчанию — window.location.href. Это поле больше не требуется для Node.js.
tenantId

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

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

additionallyAllowedTenants

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

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

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

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

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

const authenticationRecord = await credential.authenticate();
authorityHost

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

Параметры для разрешения проверки подлинности брокера при использовании InteractiveBrowserCredential
browserCustomizationOptions

Параметры общей конфигурации для настройки браузера
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 { 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

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

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

clientId

Идентификатор клиента (приложения) регистрации приложения в клиенте.

clientId?: string

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

string

loginHint

loginHint позволяет предварительно выбрать имя пользователя для интерактивных имен входа. Установка этого параметра пропускает запрос на выбор учетной записи и немедленно пытается войти с указанной учетной записью.

loginHint?: string

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

string

redirectUri

Возвращает URI перенаправления приложения. Это значение должно совпадать со значением на портале регистрации приложений. По умолчанию — window.location.href. Это поле больше не требуется для Node.js.

redirectUri?: string | () => string

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

string | () => string

tenantId

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

tenantId?: string

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

string

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

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

brokerOptions

Параметры для разрешения проверки подлинности брокера при использовании InteractiveBrowserCredential

brokerOptions?: BrokerOptions

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

BrokerOptions

Наследуется отbrokerAuthOptions.brokerOptions

browserCustomizationOptions

Параметры общей конфигурации для настройки браузера

browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }

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

{ errorMessage?: string, successMessage?: string }

Наследуется отbrowserCustomizationOptions.browserCustomizationOptions

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 { 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

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

TokenCachePersistenceOptions

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

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

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

UserAgentPolicyOptions

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