PipelineRequestOptions interface

Pakket:
@azure/core-https

Instellingen voor het initialiseren van een aanvraag. Bijna gelijk aan Partial<PipelineRequest>, maar url is verplicht.

Eigenschappen

abortSignal

Wordt gebruikt om de aanvraag later af te breken.
body

De INHOUD van de HTTP-hoofdtekst (indien aanwezig)
formData

Een browserformulierbericht simuleren
headers

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

Als de verbinding opnieuw moet worden gebruikt. De standaardwaarde is true.
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 het uploaden.
proxySettings

Proxy-configuratie.
requestId

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

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

Een lijst met antwoordstatuscodes waarvan de bijbehorende hoofdtekst PipelineResponse 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 er een AbortError gegenereerd. De standaardwaarde is 0, waardoor de time-out wordt uitgeschakeld.
url

De URL waarnaar de aanvraag moet worden verzonden.
withCredentials

Als referenties (cookies) tijdens een XHR moeten worden verzonden. Standaard ingesteld op onwaar.

Eigenschapdetails

abortSignal

Wordt gebruikt om de aanvraag later af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

body

De INHOUD van de HTTP-hoofdtekst (indien aanwezig)

body?: RequestBodyType

Waarde van eigenschap

RequestBodyType

formData

Een browserformulierbericht 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

keepAlive

Als de verbinding opnieuw moet worden gebruikt. De standaardwaarde is true.

keepAlive?: boolean

Waarde van eigenschap

boolean

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 het uploaden.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

proxySettings

Proxy-configuratie.

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

spanOptions

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

spanOptions?: SpanOptions

Waarde van eigenschap

@azure/core-tracing.SpanOptions

streamResponseStatusCodes

Een lijst met antwoordstatuscodes waarvan de bijbehorende hoofdtekst PipelineResponse 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 er een AbortError gegenereerd. De standaardwaarde is 0, waardoor de time-out wordt uitgeschakeld.

timeout?: number

Waarde van eigenschap

number

url

De URL waarnaar de aanvraag moet worden verzonden.

url: string

Waarde van eigenschap

string

withCredentials

Als referenties (cookies) tijdens een XHR moeten worden verzonden. Standaard ingesteld op onwaar.

withCredentials?: boolean

Waarde van eigenschap

boolean