@azure/core-rest-pipeline package

Классы

RestError

Пользовательский тип ошибки для неудачных запросов конвейера.

Интерфейсы

AddPipelineOptions	Параметры при добавлении политики в конвейер. Используется для выражения зависимостей от других политик.
Agent	Интерфейс, совместимый с nodeJS http.Agent. Мы хотим избежать общедоступного повторного экспорта фактического интерфейса, так как он может отличаться в разных версиях среды выполнения.
AuthorizeRequestOnChallengeOptions	Параметры, отправленные обратному вызову authorizeRequestOnChallenge
AuthorizeRequestOptions	Параметры, отправленные обратному вызову authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions	Параметры для настройки вспомогательной политикиAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Параметры для настройки bearerTokenAuthenticationPolicy
ChallengeCallbacks	Параметры для переопределения обработки задач непрерывной оценки доступа .
DefaultRetryPolicyOptions	Параметры, управляющие повторными попытками неудачных запросов.
ExponentialRetryPolicyOptions	Параметры, управляющие повторными попытками неудачных запросов.
HttpClient	Необходимый интерфейс для клиента, который выполняет HTTP-запросы от имени конвейера.
HttpHeaders	Представляет набор заголовков HTTP в запросе или ответе. Имена заголовков обрабатываются без учета регистра.
InternalPipelineOptions	Определяет параметры, используемые для настройки внутренних параметров конвейера HTTP для клиента пакета SDK.
KeyObject	Интерфейс, совместимый с nodeJS tls.KeyObject. Мы хотим избежать общедоступного повторного экспорта фактического интерфейса, так как он может отличаться в разных версиях среды выполнения.
LogPolicyOptions	Параметры для настройки logPolicy.
Pipeline	Представляет конвейер для выполнения HTTP-запроса к URL-адресу. Конвейеры могут иметь несколько политик для управления обработкой каждого запроса до и после его выполнения на сервере.
PipelineOptions	Определяет параметры, используемые для настройки конвейера HTTP для клиента ПАКЕТА SDK.
PipelinePolicy	Политика конвейера управляет запросом при его прохождении по конвейеру. По сути, это ПО промежуточного слоя, которое может изменять запрос перед его выполнением, а также ответ при его получении.
PipelineRequest	Метаданные о запросе, выполняемом конвейером.
PipelineRequestOptions	Параметры для инициализации запроса. Почти эквивалентно Partial, но URL-адрес является обязательным.
PipelineResponse	Метаданные об ответе, полученном конвейером.
PipelineRetryOptions	Параметры, управляющие повторными попытками неудачных запросов.
ProxySettings	Параметры настройки прокси-сервера для исходящих запросов (только Node.js).
PxfObject	Интерфейс, совместимый с nodeJS tls.PxfObject. Мы хотим избежать общедоступного повторного экспорта фактического интерфейса, так как он может отличаться в разных версиях среды выполнения.
RedirectPolicyOptions	Параметры обработки ответов перенаправления.
RestErrorOptions	Параметры, поддерживаемые RestError.
RetryInformation	Сведения о текущем ходе выполнения политики повторных попыток, предоставляемые стратегии повторных попыток.
RetryModifiers	Свойства, которые могут изменять поведение политики повторных попыток.
RetryPolicyOptions	Параметры для retryPolicy
RetryStrategy	Стратегия повторных попыток предназначена для определения того, следует ли выполнять повторную попытку и как ее повторить.
SystemErrorRetryPolicyOptions	Параметры, управляющие повторными попытками неудачных запросов.
TelemetryOptions	Определяет параметры, используемые для настройки общих данных телеметрии и трассировки.
ThrottlingRetryPolicyOptions	Параметры, управляющие повторными попытками неудачных запросов.
TlsSettings	Представляет сертификат для проверки подлинности TLS.
TracingPolicyOptions	Параметры для настройки политики трассировки.
UserAgentPolicyOptions	Параметры добавления сведений об агенте пользователя в исходящие запросы.

Псевдонимы типа

FormDataMap	Простой объект, предоставляющий данные формы, как будто из формы браузера.
FormDataValue	Каждая запись данных формы может быть строкой или (в браузере) BLOB-объектом.
HttpMethods	Поддерживаемые методы HTTP для использования при выполнении запросов.
PipelinePhase	Политики выполняются поэтапно. Порядок выполнения: этап сериализации, политики, не относящиеся к этапу, этап десериализации, этап повтора. Этап подписи
RawHttpHeaders	Коллекция HttpHeaders, представленная в виде простого объекта JSON.
RawHttpHeadersInput	Коллекция HttpHeaders для входных данных, представленная в виде простого объекта JSON.
RequestBodyType	Типы тел, поддерживаемые в запросе. NodeJS.ReadableStream и () => NodeJS.ReadableStream является только Node. Blob, ReadableStream и () => ReadableStream доступны только для браузера.
SendRequest	Простой интерфейс для создания запроса конвейера и получения ответа.
TransferProgressEvent	Срабатывает в ответ на ход передачи или скачивания.

Функции

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Политика для внешних маркеров в x-ms-authorization-auxiliary заголовке. Этот заголовок будет использоваться при создании межтенантного приложения, которое может потребоваться для обработки запросов проверки подлинности для ресурсов, которые находятся в разных клиентах. В документации по ARM приведены подробные сведения о том, как работает эта функция.
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Политика, которая может запрашивать маркер из реализации TokenCredential, а затем применять его к заголовку авторизации запроса в качестве маркера носителя.
createDefaultHttpClient()	Создайте правильный HttpClient для текущей среды.
createEmptyPipeline()	Создает полностью пустой конвейер. Полезно для тестирования или создания пользовательского.
createHttpHeaders(RawHttpHeadersInput)	Создает объект, удовлетворяющий интерфейсу HttpHeaders .
createPipelineFromOptions(InternalPipelineOptions)	Создайте новый конвейер с набором настраиваемых политик по умолчанию.
createPipelineRequest(PipelineRequestOptions)	Создает новый запрос конвейера с заданными параметрами. Этот метод позволяет легко задавать значения по умолчанию и не требуется.
decompressResponsePolicy()	Политика для включения распаковки ответов в соответствии с заголовком Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Политика, которая повторяет попытку в соответствии с тремя стратегиями: Когда сервер отправляет ответ 429 с заголовком Retry-After. При возникновении ошибок на базовом транспортном уровне (например, при сбое поиска DNS). Или в противном случае, если исходящий запрос завершается сбоем, он будет повторяться с экспоненциально увеличивающейся задержкой.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Политика, которая пытается повторить запросы, вводя экспоненциально увеличивающуюся задержку.
formDataPolicy()	Политика, которая кодирует FormData в запросе в текст.
getDefaultProxySettings(string)	Этот метод преобразует URL-адрес прокси-сервера в ProxySettings для использования с ProxyPolicy. Если аргумент не указан, он пытается проанализировать URL-адрес прокси-сервера из переменных HTTPS_PROXY среды или HTTP_PROXY.
isRestError(unknown)	Typeguard для RestError
logPolicy(LogPolicyOptions)	Политика, которая регистрирует все запросы и ответы.
ndJsonPolicy()	ndJsonPolicy — это политика, используемая для управления параметрами поддержания активности для каждого запроса.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Политика, которая позволяет применять параметры прокси-сервера ко всем запросам. Если статические параметры не переданы, они будут получены из переменных среды HTTPS_PROXY или HTTP_PROXY.
redirectPolicy(RedirectPolicyOptions)	Политика, поддерживающая перенаправление на стороне сервера, должна следовать заголовкам расположения сервера. В браузере эта политика не используется.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy — это универсальная политика для включения повторных попыток запросов при выполнении определенных условий.
setClientRequestIdPolicy(string)	Каждый PipelineRequest получает уникальный идентификатор при создании. Эта политика передает этот уникальный идентификатор через заголовок HTTP, чтобы обеспечить лучшую телеметрию и трассировку.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Политика повторных попыток, которая специально стремится обрабатывать ошибки на базовом транспортном уровне (например, сбои поиска DNS), а не коды ошибок, которые можно повторить с самого сервера.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Политика, которая повторяет попытку, когда сервер отправляет ответ 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-limitshttps://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tlsPolicy(TlsSettings)	Возвращает политику конвейера, которая добавляет сертификат клиента в агент HttpClient для проверки подлинности.
tracingPolicy(TracingPolicyOptions)	Простая политика для создания OpenTelemetry Spans для каждого запроса, выполненного конвейером, который содержит SpanOptions с родительским элементом. Запросы, выполненные без родительского span, не будут записываться.
userAgentPolicy(UserAgentPolicyOptions)	Политика, которая задает заголовок User-Agent (или эквивалент) в соответствии с версией библиотеки.

Сведения о функции

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Политика для внешних маркеров в x-ms-authorization-auxiliary заголовке. Этот заголовок будет использоваться при создании межтенантного приложения, которое может потребоваться для обработки запросов проверки подлинности для ресурсов, которые находятся в разных клиентах. В документации по ARM приведены подробные сведения о том, как работает эта функция.

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Параметры

options

AuxiliaryAuthenticationHeaderPolicyOptions

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

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

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

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Параметры

options

BearerTokenAuthenticationPolicyOptions

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

PipelinePolicy

createDefaultHttpClient()

Создайте правильный HttpClient для текущей среды.

function createDefaultHttpClient(): HttpClient

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

HttpClient

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

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

Pipeline

createHttpHeaders(RawHttpHeadersInput)

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

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Параметры

rawHeaders

RawHttpHeadersInput

Простой объект, представляющий начальные заголовки

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

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

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

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Параметры

options

InternalPipelineOptions

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

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

Pipeline

createPipelineRequest(PipelineRequestOptions)

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

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Параметры

options

PipelineRequestOptions

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

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

PipelineRequest

decompressResponsePolicy()

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

function decompressResponsePolicy(): PipelinePolicy

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

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

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

• Когда сервер отправляет ответ 429 с заголовком Retry-After.
• При возникновении ошибок на базовом транспортном уровне (например, при сбое поиска DNS).
• Или в противном случае, если исходящий запрос завершается сбоем, он будет повторяться с экспоненциально увеличивающейся задержкой.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Параметры

options

DefaultRetryPolicyOptions

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

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

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

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Параметры

options

ExponentialRetryPolicyOptions

Параметры, которые настраивают логику повторных попыток.

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

PipelinePolicy

formDataPolicy()

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

function formDataPolicy(): PipelinePolicy

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

PipelinePolicy

getDefaultProxySettings(string)

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

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

Параметры

proxyUrl

string

URL-адрес используемого прокси-сервера. Может содержать сведения о проверке подлинности.

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

ProxySettings | undefined

isRestError(unknown)

Typeguard для RestError

function isRestError(e: unknown): e

Параметры

e

unknown

Что-то перехваченное предложением catch.

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

e

logPolicy(LogPolicyOptions)

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

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Параметры

options

LogPolicyOptions

Параметры для настройки logPolicy.

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

PipelinePolicy

ndJsonPolicy()

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

function ndJsonPolicy(): PipelinePolicy

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

PipelinePolicy

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

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

function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicy

Параметры

proxySettings

ProxySettings

ProxySettings для использования в каждом запросе.

options

{ customNoProxyList?: string[] }

дополнительные параметры, например пользовательские шаблоны NO_PROXY

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

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Политика, поддерживающая перенаправление на стороне сервера, должна следовать заголовкам расположения сервера. В браузере эта политика не используется.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Параметры

options

RedirectPolicyOptions

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

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

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy — это универсальная политика для включения повторных попыток запросов при выполнении определенных условий.

function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy

Параметры

strategies

RetryStrategy[]

options

RetryPolicyOptions

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

PipelinePolicy

setClientRequestIdPolicy(string)

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

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Параметры

requestIdHeaderName

string

Имя заголовка, в который передается идентификатор запроса.

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

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

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

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Параметры

options

SystemErrorRetryPolicyOptions

Параметры, которые настраивают политику.

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

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Политика, которая повторяет попытку, когда сервер отправляет ответ 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-limitshttps://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Параметры

options

ThrottlingRetryPolicyOptions

Параметры, которые настраивают логику повторных попыток.

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

PipelinePolicy

tlsPolicy(TlsSettings)

Возвращает политику конвейера, которая добавляет сертификат клиента в агент HttpClient для проверки подлинности.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Параметры

tlsSettings

TlsSettings

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

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

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

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Параметры

options

TracingPolicyOptions

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

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

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

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

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Параметры

options

UserAgentPolicyOptions

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

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

PipelinePolicy