StorageClientOptionalParams interface
Дополнительные параметры.
- Extends
-
ServiceClientOptions
Свойства
client |
Если этот параметр указан, в конвейер HTTP будет добавлен параметр GenerateRequestIdPolicy, который добавит заголовок во все исходящие запросы с этим именем заголовка и случайным UUID в качестве идентификатора запроса. |
credential |
Если этот параметр задан, будет использоваться для сборки BearerTokenAuthenticationPolicy. |
deserialization |
Типы содержимого, которые будут связаны с сериализацией JSON или XML. |
endpoint | Переопределяет конечную точку клиента. |
generate |
Указывает, следует ли создавать заголовок идентификатора запроса клиента для каждого HTTP-запроса. |
http |
HttpClient, который будет использоваться для отправки HTTP-запросов. |
http |
HttpPipelineLogger, который можно использовать для отладки RequestPolicies в конвейере HTTP. |
no |
Если задано значение true, отключите политику повторных попыток по умолчанию. |
proxy |
Параметры прокси-сервера, которые будут использоваться для каждого HTTP-запроса (только Node.js). |
request |
Массив фабрик, вызываемых для создания конвейера RequestPolicy, используемого для отправки HTTP-запроса по сети, или функции, которая принимает значение defaultRequestPolicyFactories и возвращает используемый объект requestPolicyFactories. |
rp |
Возвращает или задает время ожидания повторных попыток в секундах для Параметра AutomaticRPRegistration. Значение по умолчанию — 30. |
user |
Строка, которая должна быть задана в заголовке телеметрии при отправке запроса, или функция, которая принимает строку агента пользователя по умолчанию и возвращает строку агента пользователя, которая будет использоваться. |
user |
Имя заголовка, используемое для заголовка телеметрии при отправке запроса. Если этот параметр не указан, при запуске в Node.js будет использоваться user-Agent, а при запуске в браузере — x-ms-useragent. |
version | Задает версию операции, используемой для этого запроса. |
with |
Указывает, следует ли включать учетные данные в запросы CORS в браузере. Подробнее см. в разделе https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials. |
Сведения о свойстве
clientRequestIdHeaderName
Если этот параметр указан, в конвейер HTTP будет добавлен параметр GenerateRequestIdPolicy, который добавит заголовок во все исходящие запросы с этим именем заголовка и случайным UUID в качестве идентификатора запроса.
clientRequestIdHeaderName?: string
Значение свойства
string
credentialScopes
Если этот параметр задан, будет использоваться для сборки BearerTokenAuthenticationPolicy.
credentialScopes?: string | string[]
Значение свойства
string | string[]
deserializationContentTypes
Типы содержимого, которые будут связаны с сериализацией JSON или XML.
deserializationContentTypes?: DeserializationContentTypes
Значение свойства
DeserializationContentTypes
endpoint
Переопределяет конечную точку клиента.
endpoint?: string
Значение свойства
string
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
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-useragent.
userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string
Значение свойства
string | (defaultUserAgentHeaderName: string) => string
version
Задает версию операции, используемой для этого запроса.
version?: string
Значение свойства
string
withCredentials
Указывает, следует ли включать учетные данные в запросы CORS в браузере. Подробнее см. в разделе https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.
withCredentials?: boolean
Значение свойства
boolean
Azure SDK for JavaScript