WebResource class

Pakket:

@azure/core-http

Hiermee maakt u een nieuw WebResource-object.

Deze klasse biedt een abstractie over een REST-aanroep door agnostisch te zijn voor bibliotheek/implementatie en de benodigde eigenschappen te verpakken om een aanvraag te starten.

Constructors

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

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	Aanvraagtekst.
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	HTTP-headers.
keepAlive	Of de HTTP-verbindingen actief blijven gedurende alle aanvragen.
method	HTTP-methode die moet worden gebruikt.
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	Specificatie van de HTTP-aanvraag.
proxySettings	Welke proxy moet worden gebruikt, indien nodig.
query	Query toegevoegd aan de URL.
requestId	Unieke id van de uitgaande aanvraag.
shouldDeserialize	Of httpOperationResponse al dan niet moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.
spanOptions	Tracering: Opties die worden gebruikt om een periode te maken wanneer tracering is ingeschakeld.
streamResponseBody	Of de hoofdtekst van de HttpOperationResponse al dan niet als een stream moet worden behandeld.
streamResponseStatusCodes	Een lijst met statuscodes waarvan de bijbehorende hoofdtekst HttpOperationResponse moet worden behandeld als een stroom.
timeout	Hoe lang moet ik wachten in milliseconden voordat de aanvraag wordt afgebroken.
tracingContext	Tracering: Context die wordt gebruikt bij het maken van Spans.
url	URL van de uitgaande aanvraag.
withCredentials	Of u referenties (via cookies, autorisatieheaders of TLS-clientcertificaten) wilt verzenden wanneer u een aanvraag in de browser indient naar een doel voor meerdere sites.

Methoden

clone()	Kloon dit HTTP-aanvraagobject voor WebResource.
prepare(RequestPrepareOptions)	Bereidt de aanvraag voor.
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.

Constructordetails

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

Parameters

url

string

method

HttpMethods

body

unknown

query

{[key: string]: any}

headers

{[key: string]: any} | HttpHeadersLike

streamResponseBody

boolean

withCredentials

boolean

abortSignal

AbortSignalLike

timeout

number

onUploadProgress

(progress: TransferProgressEvent) => void

onDownloadProgress

(progress: TransferProgressEvent) => void

proxySettings

ProxySettings

keepAlive

boolean

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

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

Aanvraagtekst.

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

HTTP-headers.

headers: HttpHeadersLike

Waarde van eigenschap

HttpHeadersLike

keepAlive

Of de HTTP-verbindingen actief blijven gedurende alle aanvragen.

keepAlive?: boolean

Waarde van eigenschap

boolean

method

HTTP-methode die moet worden gebruikt.

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

Specificatie van de HTTP-aanvraag.

operationSpec?: OperationSpec

Waarde van eigenschap

OperationSpec

proxySettings

Welke proxy moet worden gebruikt, indien nodig.

proxySettings?: ProxySettings

Waarde van eigenschap

ProxySettings

query

Query toegevoegd aan de URL.

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

Waarde van eigenschap

{[key: string]: any}

requestId

Unieke id van de uitgaande aanvraag.

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

spanOptions

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

spanOptions?: SpanOptions

Waarde van eigenschap

@azure/core-tracing.SpanOptions

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 statuscodes waarvan de bijbehorende hoofdtekst HttpOperationResponse moet worden behandeld als een stroom.

streamResponseStatusCodes?: Set<number>

Waarde van eigenschap

Set<number>

timeout

Hoe lang moet ik wachten in milliseconden voordat de aanvraag wordt afgebroken.

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

URL van de uitgaande aanvraag.

url: string

Waarde van eigenschap

string

withCredentials

Of u referenties (via cookies, autorisatieheaders of TLS-clientcertificaten) wilt verzenden wanneer u een aanvraag in de browser indient naar een doel voor meerdere sites.

withCredentials: boolean

Waarde van eigenschap

boolean

Methodedetails

clone()

Kloon dit HTTP-aanvraagobject voor WebResource.

function clone(): WebResource

Retouren

WebResource

De kloon van dit HTTP-aanvraagobject voor WebResource.

prepare(RequestPrepareOptions)

Bereidt de aanvraag voor.

function prepare(options: RequestPrepareOptions): WebResource

Parameters

options

RequestPrepareOptions

Opties voor het voorbereiden van de aanvraag.

Retouren

WebResource

Retourneert het voorbereide Object WebResource (HTTP-aanvraag) dat moet worden gegeven aan de aanvraagpijplijn.

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()