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ő 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	A kérelem HTTP-törzsének tartalma.
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	A kérés során használandó HTTP-fejlécek.
keepAlive	Ha a kapcsolatot újra fel kell használni.
method	A kérés végrehajtásakor 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 válasz elemzésére szolgál.
proxySettings	Proxykonfiguráció.
query	Objektumként ábrázolt lekérdezési sztring.
requestId	A kérés egyedi azonosítója. Naplózáshoz és nyomkövetéshez használatos.
shouldDeserialize	Azt, hogy a HttpOperationResponse deszerializálva legyen-e. Ha ez nincs meghatározva, akkor a HttpOperationResponse-t deszerializálni kell.
streamResponseBody	Azt, hogy a HttpOperationResponse törzsét streamként kell-e kezelni.
streamResponseStatusCodes	Azoknak a válaszállapot-kódoknak a listája, amelyek megfelelő HttpOperationResponse törzsét streamként kell kezelni.
timeout	A kérelmek automatikus leállása előtt eltartható ezredmásodperc. Ha a kérelem le van állítva, a AbortError adódik.
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érésobjektumot.
prepare(RequestPrepareOptions)	Beállítja a kérés beállításait.
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.

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

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

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

A kérés során 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 végrehajtásakor 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 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 ábrázolt 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álatos.

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

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 a válaszállapot-kódoknak a listája, amelyek megfelelő HttpOperationResponse törzsét streamként kell kezelni.

streamResponseStatusCodes?: Set<number>

Tulajdonság értéke

Set<number>

timeout

A kérelmek automatikus leállása előtt eltartható ezredmásodperc. Ha a kérelem le van állítva, a AbortError adódik.

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érésobjektumot.

function clone(): WebResourceLike

Válaszok

WebResourceLike

prepare(RequestPrepareOptions)

Beállítja a kérés beállításait.

function prepare(options: RequestPrepareOptions): WebResourceLike

Paraméterek

options

RequestPrepareOptions

Válaszok

WebResourceLike

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