Pipeline interface

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

Представляет конвейер для выполнения HTTP-запроса к URL-адресу. Конвейеры могут иметь несколько политик для управления обработкой каждого запроса до и после его отправки на сервер.

Методы

addPolicy(PipelinePolicy, AddPipelineOptions)

Добавьте новую политику в конвейер.
clone()

Дублирует этот конвейер, чтобы разрешить изменение существующего конвейера без его изменения.
getOrderedPolicies()

Возвращает текущий набор политик в конвейере в том порядке, в котором они будут применяться к запросу. Далее в списке ближе к моменту выполнения запроса.
removePolicy({ name?: string, phase?: PipelinePhase })

Удаление политики из конвейера.
sendRequest(HttpClient, PipelineRequest)

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

Сведения о методе

addPolicy(PipelinePolicy, AddPipelineOptions)

Добавьте новую политику в конвейер.

function addPolicy(policy: PipelinePolicy, options?: AddPipelineOptions)

Параметры

policy
PipelinePolicy

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

options
AddPipelineOptions

Набор параметров для запуска политики.

clone()

Дублирует этот конвейер, чтобы разрешить изменение существующего конвейера без его изменения.

function clone(): Pipeline

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

Pipeline

getOrderedPolicies()

Возвращает текущий набор политик в конвейере в том порядке, в котором они будут применяться к запросу. Далее в списке ближе к моменту выполнения запроса.

function getOrderedPolicies(): PipelinePolicy[]

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

PipelinePolicy[]

removePolicy({ name?: string, phase?: PipelinePhase })

Удаление политики из конвейера.

function removePolicy(options: { name?: string, phase?: PipelinePhase }): PipelinePolicy[]

Параметры

options

{ name?: string, phase?: PipelinePhase }

Параметры, позволяющие указать, какие политики следует удалить.

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

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

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

function sendRequest(httpClient: HttpClient, request: PipelineRequest): Promise<PipelineResponse>

Параметры

httpClient
HttpClient

HttpClient, который фактически выполняет запрос.

request
PipelineRequest

Запрос, который требуется выполнить.

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

Promise<PipelineResponse>