Pipeline interface

Pakket:

@azure/core-rest-pipeline

Vertegenwoordigt een pijplijn voor het maken van een HTTP-aanvraag naar een URL. Pijplijnen kunnen meerdere beleidsregels hebben voor het beheren van het bewerken van elke aanvraag voor en nadat deze op de server is aangebracht.

Methoden

addPolicy(PipelinePolicy, AddPolicyOptions)	Voeg een nieuw beleid toe aan de pijplijn.
clone()	Hiermee wordt deze pijplijn gedupliceerd om een bestaande pijplijn te wijzigen zonder deze te dempen.
getOrderedPolicies()	Retourneert de huidige set beleidsregels in de pijplijn in de volgorde waarin ze worden toegepast op de aanvraag. Verderop in de lijst bevindt zich dichter bij het uitvoeren van de aanvraag.
removePolicy({ name?: string, phase?: PipelinePhase })	Een beleid uit de pijplijn verwijderen.
sendRequest(HttpClient, PipelineRequest)	Maakt gebruik van de pijplijn om een HTTP-aanvraag te maken.

Methodedetails

addPolicy(PipelinePolicy, AddPolicyOptions)

Voeg een nieuw beleid toe aan de pijplijn.

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

Parameters

policy

PipelinePolicy

Een beleid waarmee een aanvraag wordt bewerkt.

options

AddPipelineOptions

Een set opties voor wanneer het beleid moet worden uitgevoerd.

clone()

Hiermee wordt deze pijplijn gedupliceerd om een bestaande pijplijn te wijzigen zonder deze te dempen.

function clone(): Pipeline

Retouren

Pipeline

getOrderedPolicies()

Retourneert de huidige set beleidsregels in de pijplijn in de volgorde waarin ze worden toegepast op de aanvraag. Verderop in de lijst bevindt zich dichter bij het uitvoeren van de aanvraag.

function getOrderedPolicies(): PipelinePolicy[]

Retouren

PipelinePolicy[]

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

Een beleid uit de pijplijn verwijderen.

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

Parameters

options

{ name?: string, phase?: PipelinePhase }

Opties waarmee u kunt opgeven welke beleidsregels u wilt verwijderen.

Retouren

PipelinePolicy[]

sendRequest(HttpClient, PipelineRequest)

Maakt gebruik van de pijplijn om een HTTP-aanvraag te maken.

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

Parameters

httpClient

HttpClient

De HttpClient die de aanvraag daadwerkelijk uitvoert.

request

PipelineRequest

Het verzoek dat moet worden ingediend.

Retouren

Promise<PipelineResponse>