Freigeben über

Pipeline interface

  • Referenz
Paket:
@azure/core-rest-pipeline

Stellt eine Pipeline zum Stellen einer HTTP-Anforderung an eine URL dar. Pipelines können über mehrere Richtlinien verfügen, um die Bearbeitung jeder Anforderung vor und nach ihrer Erstellung an den Server zu verwalten.

Methoden

addPolicy(PipelinePolicy, AddPipelineOptions)

Fügen Sie der Pipeline eine neue Richtlinie hinzu.
clone()

Dupliziert diese Pipeline, um das Ändern einer vorhandenen Pipeline zu ermöglichen, ohne sie zu mutieren.
getOrderedPolicies()

Gibt den aktuellen Richtliniensatz in der Pipeline in der Reihenfolge zurück, in der sie auf die Anforderung angewendet werden. Später in der Liste ist näher an dem Zeitpunkt, an dem die Anforderung ausgeführt wird.
removePolicy({ name?: string, phase?: PipelinePhase })

Entfernen Sie eine Richtlinie aus der Pipeline.
sendRequest(HttpClient, PipelineRequest)

Verwendet die Pipeline, um eine HTTP-Anforderung zu stellen.

Details zur Methode

addPolicy(PipelinePolicy, AddPipelineOptions)

Fügen Sie der Pipeline eine neue Richtlinie hinzu.

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

Parameter

policy
PipelinePolicy

Eine Richtlinie, die eine Anforderung bearbeitet.

options
AddPipelineOptions

Eine Reihe von Optionen für den Zeitpunkt, zu dem die Richtlinie ausgeführt werden soll.

clone()

Dupliziert diese Pipeline, um das Ändern einer vorhandenen Pipeline zu ermöglichen, ohne sie zu mutieren.

function clone(): Pipeline

Gibt zurück

Pipeline

getOrderedPolicies()

Gibt den aktuellen Richtliniensatz in der Pipeline in der Reihenfolge zurück, in der sie auf die Anforderung angewendet werden. Später in der Liste ist näher an dem Zeitpunkt, an dem die Anforderung ausgeführt wird.

function getOrderedPolicies(): PipelinePolicy[]

Gibt zurück

PipelinePolicy[]

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

Entfernen Sie eine Richtlinie aus der Pipeline.

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

Parameter

options

{ name?: string, phase?: PipelinePhase }

Optionen, mit denen Sie angeben können, welche Richtlinien entfernt werden sollen.

Gibt zurück

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

Verwendet die Pipeline, um eine HTTP-Anforderung zu stellen.

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

Parameter

httpClient
HttpClient

Der HttpClient, der die Anforderung tatsächlich ausführt.

request
PipelineRequest

Der zu stellende Antrag.

Gibt zurück

Promise<PipelineResponse>