ServiceClientOptions interface

Пакет:

@azure/core-client

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

Extends

CommonClientOptions

Свойства

baseUri	Если задано, это базовый универсальный код ресурса (URI), к которому будут применяться запросы для этого ServiceClient. Если он не указан, все операции OperationSpecs должны содержать свойство baseUrl.
credential	Учетные данные, используемые для проверки подлинности запроса.
credentialScopes	Если задано, будет использоваться для сборки BearerTokenAuthenticationPolicy.
endpoint	Если задано, это конечная точка, в которую будут выполняться запросы для этого ServiceClient. Если он не указан, все операции OperationSpecs должны содержать свойство baseUrl. чтобы клиент использовал конечную точку, мы помечаем базовый URI как нерекомендуемый.
pipeline	Настраиваемый конвейер, используемый, в противном случае будет создан по умолчанию.
requestContentType	Тип контента запроса по умолчанию для службы. Используется, если в OperationSpec отсутствует запросContentType.

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

additionalPolicies	Дополнительные политики для включения в конвейер HTTP.
agent	Параметры настройки экземпляра агента для исходящих запросов
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. чтобы клиент использовал конечную точку, мы помечаем базовый URI как нерекомендуемый.

endpoint?: string

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

string

pipeline

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

pipeline?: Pipeline

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

Pipeline

requestContentType

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

requestContentType?: string

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

string

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

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

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

AdditionalPolicyConfig[]

унаследовано отCommonClientOptions.additionalPolicies

agent

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

agent?: Agent

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

Agent

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

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