PipelineRequestOptions interface

Paket:

@azure/core-rest-pipeline

Inställningar för att initiera en begäran. Nästan likvärdigt med Partiell, men URL är obligatoriskt.

Egenskaper

abortSignal	Används för att avbryta begäran senare.
agent	ENDAST NODEJS Ett alternativ endast för noder för att tillhandahålla en anpassad http.Agent/https.Agent. Obs! Detta bör vanligtvis vara en instans som delas av flera begäranden så att den underliggande anslutningen till tjänsten kan återanvändas. Gör ingenting när du kör i webbläsaren.
allowInsecureConnection	Ange sant om begäran skickas via HTTP i stället för HTTPS
body	HTTP-brödtextinnehållet (om det finns något)
disableKeepAlive	Om anslutningen inte ska återanvändas.
enableBrowserStreams	ENDAST WEBBLÄSARE Ett webbläsaralternativ för att aktivera användning av Streams-API:et. Om det här alternativet anges och direktuppspelning används (se streamResponseStatusCodes) har svaret en egenskap browserStream i stället för blobBody som kommer att vara odefinierad. Standardvärdet är falskt
formData	Så här simulerar du ett webbläsarformulärinlägg
headers	DE HTTP-huvuden som ska användas när du gör begäran.
method	DEN HTTP-metod som ska användas när du gör begäran.
multipartBody	Brödtext för en begäran med flera delar.
onDownloadProgress	Återanrop som utlöses när nedladdningen förlopp.
onUploadProgress	Återanrop som utlöses när uppladdningen förlopp.
proxySettings	Proxykonfiguration.
requestId	En unik identifierare för begäran. Används för loggning och spårning.
streamResponseStatusCodes	En lista över svarsstatuskoder vars motsvarande PipelineResponse-brödtext ska behandlas som en dataström.
timeout	Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt. Om begäran avslutas utlöses en AbortError. Standardvärdet är 0, vilket inaktiverar tidsgränsen.
tlsSettings	Inställningar för att konfigurera TLS-autentisering
tracingOptions	Alternativ som används för att skapa ett spann när spårning är aktiverat.
url	URL:en som begäran ska skickas till.
withCredentials	Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR. Standardvärdet är falskt.

Egenskapsinformation

abortSignal

Används för att avbryta begäran senare.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

agent

ENDAST NODEJS

Ett alternativ endast för noder för att tillhandahålla en anpassad http.Agent/https.Agent. Obs! Detta bör vanligtvis vara en instans som delas av flera begäranden så att den underliggande anslutningen till tjänsten kan återanvändas. Gör ingenting när du kör i webbläsaren.

agent?: Agent

Egenskapsvärde

Agent

allowInsecureConnection

Ange sant om begäran skickas via HTTP i stället för HTTPS

allowInsecureConnection?: boolean

Egenskapsvärde

boolean

body

HTTP-brödtextinnehållet (om det finns något)

body?: RequestBodyType

Egenskapsvärde

RequestBodyType

disableKeepAlive

Om anslutningen inte ska återanvändas.

disableKeepAlive?: boolean

Egenskapsvärde

boolean

enableBrowserStreams

ENDAST WEBBLÄSARE

Ett webbläsaralternativ för att aktivera användning av Streams-API:et. Om det här alternativet anges och direktuppspelning används (se streamResponseStatusCodes) har svaret en egenskap browserStream i stället för blobBody som kommer att vara odefinierad.

Standardvärdet är falskt

enableBrowserStreams?: boolean

Egenskapsvärde

boolean

formData

Så här simulerar du ett webbläsarformulärinlägg

formData?: FormDataMap

Egenskapsvärde

FormDataMap

headers

DE HTTP-huvuden som ska användas när du gör begäran.

headers?: HttpHeaders

Egenskapsvärde

HttpHeaders

method

DEN HTTP-metod som ska användas när du gör begäran.

method?: HttpMethods

Egenskapsvärde

HttpMethods

multipartBody

Brödtext för en begäran med flera delar.

multipartBody?: MultipartRequestBody

Egenskapsvärde

MultipartRequestBody

onDownloadProgress

Återanrop som utlöses när nedladdningen förlopp.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

onUploadProgress

Återanrop som utlöses när uppladdningen förlopp.

onUploadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

proxySettings

Proxykonfiguration.

proxySettings?: ProxySettings

Egenskapsvärde

ProxySettings

requestId

En unik identifierare för begäran. Används för loggning och spårning.

requestId?: string

Egenskapsvärde

string

streamResponseStatusCodes

En lista över svarsstatuskoder vars motsvarande PipelineResponse-brödtext ska behandlas som en dataström.

streamResponseStatusCodes?: Set<number>

Egenskapsvärde

Set<number>

timeout

Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt. Om begäran avslutas utlöses en AbortError. Standardvärdet är 0, vilket inaktiverar tidsgränsen.

timeout?: number

Egenskapsvärde

number

tlsSettings

Inställningar för att konfigurera TLS-autentisering

tlsSettings?: TlsSettings

Egenskapsvärde

TlsSettings

tracingOptions

Alternativ som används för att skapa ett spann när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

url

URL:en som begäran ska skickas till.

url: string

Egenskapsvärde

string

withCredentials

Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR. Standardvärdet är falskt.

withCredentials?: boolean

Egenskapsvärde

boolean