@azure/core-https package

Политика, которая может запросить маркер из реализации TokenCredential, а затем применить его к заголовку авторизации запроса в качестве маркера носителя.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Параметры

Возвращаемое значение

Создает полностью пустой конвейер. Полезно для тестирования или создания пользовательского.

function createEmptyPipeline(): Pipeline

Возвращаемое значение

Создает объект, удовлетворяющий интерфейсу HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

Параметры

Возвращаемое значение

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

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Параметры

Возвращаемое значение

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

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Параметры

Возвращаемое значение

Политика для включения распаковки ответа в соответствии с заголовком Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Возвращаемое значение

Политика, которая пытается повторить запросы при вводе экспоненциального увеличения задержки.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Параметры

Возвращаемое значение

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

function formDataPolicy(): PipelinePolicy

Возвращаемое значение

Этот метод преобразует URL-адрес прокси-сервера в ProxySettings для использования с ProxyPolicy. Если аргумент не задан, он пытается проанализировать URL-адрес прокси-сервера из переменных среды HTTPS_PROXY или HTTP_PROXY.

function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined

Параметры

Возвращаемое значение

Политика, которая регистрирует все запросы и ответы.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Параметры

Возвращаемое значение

ndJsonPolicy — это политика, используемая для управления сохранением активности параметров для каждого запроса.

function ndJsonPolicy(): PipelinePolicy

Возвращаемое значение

Политика, которая позволяет применять параметры прокси-сервера ко всем запросам. Если не переданы статические параметры, они будут получены из переменных среды HTTPS_PROXY или HTTP_PROXY среды.

function proxyPolicy(proxySettings?: ProxySettings): PipelinePolicy

Параметры

Возвращаемое значение

Политика для выполнения заголовков location с сервера для поддержки перенаправления на стороне сервера.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Параметры

Возвращаемое значение

Каждый PipelineRequest получает уникальный идентификатор при создании. Эта политика передает уникальный идентификатор вместе с заголовком HTTP, чтобы повысить эффективность телеметрии и трассировки.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Параметры

Возвращаемое значение

Политика повторных попыток, которая специально стремится обрабатывать ошибки в базовом транспортном слое (например, сбои подстановки DNS), а не повторяющиеся коды ошибок с самого сервера.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Параметры

Возвращаемое значение

Политика, которая повторяется, когда сервер отправляет ответ 429 с заголовком Retry-After.

Дополнительные сведения см. в https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits и https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): PipelinePolicy

Возвращаемое значение

Простая политика для создания диапазонов OpenTelemetry для каждого запроса, сделанного конвейером с элементом SpanOptions с родительским элементом. Запросы, сделанные без родительского диапазона, не записываются.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Параметры

Возвращаемое значение

Политика, которая задает заголовок User-Agent (или эквивалентный) для отражения версии библиотеки.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Параметры

Возвращаемое значение

Программный идентификатор bearerTokenAuthenticationPolicy.

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

Тип

Программный идентификатор decompressResponsePolicy.

decompressResponsePolicyName: "decompressResponsePolicy"

Тип

Программный идентификатор экспоненциальной RetryPolicy.

expontentialRetryPolicyName: "exponentialRetryPolicy"

Тип

Программный идентификатор формы DataPolicy.

formDataPolicyName: "formDataPolicy"

Тип

Программный идентификатор logPolicy.

logPolicyName: "logPolicy"

Тип

Программный идентификатор ndJsonPolicy.

ndJsonPolicyName: "ndJsonPolicy"

Тип

Программный идентификатор проксиPolicy.

proxyPolicyName: "proxyPolicy"

Тип

Программный идентификатор redirectPolicy.

redirectPolicyName: "redirectPolicy"

Тип

Программный идентификатор setClientRequestIdPolicy.

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

Тип

Программный идентификатор systemErrorRetryPolicy.

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

Тип

Программный идентификатор дротлингаRetryPolicy.

throttlingRetryPolicyName: "throttlingRetryPolicy"

Тип

Программный идентификатор трассировкиPolicy.

tracingPolicyName: "tracingPolicy"

Тип

Программный идентификатор userAgentPolicy.

userAgentPolicyName: "userAgentPolicy"

Тип