PipelineRequest interface

Pakket:

@azure/core-rest-pipeline

Metagegevens over een aanvraag die door de pijplijn wordt ingediend.

Eigenschappen

abortSignal	Wordt gebruikt om de aanvraag later af te breken.
agent	ALLEEN NODEJS Een optie voor alleen knooppunten om een aangepaste http.Agent/https.Agentop te geven. Doet niets wanneer deze wordt uitgevoerd in de browser.
allowInsecureConnection	Ingesteld op waar als de aanvraag via HTTP wordt verzonden in plaats van HTTPS
body	De INHOUD van de HTTP-hoofdtekst (indien aanwezig)
disableKeepAlive	Als de verbinding niet opnieuw moet worden gebruikt.
enableBrowserStreams	ALLEEN BROWSER Een browseroptie om browserstreams in te schakelen. Als deze optie is ingesteld en een antwoord een stream is, heeft het antwoord een eigenschap browserStream in plaats van blobBody die niet is gedefinieerd. De standaardwaarde is onwaar
formData	Een browserformulierbericht 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.
multipartBody	Hoofdtekst voor een aanvraag met meerdere onderdelen.
onDownloadProgress	Callback die wordt geactiveerd bij de voortgang van het downloaden.
onUploadProgress	Callback die wordt geactiveerd bij het uploaden.
proxySettings	Proxyconfiguratie.
requestId	Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering.
streamResponseStatusCodes	Een lijst met antwoordstatuscodes waarvan de bijbehorende hoofdtekst PipelineResponse moet worden behandeld als een stroom. Wanneer streamResponseStatusCodes de waarde bevat Number.POSITIVE_INFINITY elke status als een stream wordt behandeld.
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.
tlsSettings	Instellingen voor het configureren van TLS-verificatie
tracingOptions	Traceringsopties die moeten worden gebruikt voor gemaakte spans.
url	De URL waarnaar de aanvraag moet worden verzonden.
withCredentials	Hiermee wordt aangegeven of de gebruikersagent cookies moet verzenden vanuit het andere domein in het geval van cross-origin-aanvragen. De standaardwaarde is onwaar.

Eigenschapdetails

abortSignal

Wordt gebruikt om de aanvraag later af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

agent

ALLEEN NODEJS

Een optie voor alleen knooppunten om een aangepaste http.Agent/https.Agentop te geven. Doet niets wanneer deze wordt uitgevoerd in de browser.

agent?: Agent

Waarde van eigenschap

Agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

Waarde van eigenschap

boolean

body

De INHOUD van de HTTP-hoofdtekst (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 browserstreams in te schakelen. Als deze optie is ingesteld en een antwoord een stream is, heeft het antwoord een eigenschap browserStream in plaats van blobBody die niet is gedefinieerd.

De standaardwaarde is onwaar

enableBrowserStreams?: boolean

Waarde van eigenschap

boolean

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

method

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

method: HttpMethods

Waarde van eigenschap

HttpMethods

multipartBody

Hoofdtekst voor een aanvraag met meerdere onderdelen.

multipartBody?: MultipartRequestBody

Waarde van eigenschap

MultipartRequestBody

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

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 hoofdtekst PipelineResponse moet worden behandeld als een stroom. Wanneer streamResponseStatusCodes de waarde bevat Number.POSITIVE_INFINITY elke status als een stream wordt behandeld.

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

tlsSettings

Instellingen voor het configureren van TLS-verificatie

tlsSettings?: TlsSettings

Waarde van eigenschap

TlsSettings

tracingOptions

Traceringsopties die moeten worden gebruikt voor gemaakte spans.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

url

De URL waarnaar de aanvraag moet worden verzonden.

url: string

Waarde van eigenschap

string

withCredentials

Hiermee wordt aangegeven of de gebruikersagent cookies moet verzenden vanuit het andere domein in het geval van cross-origin-aanvragen. De standaardwaarde is onwaar.

withCredentials: boolean

Waarde van eigenschap

boolean