WebResourceLike interface

Pakiet:

@azure/core-http

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ź.
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.
operationResponseGetter	Funkcja zwracająca odpowiednią kombinację OperationResponse dla danej kombinacji OperationSpec i HttpOperationResponse. Jeśli jest to niezdefiniowane, zostanie użyte proste wyszukiwanie kodu stanu.
operationSpec	Służy do analizowania odpowiedzi.
proxySettings	Konfiguracja serwera proxy.
query	Ciąg zapytania reprezentowany jako obiekt.
requestId	Unikatowy identyfikator żądania. Służy do rejestrowania i śledzenia.
shouldDeserialize	Określa, czy element HttpOperationResponse powinien być deserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno zostać zdeserializowane.
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.
tracingContext	Śledzenie: kontekst używany podczas tworzenia zakresów.
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(RequestPrepareOptions)	Ustawia opcje żądania.
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.

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

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

HttpHeadersLike

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

operationResponseGetter

Funkcja zwracająca odpowiednią kombinację OperationResponse dla danej kombinacji OperationSpec i HttpOperationResponse. Jeśli jest to niezdefiniowane, zostanie użyte proste wyszukiwanie kodu stanu.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

Wartość właściwości

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Służy do analizowania odpowiedzi.

operationSpec?: OperationSpec

Wartość właściwości

OperationSpec

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

shouldDeserialize

Określa, czy element HttpOperationResponse powinien być deserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno zostać zdeserializowane.

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

Wartość właściwości

boolean | (response: HttpOperationResponse) => boolean

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

tracingContext

Śledzenie: kontekst używany podczas tworzenia zakresów.

tracingContext?: Context

Wartość właściwości

@azure/core-tracing.Context

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

WebResourceLike

prepare(RequestPrepareOptions)

Ustawia opcje żądania.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametry

options

RequestPrepareOptions

Zwraca

WebResourceLike

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.

function validateRequestProperties()