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

ClientSecretCredentialOptions interface

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

Необязательные параметры для класса ClientSecretCredential .

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

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

additionallyAllowedTenants

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

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

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

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

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

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

additionallyAllowedTenants

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

additionallyAllowedTenants?: string[]

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

string[]

Наследуется отMultiTenantTokenCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

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

AdditionalPolicyConfig[]

Наследуется отMultiTenantTokenCredentialOptions.additionalPolicies

allowInsecureConnection

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

allowInsecureConnection?: boolean

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

boolean

Наследуется отMultiTenantTokenCredentialOptions.allowInsecureConnection

authorityHost

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

authorityHost?: string

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

string

Наследуется отMultiTenantTokenCredentialOptions.authorityHost

disableInstanceDiscovery

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

disableInstanceDiscovery?: boolean

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

boolean

Наследуется отAuthorityValidationOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

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

HttpClient

Наследуется отMultiTenantTokenCredentialOptions.httpClient

loggingOptions

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

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

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

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

Наследуется отMultiTenantTokenCredentialOptions.loggingOptions

proxyOptions

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

proxyOptions?: ProxySettings

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

ProxySettings

Наследуется отMultiTenantTokenCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

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

RedirectPolicyOptions

Наследуется отMultiTenantTokenCredentialOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

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

PipelineRetryOptions

Наследуется отMultiTenantTokenCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

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

TelemetryOptions

Наследуется отMultiTenantTokenCredentialOptions.telemetryOptions

tlsOptions

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

tlsOptions?: TlsSettings

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

TlsSettings

Наследуется отMultiTenantTokenCredentialOptions.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

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