WebResource interface

Csomag:

@azure/storage-file-share

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ó.
agent	CSAK NODEJS Csak csomópontos beállítás egyéni http.Agent/https.Agent. MEGJEGYZÉS: ez általában egy példány, amelyet több kérés oszt meg, hogy a szolgáltatáshoz kapcsolódó mögöttes kapcsolat újra felhasználható legyen. Nem tesz semmit a böngészőben való futtatáskor.
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.
proxySettings	Proxy konfigurációja.
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.
requestOverrides	A kéréshez beállítható további beállítások. Ez lehetővé teszi a meglévők felülbírálását, vagy a nem deklarált kérelemtulajdonságok biztosítását. A lehetséges érvényes tulajdonságokért lásd: NodeJS https.request beállításai: https://nodejs.org/api/http.html#httprequestoptions-callback Böngésző RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit FIGYELEM: Az itt megadott beállítások felülírják az azonos nevű tulajdonságokat, ha a kérést a <xref:HttpClient>.
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.
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(unknown)	Ez egy no-op honfitársi célokra, és dob, ha hívják.
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. Megjegyzés: ez egy no-op honfitársi célokra.

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

agent

CSAK NODEJS

Csak csomópontos beállítás egyéni http.Agent/https.Agent. MEGJEGYZÉS: ez általában egy példány, amelyet több kérés oszt meg, hogy a szolgáltatáshoz kapcsolódó mögöttes kapcsolat újra felhasználható legyen. Nem tesz semmit a böngészőben való futtatáskor.

agent?: Agent

Tulajdonság értéke

Agent

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

HttpHeaders

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

proxySettings

Proxy konfigurációja.

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

requestOverrides

A kéréshez beállítható további beállítások. Ez lehetővé teszi a meglévők felülbírálását, vagy a nem deklarált kérelemtulajdonságok biztosítását.

A lehetséges érvényes tulajdonságokért lásd:

• NodeJS https.request beállításai: https://nodejs.org/api/http.html#httprequestoptions-callback
• Böngésző RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

FIGYELEM: Az itt megadott beállítások felülírják az azonos nevű tulajdonságokat, ha a kérést a <xref:HttpClient>.

requestOverrides?: Record<string, unknown>

Tulajdonság értéke

Record<string, unknown>

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

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

WebResource

prepare(unknown)

Ez egy no-op honfitársi célokra, és dob, ha hívják.

function prepare(options: unknown): WebResourceLike

Paraméterek

options

unknown

Válaszok

WebResource

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. Megjegyzés: ez egy no-op honfitársi célokra.

function validateRequestProperties()