PipelineRequestOptions interface

Pakket:

@azure/core-rest-pipeline

Instellingen voor het initialiseren van een aanvraag. Bijna gelijk aan Gedeeltelijk, maar URL is verplicht.

Eigenschappen

abortSignal	Wordt gebruikt om de aanvraag later af te breken.
allowInsecureConnection	Ingesteld op waar als de aanvraag wordt verzonden via HTTP in plaats van HTTPS
body	De HTTP-hoofdtekstinhoud (indien aanwezig)
disableKeepAlive	Als de verbinding niet opnieuw moet worden gebruikt.
enableBrowserStreams	ALLEEN BROWSER Een browseroptie om het gebruik van de Streams-API in te schakelen. Als deze optie is ingesteld en streaming wordt gebruikt (zie streamResponseStatusCodes), heeft het antwoord een eigenschap browserStream in plaats van blobBody dat deze niet is gedefinieerd. De standaardwaarde is onwaar
formData	Een bericht in een browserformulier simuleren
headers	De HTTP-headers die moeten worden gebruikt bij het indienen van de aanvraag.
method	De HTTP-methode die moet worden gebruikt bij het indienen van de aanvraag.
onDownloadProgress	Callback die wordt geactiveerd bij de voortgang van het downloaden.
onUploadProgress	Callback die wordt geactiveerd bij de uploadvoortgang.
proxySettings	Proxyconfiguratie.
requestId	Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering.
streamResponseStatusCodes	Een lijst met antwoordstatuscodes waarvan de bijbehorende PipelineResponse-hoofdtekst moet worden behandeld als een stroom.
timeout	Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd. Als de aanvraag wordt beëindigd, wordt een AbortError gegenereerd. De standaardwaarde is 0, waardoor de time-out wordt uitgeschakeld.
tracingOptions	Opties die worden gebruikt om een span te maken wanneer tracering is ingeschakeld.
url	De URL waarnaar de aanvraag moet worden verzonden.
withCredentials	Als referenties (cookies) moeten worden verzonden tijdens een XHR. De standaardinstelling is false.

Eigenschapdetails

abortSignal

Wordt gebruikt om de aanvraag later af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

allowInsecureConnection

Ingesteld op waar als de aanvraag wordt verzonden via HTTP in plaats van HTTPS

allowInsecureConnection?: boolean

Waarde van eigenschap

boolean

body

De HTTP-hoofdtekstinhoud (indien aanwezig)

body?: RequestBodyType

Waarde van eigenschap

RequestBodyType

disableKeepAlive

Als de verbinding niet opnieuw moet worden gebruikt.

disableKeepAlive?: boolean

Waarde van eigenschap

boolean

enableBrowserStreams

ALLEEN BROWSER

Een browseroptie om het gebruik van de Streams-API in te schakelen. Als deze optie is ingesteld en streaming wordt gebruikt (zie streamResponseStatusCodes), heeft het antwoord een eigenschap browserStream in plaats van blobBody dat deze niet is gedefinieerd.

De standaardwaarde is onwaar

enableBrowserStreams?: boolean

Waarde van eigenschap

boolean

formData

Een bericht in een browserformulier simuleren

formData?: FormDataMap

Waarde van eigenschap

FormDataMap

headers

De HTTP-headers die moeten worden gebruikt bij het indienen van de aanvraag.

headers?: HttpHeaders

Waarde van eigenschap

HttpHeaders

method

De HTTP-methode die moet worden gebruikt bij het indienen van de aanvraag.

method?: HttpMethods

Waarde van eigenschap

HttpMethods

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

onUploadProgress

Callback die wordt geactiveerd bij de uploadvoortgang.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

proxySettings

Proxyconfiguratie.

proxySettings?: ProxySettings

Waarde van eigenschap

ProxySettings

requestId

Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering.

requestId?: string

Waarde van eigenschap

string

streamResponseStatusCodes

Een lijst met antwoordstatuscodes waarvan de bijbehorende PipelineResponse-hoofdtekst moet worden behandeld als een stroom.

streamResponseStatusCodes?: Set<number>

Waarde van eigenschap

Set<number>

timeout

Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd. Als de aanvraag wordt beëindigd, wordt een AbortError gegenereerd. De standaardwaarde is 0, waardoor de time-out wordt uitgeschakeld.

timeout?: number

Waarde van eigenschap

number

tracingOptions

Opties die worden gebruikt om een span te maken wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

url

De URL waarnaar de aanvraag moet worden verzonden.

url: string

Waarde van eigenschap

string

withCredentials

Als referenties (cookies) moeten worden verzonden tijdens een XHR. De standaardinstelling is false.

withCredentials?: boolean

Waarde van eigenschap

boolean