DefaultAzureCredentialClientIdOptions interface

Пакет:

@azure/identity

Предоставляет параметры настройки класса DefaultAzureCredential. Этот вариант поддерживает managedIdentityClientId и не managedIdentityResourceId, так как поддерживается только один из обоих вариантов.

Extends

DefaultAzureCredentialOptions

Свойства

managedIdentityClientId	При необходимости передайте идентификатор клиента, назначенный пользователем, который будет использоваться ManagedIdentityCredential. Этот идентификатор клиента также можно передать в ManagedIdentityCredential через переменную среды: AZURE_CLIENT_ID.
workloadIdentityClientId	При необходимости передайте идентификатор клиента, назначенный пользователем, который будет использоваться WorkloadIdentityCredential. Этот идентификатор клиента также можно передать в WorkloadIdentityCredential через переменную среды: AZURE_CLIENT_ID.

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

additionallyAllowedTenants	Для мультитенантных приложений указывает дополнительные клиенты, для которых учетные данные могут получать маркеры. Добавьте подстановочное значение "*", чтобы разрешить учетным данным получать маркеры для любого клиента, установленного приложением.
additionalPolicies	Дополнительные политики для включения в конвейер HTTP.
agent	Параметры настройки экземпляра агента для исходящих запросов
allowInsecureConnection	Задайте значение true, если запрос отправляется по протоколу HTTP вместо HTTPS
authorityHost	Узел центра, используемый для запросов проверки подлинности. Возможные значения доступны через AzureAuthorityHosts. Значение по умолчанию — "https://login.microsoftonline.com".
disableInstanceDiscovery	Поле определяет, выполняется ли обнаружение экземпляров при попытке проверки подлинности. При установке этого значения значение true полностью отключается как обнаружение экземпляров, так и проверка центра. В результате важно убедиться, что настроенный узел центра является допустимым и надежным. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных не может быть достигнута, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров подразумевает получение метаданных центра из https://login.microsoft.com/ для проверки центра.
httpClient	HttpClient, который будет использоваться для отправки HTTP-запросов.
loggingOptions	Позволяет пользователям настраивать параметры для параметров политики ведения журнала, разрешать сведения о учетной записи ведения журнала и личные сведения для поддержки клиентов.
processTimeoutInMs	Время ожидания, настраиваемое для выполнения запросов маркеров учетных данных разработчика, а именно <xref:AzurePowershellCredential>, AzureDeveloperCliCredential и AzureCliCredential. Время ожидания процесса для учетных данных должно быть указано в миллисекундах.
proxyOptions	Параметры настройки прокси-сервера для исходящих запросов.
redirectOptions	Параметры обработки ответов перенаправления.
requiredEnvVars	Список переменных среды, которые должны быть определены во время выполнения. Если какая-либо переменная в этом списке отсутствует или имеет пустое значение, конструктор DefaultAzureCredential выдаст ошибку. Используйте эту функцию, чтобы убедиться, что приложение имеет необходимую конфигурацию среды, прежде чем продолжить выполнение.
retryOptions	Параметры, управляющие повторными неудачными запросами.
telemetryOptions	Параметры настройки общих данных телеметрии и трассировки для исходящих запросов.
tenantId	При необходимости передайте идентификатор клиента, который будет использоваться в качестве части учетных данных. По умолчанию он может использовать универсальный идентификатор клиента в зависимости от базовых учетных данных.
tlsOptions	Параметры настройки проверки подлинности TLS
userAgentOptions	Параметры добавления сведений об агенте пользователя в исходящие запросы.

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

managedIdentityClientId

При необходимости передайте идентификатор клиента, назначенный пользователем, который будет использоваться ManagedIdentityCredential. Этот идентификатор клиента также можно передать в ManagedIdentityCredential через переменную среды: AZURE_CLIENT_ID.

managedIdentityClientId?: string

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

string

workloadIdentityClientId

При необходимости передайте идентификатор клиента, назначенный пользователем, который будет использоваться WorkloadIdentityCredential. Этот идентификатор клиента также можно передать в WorkloadIdentityCredential через переменную среды: AZURE_CLIENT_ID.

workloadIdentityClientId?: string

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

string

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

additionallyAllowedTenants

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

additionallyAllowedTenants?: string[]

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

string[]

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

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

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

AdditionalPolicyConfig[]

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

agent

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

agent?: Agent

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

Agent

наследуется отDefaultAzureCredentialOptions.agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

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

boolean

унаследован отDefaultAzureCredentialOptions.allowInsecureConnection

authorityHost

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

authorityHost?: string

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

string

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

disableInstanceDiscovery

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

disableInstanceDiscovery?: boolean

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

boolean

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

httpClient

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

httpClient?: HttpClient

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

HttpClient

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

loggingOptions

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

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

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

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

унаследован отDefaultAzureCredentialOptions.loggingOptions

processTimeoutInMs

Время ожидания, настраиваемое для выполнения запросов маркеров учетных данных разработчика, а именно <xref:AzurePowershellCredential>, AzureDeveloperCliCredential и AzureCliCredential. Время ожидания процесса для учетных данных должно быть указано в миллисекундах.

processTimeoutInMs?: number

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

number

наследуется отDefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

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

proxyOptions?: ProxySettings

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

ProxySettings

унаследован отDefaultAzureCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

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

RedirectPolicyOptions

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

requiredEnvVars

Список переменных среды, которые должны быть определены во время выполнения. Если какая-либо переменная в этом списке отсутствует или имеет пустое значение, конструктор DefaultAzureCredential выдаст ошибку. Используйте эту функцию, чтобы убедиться, что приложение имеет необходимую конфигурацию среды, прежде чем продолжить выполнение.

requiredEnvVars?: DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

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

DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

Наследуется отDefaultAzureCredentialOptions.requiredEnvVars

retryOptions

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

retryOptions?: PipelineRetryOptions

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

PipelineRetryOptions

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

telemetryOptions

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

telemetryOptions?: TelemetryOptions

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

TelemetryOptions

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

tenantId

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

tenantId?: string

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

string

наследуется отDefaultAzureCredentialOptions.tenantId

tlsOptions

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

tlsOptions?: TlsSettings

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

TlsSettings

унаследован отDefaultAzureCredentialOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

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

UserAgentPolicyOptions

наследуется отDefaultAzureCredentialOptions.userAgentOptions