WebResource interface

Pakiet:

@azure/storage-blob

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

Właściwości

abortSignal	Sygnał kontrolera przerwania. Może służyć do przerwania zarówno wysyłania żądania sieciowego, jak i oczekiwania na odpowiedź.
agent	TYLKO NODEJS Opcja tylko dla węzła umożliwiająca podanie niestandardowego http.Agent/https.Agent. UWAGA: zazwyczaj powinno to być jedno wystąpienie współużytkowane przez wiele żądań, aby można było ponownie użyć bazowego połączenia z usługą. Nie działa w przeglądarce.
body	Zawartość treści http żądania.
decompressResponse	Czy dekompresować odpowiedź zgodnie z nagłówka Accept-Encoding (tylko node-fetch)
formData	Dane formularza używane do kompilowania 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 wykonywania żą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.
requestOverrides	Dodatkowe opcje do ustawienia na żądanie. Umożliwia to zastąpienie istniejących lub podanie właściwości żądania, które nie są zadeklarowane. Aby uzyskać informacje o możliwych prawidłowych właściwościach, zobacz Opcje https.request NodeJS: https://nodejs.org/api/http.html#httprequestoptions-callback Przeglądarka RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit UWAGA: Opcje określone w tym miejscu zastąpią wszystkie właściwości o tych samych nazwach, gdy żądanie zostanie wysłane przez <xref:HttpClient>.
streamResponseBody	Określa, czy treść obiektu 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 może przyjąć żądanie przed automatycznym zakończeniem. Jeśli żądanie zostanie zakończone, zostanie zgłoszony AbortError.
url	Adres URL uzyskiwany 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 no-op w celach zgodności i zostanie zgłoszony w przypadku wywołania.
validateRequestProperties()	Sprawdza, czy zdefiniowane są 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 no-op na potrzeby zgodności.

Szczegóły właściwości

abortSignal

Sygnał kontrolera przerwania. 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

agent

TYLKO NODEJS

Opcja tylko dla węzła umożliwiająca podanie niestandardowego http.Agent/https.Agent. UWAGA: zazwyczaj powinno to być jedno wystąpienie współużytkowane przez wiele żądań, aby można było ponownie użyć bazowego połączenia z usługą. Nie działa w przeglądarce.

agent?: Agent

Wartość właściwości

Agent

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

decompressResponse?: boolean

Wartość właściwości

boolean

formData

Dane formularza używane do kompilowania 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 wykonywania żą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

requestOverrides

Dodatkowe opcje do ustawienia na żądanie. Umożliwia to zastąpienie istniejących lub podanie właściwości żądania, które nie są zadeklarowane.

Aby uzyskać informacje o możliwych prawidłowych właściwościach, zobacz

• Opcje https.request NodeJS: https://nodejs.org/api/http.html#httprequestoptions-callback
• Przeglądarka RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

UWAGA: Opcje określone w tym miejscu zastąpią wszystkie właściwości o tych samych nazwach, gdy żądanie zostanie wysłane przez <xref:HttpClient>.

requestOverrides?: Record<string, unknown>

Wartość właściwości

Record<string, unknown>

streamResponseBody

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use streamResponseStatusCodes property instead.

Określa, czy treść obiektu 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 może przyjąć żądanie przed automatycznym zakończeniem. Jeśli żądanie zostanie zakończone, zostanie zgłoszony AbortError.

timeout: number

Wartość właściwości

number

url

Adres URL uzyskiwany 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 no-op w celach zgodności i zostanie zgłoszony w przypadku wywołania.

function prepare(options: unknown): WebResourceLike

Parametry

options

unknown

Zwraca

WebResource

validateRequestProperties()

Sprawdza, czy zdefiniowane są 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 no-op na potrzeby zgodności.

function validateRequestProperties()