Pipeline interface

パッケージ:

@azure/core-rest-pipeline

URL に対する HTTP 要求を行うパイプラインを表します。 パイプラインには、サーバーに対して行われる前と後の各要求の操作を管理するための複数のポリシーを含めることができます。

メソッド

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>