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

ServiceClientOptions interface

  • Ссылка
Пакет:
@azure/ms-rest-js

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

Свойства

agentSettings

Агенты HTTP и HTTPS, которые будут использоваться для каждого HTTP-запроса (только Node.js).
baseUri

Если указано:

  • Это baseUri становится базовым универсальным кодом ресурса (URI), к которому будут выполняться запросы для этого serviceClient.
  • baseUri Если объект соответствует известной конечной точке resource manager и если TokenCredential объект был передан через конструктор, это baseUri определяет getToken область как ${options.baseUri}/.default. В противном случае область по умолчанию будет "https://management.azure.com/.default".

Если он не указан:

  • Все operationSpecs должны содержать свойство baseUrl.
  • Если объект TokenCredential был передан через конструктор, областью getToken присваивается значение "https://management.azure.com/.default".
clientRequestIdHeaderName

Если этот параметр указан, в конвейер HTTP будет добавлен параметр GenerateRequestIdPolicy, который добавит заголовок во все исходящие запросы с этим именем заголовка и случайным UUID в качестве идентификатора запроса.
deserializationContentTypes

Типы содержимого, которые будут связаны с сериализацией JSON или XML.
generateClientRequestIdHeader

Указывает, следует ли создавать заголовок идентификатора запроса клиента для каждого HTTP-запроса.
httpClient

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

HttpPipelineLogger, который можно использовать для отладки RequestPolicies в конвейере HTTP.
noRetryPolicy

Если задано значение true, отключите политику повторных попыток по умолчанию.
proxySettings

Параметры прокси-сервера, которые будут использоваться для каждого HTTP-запроса (только Node.js).
redirectOptions

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

Массив фабрик, вызываемых для создания конвейера RequestPolicy, используемого для отправки HTTP-запроса по сети, или функции, которая принимает значение defaultRequestPolicyFactories и возвращает используемый объект requestPolicyFactories.
rpRegistrationRetryTimeout

Возвращает или задает время ожидания повторных попыток в секундах для Параметра AutomaticRPRegistration. Значение по умолчанию — 30.
userAgent

Строка, которая должна быть задана в заголовке телеметрии при отправке запроса, или функция, которая принимает строку агента пользователя по умолчанию и возвращает строку агента пользователя, которая будет использоваться.
userAgentHeaderName

Имя заголовка, используемое для заголовка телеметрии при отправке запроса. Если этот параметр не указан, при запуске в Node.js будет использоваться user-agent, а при запуске в браузере — x-ms-command-name.
withCredentials

Указывает, следует ли включать учетные данные в запросы CORS в браузере. Подробнее см. в разделе https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

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

agentSettings

Агенты HTTP и HTTPS, которые будут использоваться для каждого HTTP-запроса (только Node.js).

agentSettings?: AgentSettings

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

AgentSettings

baseUri

Если указано:

  • Это baseUri становится базовым универсальным кодом ресурса (URI), к которому будут выполняться запросы для этого serviceClient.
  • baseUri Если объект соответствует известной конечной точке resource manager и если TokenCredential объект был передан через конструктор, это baseUri определяет getToken область как ${options.baseUri}/.default. В противном случае область по умолчанию будет "https://management.azure.com/.default".

Если он не указан:

  • Все operationSpecs должны содержать свойство baseUrl.
  • Если объект TokenCredential был передан через конструктор, областью getToken присваивается значение "https://management.azure.com/.default".
baseUri?: string

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

string

clientRequestIdHeaderName

Если этот параметр указан, в конвейер HTTP будет добавлен параметр GenerateRequestIdPolicy, который добавит заголовок во все исходящие запросы с этим именем заголовка и случайным UUID в качестве идентификатора запроса.

clientRequestIdHeaderName?: string

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

string

deserializationContentTypes

Типы содержимого, которые будут связаны с сериализацией JSON или XML.

deserializationContentTypes?: DeserializationContentTypes

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

DeserializationContentTypes

generateClientRequestIdHeader

Указывает, следует ли создавать заголовок идентификатора запроса клиента для каждого HTTP-запроса.

generateClientRequestIdHeader?: boolean

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

boolean

httpClient

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

httpClient?: HttpClient

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

HttpClient

httpPipelineLogger

HttpPipelineLogger, который можно использовать для отладки RequestPolicies в конвейере HTTP.

httpPipelineLogger?: HttpPipelineLogger

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

HttpPipelineLogger

noRetryPolicy

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

noRetryPolicy?: boolean

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

boolean

proxySettings

Параметры прокси-сервера, которые будут использоваться для каждого HTTP-запроса (только Node.js).

proxySettings?: ProxySettings

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

ProxySettings

redirectOptions

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

redirectOptions?: RedirectOptions

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

RedirectOptions

requestPolicyFactories

Массив фабрик, вызываемых для создания конвейера RequestPolicy, используемого для отправки HTTP-запроса по сети, или функции, которая принимает значение defaultRequestPolicyFactories и возвращает используемый объект requestPolicyFactories.

requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

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

RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

rpRegistrationRetryTimeout

Возвращает или задает время ожидания повторных попыток в секундах для Параметра AutomaticRPRegistration. Значение по умолчанию — 30.

rpRegistrationRetryTimeout?: number

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

number

userAgent

Строка, которая должна быть задана в заголовке телеметрии при отправке запроса, или функция, которая принимает строку агента пользователя по умолчанию и возвращает строку агента пользователя, которая будет использоваться.

userAgent?: string | (defaultUserAgent: string) => string

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

string | (defaultUserAgent: string) => string

userAgentHeaderName

Имя заголовка, используемое для заголовка телеметрии при отправке запроса. Если этот параметр не указан, при запуске в Node.js будет использоваться user-agent, а при запуске в браузере — x-ms-command-name.

userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string

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

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Указывает, следует ли включать учетные данные в запросы CORS в браузере. Подробнее см. в разделе https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

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

boolean