WebResource class

Csomag:

@azure/core-http

Létrehoz egy új WebResource-objektumot.

Ez az osztály absztrakciót biztosít egy REST-híváshoz, mivel kódtár/implementáció agnosztikus, és a kérés indításához szükséges tulajdonságokat burkolja.

Konstruktorok

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

Tulajdonságok

abortSignal	Megszakító vezérlő jelzése. A hálózati kérések küldésének megszakítására és a válaszra való várakozásra is használható.
body	Kérelem törzse.
decompressResponse	A válasz Accept-Encoding fejléc szerinti felbontása (csak csomópont-lekérés)
formData	A kérelem törzsének létrehozásához használt űrlapadatok.
headers	HTTP-fejlécek.
keepAlive	A HTTP-kapcsolatok életben tartása a kérések során.
method	HASZNÁLANDÓ HTTP-metódus.
onDownloadProgress	Visszahívás, amely a letöltési folyamat során aktiválódik.
onUploadProgress	Visszahívás, amely a feltöltési folyamat során aktiválódik.
operationResponseGetter	Egy függvény, amely a megfelelő OperationResponse értéket adja vissza az adott OperationSpec és HttpOperationResponse kombinációhoz. Ha ez nincs meghatározva, akkor egy egyszerű állapotkód-keresés lesz használva.
operationSpec	A HTTP-kérelem specifikációja.
proxySettings	Milyen proxyt használjon, ha szükséges.
query	Az URL-címhez hozzáadott lekérdezés.
requestId	A kimenő kérelem egyedi azonosítója.
shouldDeserialize	Azt, hogy a HttpOperationResponse deszerializálva legyen-e. Ha ez nincs meghatározva, akkor a HttpOperationResponse-t deszerializálni kell.
spanOptions	Nyomkövetés: A hatókör létrehozására szolgáló beállítások, ha a nyomkövetés engedélyezve van.
streamResponseBody	Azt, hogy a HttpOperationResponse törzsét streamként kell-e kezelni.
streamResponseStatusCodes	Azoknak az állapotkódoknak a listája, amelyek megfelelő HttpOperationResponse törzsét streamként kell kezelni.
timeout	Mennyi ideig kell ezredmásodpercben várni a kérés megszakítása előtt.
tracingContext	Nyomkövetés: A Spans létrehozásakor használt környezet.
url	A kimenő kérés URL-címe.
withCredentials	Hitelesítő adatok küldése (cookie-k, engedélyezési fejlécek vagy TLS-ügyféltanúsítványok használatával), amikor kérést küld a böngészőben egy helyek közötti célhelyre.

Metódusok

clone()	Klónozza ezt a WebResource HTTP-kérelemobjektumot.
prepare(RequestPrepareOptions)	Előkészíti a kérést.
validateRequestProperties()	Ellenőrzi, hogy a szükséges tulajdonságok, például a metódus, az URL-cím, a fejlécek["Content-Type"], a fejlécek["accept-language"] definiálva vannak-e. Hiba jelenik meg, ha a fent említett tulajdonságok egyike nincs meghatározva.

Konstruktor adatai

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

Paraméterek

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>

Tulajdonság adatai

abortSignal

Megszakító vezérlő jelzése. A hálózati kérések küldésének megszakítására és a válaszra való várakozásra is használható.

abortSignal?: AbortSignalLike

Tulajdonság értéke

AbortSignalLike

body

Kérelem törzse.

body?: any

Tulajdonság értéke

any

decompressResponse

A válasz Accept-Encoding fejléc szerinti felbontása (csak csomópont-lekérés)

decompressResponse?: boolean

Tulajdonság értéke

boolean

formData

A kérelem törzsének létrehozásához használt űrlapadatok.

formData?: any

Tulajdonság értéke

any

headers

HTTP-fejlécek.

headers: HttpHeadersLike

Tulajdonság értéke

HttpHeadersLike

keepAlive

A HTTP-kapcsolatok életben tartása a kérések során.

keepAlive?: boolean

Tulajdonság értéke

boolean

method

HASZNÁLANDÓ HTTP-metódus.

method: HttpMethods

Tulajdonság értéke

HttpMethods

onDownloadProgress

Visszahívás, amely a letöltési folyamat során aktiválódik.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Tulajdonság értéke

(progress: TransferProgressEvent) => void

onUploadProgress

Visszahívás, amely a feltöltési folyamat során aktiválódik.

onUploadProgress?: (progress: TransferProgressEvent) => void

Tulajdonság értéke

(progress: TransferProgressEvent) => void

operationResponseGetter

Egy függvény, amely a megfelelő OperationResponse értéket adja vissza az adott OperationSpec és HttpOperationResponse kombinációhoz. Ha ez nincs meghatározva, akkor egy egyszerű állapotkód-keresés lesz használva.

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

Tulajdonság értéke

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

operationSpec

A HTTP-kérelem specifikációja.

operationSpec?: OperationSpec

Tulajdonság értéke

OperationSpec

proxySettings

Milyen proxyt használjon, ha szükséges.

proxySettings?: ProxySettings

Tulajdonság értéke

ProxySettings

query

Az URL-címhez hozzáadott lekérdezés.

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

Tulajdonság értéke

{[key: string]: any}

requestId

A kimenő kérelem egyedi azonosítója.

requestId: string

Tulajdonság értéke

string

shouldDeserialize

Azt, hogy a HttpOperationResponse deszerializálva legyen-e. Ha ez nincs meghatározva, akkor a HttpOperationResponse-t deszerializálni kell.

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

Tulajdonság értéke

boolean | (response: HttpOperationResponse) => boolean

spanOptions

Nyomkövetés: A hatókör létrehozására szolgáló beállítások, ha a nyomkövetés engedélyezve van.

spanOptions?: SpanOptions

Tulajdonság értéke

@azure/core-tracing.SpanOptions

streamResponseBody

Figyelmeztetés

Ez az API már elavult.

Use streamResponseStatusCodes property instead.

Azt, hogy a HttpOperationResponse törzsét streamként kell-e kezelni.

streamResponseBody?: boolean

Tulajdonság értéke

boolean

streamResponseStatusCodes

Azoknak az állapotkódoknak a listája, amelyek megfelelő HttpOperationResponse törzsét streamként kell kezelni.

streamResponseStatusCodes?: Set<number>

Tulajdonság értéke

Set<number>

timeout

Mennyi ideig kell ezredmásodpercben várni a kérés megszakítása előtt.

timeout: number

Tulajdonság értéke

number

tracingContext

Nyomkövetés: A Spans létrehozásakor használt környezet.

tracingContext?: Context

Tulajdonság értéke

@azure/core-tracing.Context

url

A kimenő kérés URL-címe.

url: string

Tulajdonság értéke

string

withCredentials

Hitelesítő adatok küldése (cookie-k, engedélyezési fejlécek vagy TLS-ügyféltanúsítványok használatával), amikor kérést küld a böngészőben egy helyek közötti célhelyre.

withCredentials: boolean

Tulajdonság értéke

boolean

Metódus adatai

clone()

Klónozza ezt a WebResource HTTP-kérelemobjektumot.

function clone(): WebResource

Válaszok

WebResource

A WebResource HTTP-kérelemobjektum klónja.

prepare(RequestPrepareOptions)

Előkészíti a kérést.

function prepare(options: RequestPrepareOptions): WebResource

Paraméterek

options

RequestPrepareOptions

A kérés előkészítésének lehetőségei.

Válaszok

WebResource

Az előkészített WebResource (HTTP-kérés) objektumot adja vissza, amelyet meg kell adni a kérelemfolyamatnak.

validateRequestProperties()

Ellenőrzi, hogy a szükséges tulajdonságok, például a metódus, az URL-cím, a fejlécek["Content-Type"], a fejlécek["accept-language"] definiálva vannak-e. Hiba jelenik meg, ha a fent említett tulajdonságok egyike nincs meghatározva.

function validateRequestProperties()