WebResourceLike interface

Pakket:

@azure/core-http

Een beschrijving van een HTTP-aanvraag die moet worden gedaan op een externe server.

Eigenschappen

abortSignal	Signaal van een afgebroken controller. Kan worden gebruikt om het verzenden van een netwerkaanvraag af te breken en te wachten op een antwoord.
body	De inhoud van de HTTP-hoofdtekst van de aanvraag.
decompressResponse	Of u het antwoord al dan niet wilt decomprimeren volgens Accept-Encoding header (alleen node-fetch)
formData	Formuliergegevens, die worden gebruikt om de hoofdtekst van de aanvraag te bouwen.
headers	De HTTP-headers die moeten worden gebruikt bij het indienen van de aanvraag.
keepAlive	Als de verbinding opnieuw moet worden gebruikt.
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.
operationResponseGetter	Een functie die de juiste OperationResponse retourneert voor de opgegeven Combinatie OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige statuscodezoekactie gebruikt.
operationSpec	Wordt gebruikt om het antwoord te parseren.
proxySettings	Proxyconfiguratie.
query	Een querytekenreeks die wordt weergegeven als een object.
requestId	Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering.
shouldDeserialize	Of httpOperationResponse al dan niet moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.
streamResponseBody	Of de hoofdtekst van de HttpOperationResponse al dan niet als een stream moet worden behandeld.
streamResponseStatusCodes	Een lijst met antwoordstatuscodes waarvan de bijbehorende hoofdtekst HttpOperationResponse moet worden behandeld als een stream.
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.
tracingContext	Tracering: Context die wordt gebruikt bij het maken van spans.
url	De URL die wordt geopend door de aanvraag.
withCredentials	Als referenties (cookies) tijdens een XHR moeten worden verzonden.

Methoden

clone()	Kloon dit aanvraagobject.
prepare(RequestPrepareOptions)	Hiermee stelt u opties in voor de aanvraag.
validateRequestProperties()	Valideert of de vereiste eigenschappen, zoals methode, URL, headers["Content-Type"], headers["accept-language"] zijn gedefinieerd. Er wordt een fout gegenereerd als een van de bovenstaande eigenschappen niet is gedefinieerd.

Eigenschapdetails

abortSignal

Signaal van een afgebroken controller. Kan worden gebruikt om het verzenden van een netwerkaanvraag af te breken en te wachten op een antwoord.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

body

De inhoud van de HTTP-hoofdtekst van de aanvraag.

body?: any

Waarde van eigenschap

any

decompressResponse

Of u het antwoord al dan niet wilt decomprimeren volgens Accept-Encoding header (alleen node-fetch)

decompressResponse?: boolean

Waarde van eigenschap

boolean

formData

Formuliergegevens, die worden gebruikt om de hoofdtekst van de aanvraag te bouwen.

formData?: any

Waarde van eigenschap

any

headers

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

headers: HttpHeadersLike

Waarde van eigenschap

HttpHeadersLike

keepAlive

Als de verbinding opnieuw moet worden gebruikt.

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

operationResponseGetter

Een functie die de juiste OperationResponse retourneert voor de opgegeven Combinatie OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige statuscodezoekactie gebruikt.

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

Waarde van eigenschap

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

operationSpec

Wordt gebruikt om het antwoord te parseren.

operationSpec?: OperationSpec

Waarde van eigenschap

OperationSpec

proxySettings

Proxyconfiguratie.

proxySettings?: ProxySettings

Waarde van eigenschap

ProxySettings

query

Een querytekenreeks die wordt weergegeven als een object.

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

Waarde van eigenschap

{[key: string]: any}

requestId

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

requestId: string

Waarde van eigenschap

string

shouldDeserialize

Of httpOperationResponse al dan niet moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.

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

Waarde van eigenschap

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Waarschuwing

Deze API is nu afgeschaft.

Use streamResponseStatusCodes property instead.

Of de hoofdtekst van de HttpOperationResponse al dan niet als een stream moet worden behandeld.

streamResponseBody?: boolean

Waarde van eigenschap

boolean

streamResponseStatusCodes

Een lijst met antwoordstatuscodes waarvan de bijbehorende hoofdtekst HttpOperationResponse moet worden behandeld als een stream.

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.

timeout: number

Waarde van eigenschap

number

tracingContext

Tracering: Context die wordt gebruikt bij het maken van spans.

tracingContext?: Context

Waarde van eigenschap

@azure/core-tracing.Context

url

De URL die wordt geopend door de aanvraag.

url: string

Waarde van eigenschap

string

withCredentials

Als referenties (cookies) tijdens een XHR moeten worden verzonden.

withCredentials: boolean

Waarde van eigenschap

boolean

Methodedetails

clone()

Kloon dit aanvraagobject.

function clone(): WebResourceLike

Retouren

WebResourceLike

prepare(RequestPrepareOptions)

Hiermee stelt u opties in voor de aanvraag.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parameters

options

RequestPrepareOptions

Retouren

WebResourceLike

validateRequestProperties()

Valideert of de vereiste eigenschappen, zoals methode, URL, headers["Content-Type"], headers["accept-language"] zijn gedefinieerd. Er wordt een fout gegenereerd als een van de bovenstaande eigenschappen niet is gedefinieerd.

function validateRequestProperties()