WebResourceLike interface

Paket:

@azure/core-http

En beskrivning av en HTTP-begäran som ska göras till en fjärrserver.

Egenskaper

abortSignal	Signal om en avbruten styrenhet. Kan användas för att avbryta både sändning av en nätverksbegäran och väntar på ett svar.
body	HTTP-brödtextinnehållet i begäran.
decompressResponse	Om du vill dekomprimera svaret enligt Accept-Encoding huvud (endast nodhämtning)
formData	Formulärdata som används för att skapa begärandetexten.
headers	DE HTTP-huvuden som ska användas när du gör begäran.
keepAlive	Om anslutningen ska återanvändas.
method	DEN HTTP-metod som ska användas när du gör begäran.
onDownloadProgress	Återanrop som utlöses när nedladdningen förlopp.
onUploadProgress	Återanrop som utlöses när uppladdningen förlopp.
operationResponseGetter	En funktion som returnerar rätt OperationResponse för den angivna kombinationen OperationSpec och HttpOperationResponse. Om detta är odefinierat används en enkel statuskodsökning.
operationSpec	Används för att parsa svaret.
proxySettings	Proxykonfiguration.
query	En frågesträng som representeras som ett objekt.
requestId	En unik identifierare för begäran. Används för loggning och spårning.
shouldDeserialize	Om HttpOperationResponse ska deserialiseras eller inte. Om detta är odefinierat bör HttpOperationResponse deserialiseras.
streamResponseBody	Om brödtexten i HttpOperationResponse ska behandlas som en ström eller inte.
streamResponseStatusCodes	En lista över svarsstatuskoder vars motsvarande HttpOperationResponse-brödtext ska behandlas som en ström.
timeout	Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt. Om begäran avslutas utlöses en AbortError.
tracingContext	Spårning: Kontext som används när du skapar intervall.
url	Url:en som används av begäran.
withCredentials	Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR.

Metoder

clone()	Klona det här begärandeobjektet.
prepare(RequestPrepareOptions)	Anger alternativ för begäran.
validateRequestProperties()	Verifierar att de egenskaper som krävs, till exempel metod, URL, rubriker["Content-Type"], rubriker["accept-language"] har definierats. Det utlöser ett fel om någon av ovanstående egenskaper inte har definierats.

Egenskapsinformation

abortSignal

Signal om en avbruten styrenhet. Kan användas för att avbryta både sändning av en nätverksbegäran och väntar på ett svar.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

body

HTTP-brödtextinnehållet i begäran.

body?: any

Egenskapsvärde

any

decompressResponse

Om du vill dekomprimera svaret enligt Accept-Encoding huvud (endast nodhämtning)

decompressResponse?: boolean

Egenskapsvärde

boolean

formData

Formulärdata som används för att skapa begärandetexten.

formData?: any

Egenskapsvärde

any

headers

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

headers: HttpHeadersLike

Egenskapsvärde

HttpHeadersLike

keepAlive

Om anslutningen ska återanvändas.

keepAlive?: boolean

Egenskapsvärde

boolean

method

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

method: HttpMethods

Egenskapsvärde

HttpMethods

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

operationResponseGetter

En funktion som returnerar rätt OperationResponse för den angivna kombinationen OperationSpec och HttpOperationResponse. Om detta är odefinierat används en enkel statuskodsökning.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

Egenskapsvärde

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Används för att parsa svaret.

operationSpec?: OperationSpec

Egenskapsvärde

OperationSpec

proxySettings

Proxykonfiguration.

proxySettings?: ProxySettings

Egenskapsvärde

ProxySettings

query

En frågesträng som representeras som ett objekt.

query?: {[key: string]: any}

Egenskapsvärde

{[key: string]: any}

requestId

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

requestId: string

Egenskapsvärde

string

shouldDeserialize

Om HttpOperationResponse ska deserialiseras eller inte. Om detta är odefinierat bör HttpOperationResponse deserialiseras.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Egenskapsvärde

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Varning

Det här API:et är nu inaktuellt.

Use streamResponseStatusCodes property instead.

Om brödtexten i HttpOperationResponse ska behandlas som en ström eller inte.

streamResponseBody?: boolean

Egenskapsvärde

boolean

streamResponseStatusCodes

En lista över svarsstatuskoder vars motsvarande HttpOperationResponse-brödtext ska behandlas som en strö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.

timeout: number

Egenskapsvärde

number

tracingContext

Spårning: Kontext som används när du skapar intervall.

tracingContext?: Context

Egenskapsvärde

@azure/core-tracing.Context

url

Url:en som används av begäran.

url: string

Egenskapsvärde

string

withCredentials

Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR.

withCredentials: boolean

Egenskapsvärde

boolean

Metodinformation

clone()

Klona det här begärandeobjektet.

function clone(): WebResourceLike

Returer

WebResourceLike

prepare(RequestPrepareOptions)

Anger alternativ för begäran.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametrar

options

RequestPrepareOptions

Returer

WebResourceLike

validateRequestProperties()

Verifierar att de egenskaper som krävs, till exempel metod, URL, rubriker["Content-Type"], rubriker["accept-language"] har definierats. Det utlöser ett fel om någon av ovanstående egenskaper inte har definierats.

function validateRequestProperties()