WebResource class

Pakket:

@azure/storage-queue

Hiermee maakt u een nieuw WebResource-object.

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

Constructors

WebResource(string, HttpMethods, unknown, {[key: string]: any}, HttpHeadersLike | {[key: string]: any}, 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 zowel het verzenden van een netwerkaanvraag als het wachten op een antwoord af te breken.
body	Hoofdtekst van aanvraag.
decompressResponse	Of het antwoord al dan niet moet worden gedecomprimerd volgens Accept-Encoding-header (alleen knooppunt ophalen)
formData	Formuliergegevens, die worden gebruikt om de aanvraagbody te maken.
headers	HTTP-headers.
keepAlive	Of de HTTP-verbindingen actief moeten blijven tijdens aanvragen.
method	Te gebruiken HTTP-methode.
onDownloadProgress	Callback die wordt geactiveerd bij de voortgang van het downloaden.
onUploadProgress	Callback die wordt geactiveerd bij de uploadvoortgang.
operationResponseGetter	Een functie die de juiste OperationResponse retourneert voor de opgegeven combinatie van OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige opzoekactie voor statuscodes gebruikt.
operationSpec	Specificatie van de HTTP-aanvraag.
proxySettings	Welke proxy moet worden gebruikt, indien nodig.
query	Query toegevoegd aan de URL.
requestId	De unieke id van de uitgaande aanvraag.
shouldDeserialize	Of de HttpOperationResponse moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.
spanOptions	Tracering: opties die worden gebruikt om een span te maken wanneer tracering is ingeschakeld.
streamResponseBody	Of de hoofdtekst van de HttpOperationResponse moet worden behandeld als een stroom.
streamResponseStatusCodes	Een lijst met statuscodes waarvan de bijbehorende HttpOperationResponse-hoofdtekst moet worden behandeld als een stroom.
timeout	Hoe lang moet worden gewacht 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 referenties (via cookies, autorisatieheaders of TLS-clientcertificaten) moeten worden verzonden bij het indienen van een aanvraag in de browser naar een siteoverschrijdende bestemming.

Methoden

clone()	Kloon dit WebResource HTTP-aanvraagobject.
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}, HttpHeadersLike | {[key: string]: any}, 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?: HttpHeadersLike | {[key: string]: any}, 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

HttpHeadersLike | {[key: string]: any}

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 zowel het verzenden van een netwerkaanvraag als het wachten op een antwoord af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

body

Hoofdtekst van aanvraag.

body?: any

Waarde van eigenschap

any

decompressResponse

Of het antwoord al dan niet moet worden gedecomprimerd volgens Accept-Encoding-header (alleen knooppunt ophalen)

decompressResponse?: boolean

Waarde van eigenschap

boolean

formData

Formuliergegevens, die worden gebruikt om de aanvraagbody te maken.

formData?: any

Waarde van eigenschap

any

headers

HTTP-headers.

headers: HttpHeadersLike

Waarde van eigenschap

HttpHeadersLike

keepAlive

Of de HTTP-verbindingen actief moeten blijven tijdens aanvragen.

keepAlive?: boolean

Waarde van eigenschap

boolean

method

Te gebruiken HTTP-methode.

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 de uploadvoortgang.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

operationResponseGetter

Een functie die de juiste OperationResponse retourneert voor de opgegeven combinatie van OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige opzoekactie voor statuscodes 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

De unieke id van de uitgaande aanvraag.

requestId: string

Waarde van eigenschap

string

shouldDeserialize

Of de HttpOperationResponse 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 span 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 moet worden behandeld als een stroom.

streamResponseBody?: boolean

Waarde van eigenschap

boolean

streamResponseStatusCodes

Een lijst met statuscodes waarvan de bijbehorende HttpOperationResponse-hoofdtekst moet worden behandeld als een stroom.

streamResponseStatusCodes?: Set<number>

Waarde van eigenschap

Set<number>

timeout

Hoe lang moet worden gewacht 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 referenties (via cookies, autorisatieheaders of TLS-clientcertificaten) moeten worden verzonden bij het indienen van een aanvraag in de browser naar een siteoverschrijdende bestemming.

withCredentials: boolean

Waarde van eigenschap

boolean

Methodedetails

clone()

Kloon dit WebResource HTTP-aanvraagobject.

function clone(): WebResource

Retouren

WebResource

De kloon van dit WebResource HTTP-aanvraagobject.

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 WebResource-object (HTTP-aanvraag) dat moet worden opgegeven 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()