WebResource class

  • Referens
Paket:
@azure/core-http

Skapar ett nytt WebResource-objekt.

Den här klassen ger en abstraktion över ett REST-anrop genom att vara biblioteks-/implementeringsagnostisk och omsluta nödvändiga egenskaper för att initiera en begäran.

Konstruktorer

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

Egenskaper

abortSignal

Signal för en avbruten styrenhet. Kan användas för att avbryta både skicka en nätverksbegäran och vänta på ett svar.
body

Begärandetext.
decompressResponse

Om svar ska dekomprimeras enligt Accept-Encoding -huvudet (endast nodhämtning)
formData

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

HTTP-huvuden.
keepAlive

Om HTTP-anslutningarna ska hållas vid liv i begäranden.
method

HTTP-metod som ska användas.
onDownloadProgress

Återanrop som utlöses vid nedladdningsframställning.
onUploadProgress

Återanrop som utlöses vid uppladdningens 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

Specifikation av HTTP-begäran.
proxySettings

Vilken proxy som ska användas, om det behövs.
query

Frågan har lagts till i URL:en.
requestId

Unik identifierare för den utgående begäran.
shouldDeserialize

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

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

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

En lista över statuskoder vars motsvarande HttpOperationResponse-brödtext ska behandlas som en dataström.
timeout

Hur länge du ska vänta i millisekunder innan du avbryter begäran.
tracingContext

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

URL för den utgående begäran.
withCredentials

Om du vill skicka autentiseringsuppgifter (via cookies, auktoriseringshuvuden eller TLS-klientcertifikat) när du gör en begäran i webbläsaren till ett mål mellan webbplatser.

Metoder

clone()

Klona det här WEBResource HTTP-begärandeobjektet.
prepare(RequestPrepareOptions)

Förbereder begäran.
validateRequestProperties()

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

Konstruktorinformation

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

Parametrar

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>

Egenskapsinformation

abortSignal

Signal för en avbruten styrenhet. Kan användas för att avbryta både skicka en nätverksbegäran och vänta på ett svar.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

body

Begärandetext.

body?: any

Egenskapsvärde

any

decompressResponse

Om svar ska dekomprimeras enligt Accept-Encoding -huvudet (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

HTTP-huvuden.

headers: HttpHeadersLike

Egenskapsvärde

HttpHeadersLike

keepAlive

Om HTTP-anslutningarna ska hållas vid liv i begäranden.

keepAlive?: boolean

Egenskapsvärde

boolean

method

HTTP-metod som ska användas.

method: HttpMethods

Egenskapsvärde

HttpMethods

onDownloadProgress

Återanrop som utlöses vid nedladdningsframställning.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

onUploadProgress

Återanrop som utlöses vid uppladdningens 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

Specifikation av HTTP-begäran.

operationSpec?: OperationSpec

Egenskapsvärde

OperationSpec

proxySettings

Vilken proxy som ska användas, om det behövs.

proxySettings?: ProxySettings

Egenskapsvärde

ProxySettings

query

Frågan har lagts till i URL:en.

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

Egenskapsvärde

{[key: string]: any}

requestId

Unik identifierare för den utgående begäran.

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

spanOptions

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

spanOptions?: SpanOptions

Egenskapsvärde

@azure/core-tracing.SpanOptions

streamResponseBody

Varning

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

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

Egenskapsvärde

boolean

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

Egenskapsvärde

Set<number>

timeout

Hur länge du ska vänta i millisekunder innan du avbryter begäran.

timeout: number

Egenskapsvärde

number

tracingContext

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

tracingContext?: Context

Egenskapsvärde

@azure/core-tracing.Context

url

URL för den utgående begäran.

url: string

Egenskapsvärde

string

withCredentials

Om du vill skicka autentiseringsuppgifter (via cookies, auktoriseringshuvuden eller TLS-klientcertifikat) när du gör en begäran i webbläsaren till ett mål mellan webbplatser.

withCredentials: boolean

Egenskapsvärde

boolean

Metodinformation

clone()

Klona det här WEBResource HTTP-begärandeobjektet.

function clone(): WebResource

Returer

WebResource

Klonen av det här WEBResource HTTP-begärandeobjektet.

prepare(RequestPrepareOptions)

Förbereder begäran.

function prepare(options: RequestPrepareOptions): WebResource

Parametrar

options
RequestPrepareOptions

Alternativ för att förbereda begäran.

Returer

WebResource

Returnerar det förberedda WebResource-objektet (HTTP-begäran) som måste ges till begärandepipelinen.

validateRequestProperties()

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

function validateRequestProperties()