@azure/core-rest-pipeline package

Классы

RestError

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

Интерфейсы

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

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

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

Функции

agentPolicy(Agent)	Возвращает политику конвейера, которая задает http.agent
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Политика для внешних маркеров для x-ms-authorization-auxiliary заголовка. Этот заголовок будет использоваться при создании межтенантного приложения, который может потребоваться обрабатывать запросы проверки подлинности для ресурсов, которые находятся в разных клиентах. Вы можете увидеть документация ARM для запуска работы этой функции.
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Политика, которая может запросить маркер из реализации TokenCredential, а затем применить его к заголовку авторизации запроса в качестве маркера носителя.
createDefaultHttpClient()	Создайте правильный HttpClient для текущей среды.
createEmptyPipeline()	Создает полностью пустой конвейер. Полезно для тестирования или создания пользовательского.
createFile(Uint8Array, string, CreateFileOptions)	Создайте объект, реализующий интерфейс file. Этот объект предназначен для передачи в RequestBodyType.formData и не гарантируется, что он работает должным образом в других ситуациях. Эта функция создает объект File для использования в RequestBodyType.formData в средах, где глобальный объект File недоступен.
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)	Создайте объект, реализующий интерфейс file. Этот объект предназначен для передачи в RequestBodyType.formData и не гарантируется, что он работает должным образом в других ситуациях. Используйте эту функцию для: Создайте объект File для использования в RequestBodyType.formData в средах, где глобальный объект File недоступен. Создайте объект, подобный файлу, из читаемого потока, не считывая поток в память.
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)	Политика, которая регистрирует все запросы и ответы.
multipartPolicy()	Политика конвейера для многопартийных запросов
ndJsonPolicy()	ndJsonPolicy — это политика, используемая для управления сохранением активности параметров для каждого запроса.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Политика, которая позволяет применять параметры прокси-сервера ко всем запросам. Если не переданы статические параметры, они будут получены из переменных среды HTTPS_PROXY или HTTP_PROXY среды.
redirectPolicy(RedirectPolicyOptions)	Политика для выполнения заголовков location с сервера для поддержки перенаправления на стороне сервера. В браузере эта политика не используется.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy — это универсальная политика для включения повторных запросов при выполнении определенных условий.
setClientRequestIdPolicy(string)	Каждый PipelineRequest получает уникальный идентификатор при создании. Эта политика передает уникальный идентификатор вместе с заголовком HTTP, чтобы повысить эффективность телеметрии и трассировки.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Политика повторных попыток, которая специально стремится обрабатывать ошибки в базовом транспортном слое (например, сбои подстановки DNS), а не повторяющиеся коды ошибок с самого сервера.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Политика, которая повторяется, когда сервер отправляет ответ 429 с заголовком Retry-After. Дополнительные сведения см. в https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits и https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tlsPolicy(TlsSettings)	Возвращает политику конвейера, которая добавляет сертификат клиента в агент HttpClient для проверки подлинности.
tracingPolicy(TracingPolicyOptions)	Простая политика для создания диапазонов OpenTelemetry для каждого запроса, сделанного конвейером с элементом SpanOptions с родительским элементом. Запросы, сделанные без родительского диапазона, не записываются.
userAgentPolicy(UserAgentPolicyOptions)	Политика, которая задает заголовок User-Agent (или эквивалентный) для отражения версии библиотеки.

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

agentPolicy(Agent)

Возвращает политику конвейера, которая задает http.agent

function agentPolicy(agent?: Agent): PipelinePolicy

Параметры

agent

Agent

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

PipelinePolicy

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

createFile(Uint8Array, string, CreateFileOptions)

Создайте объект, реализующий интерфейс file. Этот объект предназначен для передачи в RequestBodyType.formData и не гарантируется, что он работает должным образом в других ситуациях.

Эта функция создает объект File для использования в RequestBodyType.formData в средах, где глобальный объект File недоступен.

function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File

Параметры

content

Uint8Array

содержимое файла в виде Uint8Array в памяти.

name

string

имя файла.

options

CreateFileOptions

необязательные метаданные о файле, например имя файла, размер файла, тип MIME.

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

File

createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)

Создайте объект, реализующий интерфейс file. Этот объект предназначен для передачи в RequestBodyType.formData и не гарантируется, что он работает должным образом в других ситуациях.

Используйте эту функцию для:

• Создайте объект File для использования в RequestBodyType.formData в средах, где глобальный объект File недоступен.
• Создайте объект, подобный файлу, из читаемого потока, не считывая поток в память.

function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File

Параметры

stream

() => ReadableStream<Uint8Array> | ReadableStream

содержимое файла в качестве обратного вызова, возвращающего поток. Когда объект File, сделанный с помощью createFile, передается в карте данных формы запроса, поток не будет считываться в память и вместо этого будет передаваться в поток при выполнении запроса. В случае повторных попыток поток должен быть прочитан снова, поэтому этот обратный вызов ДОЛЖЕН возвращать свежий поток, если это возможно.

name

string

имя файла.

options

CreateFileFromStreamOptions

необязательные метаданные о файле, например имя файла, размер файла, тип MIME.

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

File

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)

Предупреждение

Теперь этот API является нерекомендуемым.

• Internally this method is no longer necessary when setting proxy information.

Этот метод преобразует 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

multipartPolicy()

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

function multipartPolicy(): PipelinePolicy

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

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)

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

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://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits и https://learn.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 для каждого запроса, сделанного конвейером с элементом SpanOptions с родительским элементом. Запросы, сделанные без родительского диапазона, не записываются.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Параметры

options

TracingPolicyOptions

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

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

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

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

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Параметры

options

UserAgentPolicyOptions

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

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

PipelinePolicy