ServiceClientOptions interface

  • Ссылка
Пакет:
@azure/core-client

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

Extends
CommonClientOptions

Свойства

baseUri

Если он указан, это базовый универсальный код ресурса (URI), к которому будут выполняться запросы для этого ServiceClient. Если он не указан, то все operationSpecs должны содержать свойство baseUrl.
credential

Учетные данные, используемые для проверки подлинности запроса.
credentialScopes

Если этот параметр указан, будет использоваться для сборки BearerTokenAuthenticationPolicy.
endpoint

Если этот параметр указан, это конечная точка, к которому будут выполняться запросы для этого ServiceClient. Если он не указан, то все operationSpecs должны содержать свойство baseUrl. Чтобы побудить клиента использовать конечную точку, мы помечаем baseUri как нерекомендуемый.
pipeline

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

Тип контента запроса по умолчанию для службы. Используется, если в OperationSpec отсутствует параметр requestContentType.

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

additionalPolicies

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

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

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

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

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

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

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

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

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

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

baseUri

Предупреждение

Теперь этот API является нерекомендуемым.

This property is deprecated and will be removed soon, please use endpoint instead

Если он указан, это базовый универсальный код ресурса (URI), к которому будут выполняться запросы для этого ServiceClient. Если он не указан, то все operationSpecs должны содержать свойство baseUrl.

baseUri?: string

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

string

credential

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

credential?: TokenCredential

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

TokenCredential

credentialScopes

Если этот параметр указан, будет использоваться для сборки BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

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

string | string[]

endpoint

Если этот параметр указан, это конечная точка, к которому будут выполняться запросы для этого ServiceClient. Если он не указан, то все operationSpecs должны содержать свойство baseUrl. Чтобы побудить клиента использовать конечную точку, мы помечаем baseUri как нерекомендуемый.

endpoint?: string

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

string

pipeline

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

pipeline?: Pipeline

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

Pipeline

requestContentType

Тип контента запроса по умолчанию для службы. Используется, если в OperationSpec отсутствует параметр requestContentType.

requestContentType?: string

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

string

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

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

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

AdditionalPolicyConfig[]

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

allowInsecureConnection

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

allowInsecureConnection?: boolean

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

boolean

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

httpClient

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

httpClient?: HttpClient

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

HttpClient

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

proxyOptions

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

proxyOptions?: ProxySettings

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

ProxySettings

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

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

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

RedirectPolicyOptions

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

retryOptions

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

retryOptions?: PipelineRetryOptions

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

PipelineRetryOptions

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

telemetryOptions

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

telemetryOptions?: TelemetryOptions

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

TelemetryOptions

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

tlsOptions

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

tlsOptions?: TlsSettings

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

TlsSettings

Наследуется отCommonClientOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

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

UserAgentPolicyOptions

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