Udostępnij za pośrednictwem

WebResource interface

  • Odwołanie
Pakiet:
@azure/storage-blob

Opis żądania HTTP, który ma zostać złożony na serwerze zdalnym.

Właściwości

abortSignal

Sygnał przerwania kontrolera. Może służyć do przerwania zarówno wysyłania żądania sieciowego, jak i oczekiwania na odpowiedź.
body

Zawartość treści HTTP żądania.
decompressResponse

Czy dekompresować odpowiedź zgodnie z nagłówka Accept-Encoding (tylko pobieranie węzła)
formData

Dane formularza używane do tworzenia treści żądania.
headers

Nagłówki HTTP do użycia podczas tworzenia żądania.
keepAlive

Jeśli połączenie powinno zostać ponownie użyte.
method

Metoda HTTP, która ma być używana podczas tworzenia żądania.
onDownloadProgress

Wywołanie zwrotne uruchamiane po postępie pobierania.
onUploadProgress

Wywołanie zwrotne uruchamiane po postępie przekazywania.
proxySettings

Konfiguracja serwera proxy.
query

Ciąg zapytania reprezentowany jako obiekt.
requestId

Unikatowy identyfikator żądania. Służy do rejestrowania i śledzenia.
streamResponseBody

Określa, czy treść elementu HttpOperationResponse powinna być traktowana jako strumień.
streamResponseStatusCodes

Lista kodów stanu odpowiedzi, których odpowiednia treść HttpOperationResponse powinna być traktowana jako strumień.
timeout

Liczba milisekund, które żądanie może potrwać przed automatycznym zakończeniem. Jeśli żądanie zostanie zakończone, AbortError zostanie zgłoszony element .
url

Adres URL, do którego uzyskuje się dostęp przez żądanie.
withCredentials

Jeśli poświadczenia (pliki cookie) powinny być wysyłane podczas XHR.

Metody

clone()

Sklonuj ten obiekt żądania.
prepare(unknown)

Jest to operacja no-op do celów zgodności i zgłosi, jeśli zostanie wywołana.
validateRequestProperties()

Sprawdza, czy są zdefiniowane wymagane właściwości, takie jak metoda, adres URL, nagłówki["Content-Type"], nagłówki["accept-language"]. Jeśli jedna z powyższych właściwości nie zostanie zdefiniowana, zostanie zgłoszony błąd. Uwaga: jest to operacja no-op do celów związanych z zgodnością.

Szczegóły właściwości

abortSignal

Sygnał przerwania kontrolera. Może służyć do przerwania zarówno wysyłania żądania sieciowego, jak i oczekiwania na odpowiedź.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

body

Zawartość treści HTTP żądania.

body?: any

Wartość właściwości

any

decompressResponse

Czy dekompresować odpowiedź zgodnie z nagłówka Accept-Encoding (tylko pobieranie węzła)

decompressResponse?: boolean

Wartość właściwości

boolean

formData

Dane formularza używane do tworzenia treści żądania.

formData?: any

Wartość właściwości

any

headers

Nagłówki HTTP do użycia podczas tworzenia żądania.

headers: HttpHeadersLike

Wartość właściwości

HttpHeaders

keepAlive

Jeśli połączenie powinno zostać ponownie użyte.

keepAlive?: boolean

Wartość właściwości

boolean

method

Metoda HTTP, która ma być używana podczas tworzenia żądania.

method: HttpMethods

Wartość właściwości

HttpMethods

onDownloadProgress

Wywołanie zwrotne uruchamiane po postępie pobierania.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

onUploadProgress

Wywołanie zwrotne uruchamiane po postępie przekazywania.

onUploadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

proxySettings

Konfiguracja serwera proxy.

proxySettings?: ProxySettings

Wartość właściwości

ProxySettings

query

Ciąg zapytania reprezentowany jako obiekt.

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

Wartość właściwości

{[key: string]: any}

requestId

Unikatowy identyfikator żądania. Służy do rejestrowania i śledzenia.

requestId: string

Wartość właściwości

string

streamResponseBody

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use streamResponseStatusCodes property instead.

Określa, czy treść elementu HttpOperationResponse powinna być traktowana jako strumień.

streamResponseBody?: boolean

Wartość właściwości

boolean

streamResponseStatusCodes

Lista kodów stanu odpowiedzi, których odpowiednia treść HttpOperationResponse powinna być traktowana jako strumień.

streamResponseStatusCodes?: Set<number>

Wartość właściwości

Set<number>

timeout

Liczba milisekund, które żądanie może potrwać przed automatycznym zakończeniem. Jeśli żądanie zostanie zakończone, AbortError zostanie zgłoszony element .

timeout: number

Wartość właściwości

number

url

Adres URL, do którego uzyskuje się dostęp przez żądanie.

url: string

Wartość właściwości

string

withCredentials

Jeśli poświadczenia (pliki cookie) powinny być wysyłane podczas XHR.

withCredentials: boolean

Wartość właściwości

boolean

Szczegóły metody

clone()

Sklonuj ten obiekt żądania.

function clone(): WebResourceLike

Zwraca

WebResource

prepare(unknown)

Jest to operacja no-op do celów zgodności i zgłosi, jeśli zostanie wywołana.

function prepare(options: unknown): WebResourceLike

Parametry

options

unknown

Zwraca

WebResource

validateRequestProperties()

Sprawdza, czy są zdefiniowane wymagane właściwości, takie jak metoda, adres URL, nagłówki["Content-Type"], nagłówki["accept-language"]. Jeśli jedna z powyższych właściwości nie zostanie zdefiniowana, zostanie zgłoszony błąd. Uwaga: jest to operacja no-op do celów związanych z zgodnością.

function validateRequestProperties()