WebResourceLike interface

Csomag:

@azure/core-http

A távoli kiszolgálóra irányuló HTTP-kérés leírása.

Tulajdonságok

abortSignal	Megszakító vezérlő jele. 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	A kérelem HTTP-törzsének tartalma.
decompressResponse	A válasz kibontása Accept-Encoding fejléc szerint (csak csomópont-lekérés)
formData	Űrlapadatok, amelyeket a kérelem törzsének létrehozásához használunk.
headers	A kéréshez használandó HTTP-fejlécek.
keepAlive	Ha a kapcsolatot újra fel kell használni.
method	A kérés során használandó HTTP-módszer.
onDownloadProgress	Visszahívás, amely a letöltési folyamat után aktiválódik.
onUploadProgress	Visszahívás, amely a feltöltési folyamat utá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 nem definiált, akkor egy egyszerű állapotkód-keresés lesz használva.
operationSpec	A válasz elemzésére szolgál.
proxySettings	Proxykonfiguráció.
query	Objektumként megadott lekérdezési sztring.
requestId	A kérés egyedi azonosítója. Naplózáshoz és nyomkövetéshez használható.
shouldDeserialize	Azt jelzi, hogy a HttpOperationResponse deszerializálva legyen-e. Ha ez nincs meghatározva, akkor a HttpOperationResponse deszerializálva kell lennie.
streamResponseBody	Azt, hogy a HttpOperationResponse törzsét streamként kell-e kezelni.
streamResponseStatusCodes	Azon válaszállapot-kódok listája, amelyek megfelelő HttpOperationResponse törzsét streamként kell kezelni.
timeout	A kérések automatikus leállása előtt eltartható ezredmásodpercek száma. Ha a kérés le van állítva, AbortError egy lesz dobva.
tracingContext	Nyomkövetés: A spanok létrehozásakor használt környezet.
url	A kérés által elért URL-cím.
withCredentials	Ha a hitelesítő adatokat (cookie-kat) az XHR során kell elküldeni.

Metódusok

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

Tulajdonság adatai

abortSignal

Megszakító vezérlő jele. 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

A kérelem HTTP-törzsének tartalma.

body?: any

Tulajdonság értéke

any

decompressResponse

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

decompressResponse?: boolean

Tulajdonság értéke

boolean

formData

Űrlapadatok, amelyeket a kérelem törzsének létrehozásához használunk.

formData?: any

Tulajdonság értéke

any

headers

A kéréshez használandó HTTP-fejlécek.

headers: HttpHeadersLike

Tulajdonság értéke

HttpHeadersLike

keepAlive

Ha a kapcsolatot újra fel kell használni.

keepAlive?: boolean

Tulajdonság értéke

boolean

method

A kérés során használandó HTTP-módszer.

method: HttpMethods

Tulajdonság értéke

HttpMethods

onDownloadProgress

Visszahívás, amely a letöltési folyamat utá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 utá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 nem definiált, 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 válasz elemzésére szolgál.

operationSpec?: OperationSpec

Tulajdonság értéke

OperationSpec

proxySettings

Proxykonfiguráció.

proxySettings?: ProxySettings

Tulajdonság értéke

ProxySettings

query

Objektumként megadott lekérdezési sztring.

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

Tulajdonság értéke

{[key: string]: any}

requestId

A kérés egyedi azonosítója. Naplózáshoz és nyomkövetéshez használható.

requestId: string

Tulajdonság értéke

string

shouldDeserialize

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

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

Tulajdonság értéke

boolean | (response: HttpOperationResponse) => boolean

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

Azon válaszállapot-kódok listája, amelyek megfelelő HttpOperationResponse törzsét streamként kell kezelni.

streamResponseStatusCodes?: Set<number>

Tulajdonság értéke

Set<number>

timeout

A kérések automatikus leállása előtt eltartható ezredmásodpercek száma. Ha a kérés le van állítva, AbortError egy lesz dobva.

timeout: number

Tulajdonság értéke

number

tracingContext

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

tracingContext?: Context

Tulajdonság értéke

@azure/core-tracing.Context

url

A kérés által elért URL-cím.

url: string

Tulajdonság értéke

string

withCredentials

Ha a hitelesítő adatokat (cookie-kat) az XHR során kell elküldeni.

withCredentials: boolean

Tulajdonság értéke

boolean

Metódus adatai

clone()

Klónozza ezt a kérelemobjektumot.

function clone(): WebResourceLike

Válaszok

WebResourceLike

prepare(RequestPrepareOptions)

A kérés beállításainak megadása.

function prepare(options: RequestPrepareOptions): WebResourceLike

Paraméterek

options

RequestPrepareOptions

Válaszok

WebResourceLike

validateRequestProperties()

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

function validateRequestProperties()