Udostępnij za pośrednictwem

WebResource class

  • Odwołanie
Pakiet:
@azure/core-http

Tworzy nowy obiekt WebResource.

Ta klasa zapewnia abstrakcję wywołania REST przez bycie biblioteką / implementacją niezależną od implementacji i opakowywanie niezbędnych właściwości do zainicjowania żądania.

Konstruktory

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

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

Treść żą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.
keepAlive

Określa, czy połączenia HTTP są aktywne w żądaniach.
method

Metoda HTTP do użycia.
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

Specyfikacja żądania HTTP.
proxySettings

Jakiego serwera proxy należy używać, jeśli to konieczne.
query

Zapytanie dodane do adresu URL.
requestId

Unikatowy identyfikator żądania wychodzącego.
shouldDeserialize

Niezależnie od tego, czy element HttpOperationResponse powinien zostać zdeserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno zostać zdeserializowane.
spanOptions

Śledzenie: opcje używane do tworzenia zakresu po włączeniu śledzenia.
streamResponseBody

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

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

Czas oczekiwania w milisekundach przed przerwaniem żądania.
tracingContext

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

Adres URL żądania wychodzącego.
withCredentials

Czy wysyłać poświadczenia (za pośrednictwem plików cookie, nagłówków autoryzacji lub certyfikatów klienta TLS) podczas wysyłania żądania w przeglądarce do lokalizacji docelowej obejmującej wiele lokacji.

Metody

clone()

Sklonuj ten obiekt żądania HTTP WebResource.
prepare(RequestPrepareOptions)

Przygotowuje żądanie.
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.

Szczegóły konstruktora

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>) 

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

Parametry

url

string

method
HttpMethods
body

unknown

query

{[key: string]: any}

headers

{[key: string]: any} | HttpHeadersLike

streamResponseBody

boolean

withCredentials

boolean

abortSignal
AbortSignalLike
timeout

number

onUploadProgress

(progress: TransferProgressEvent) => void

onDownloadProgress

(progress: TransferProgressEvent) => void

proxySettings
ProxySettings
keepAlive

boolean

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

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

Treść żą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.

headers: HttpHeadersLike

Wartość właściwości

HttpHeadersLike

keepAlive

Określa, czy połączenia HTTP są aktywne w żądaniach.

keepAlive?: boolean

Wartość właściwości

boolean

method

Metoda HTTP do użycia.

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

Specyfikacja żądania HTTP.

operationSpec?: OperationSpec

Wartość właściwości

OperationSpec

proxySettings

Jakiego serwera proxy należy używać, jeśli to konieczne.

proxySettings?: ProxySettings

Wartość właściwości

ProxySettings

query

Zapytanie dodane do adresu URL.

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

Wartość właściwości

{[key: string]: any}

requestId

Unikatowy identyfikator żądania wychodzącego.

requestId: string

Wartość właściwości

string

shouldDeserialize

Niezależnie od tego, czy element HttpOperationResponse powinien zostać zdeserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno zostać zdeserializowane.

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

Wartość właściwości

boolean | (response: HttpOperationResponse) => boolean

spanOptions

Śledzenie: opcje używane do tworzenia zakresu po włączeniu śledzenia.

spanOptions?: SpanOptions

Wartość właściwości

@azure/core-tracing.SpanOptions

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, których odpowiednia treść HttpOperationResponse powinna być traktowana jako strumień.

streamResponseStatusCodes?: Set<number>

Wartość właściwości

Set<number>

timeout

Czas oczekiwania w milisekundach przed przerwaniem żądania.

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 żądania wychodzącego.

url: string

Wartość właściwości

string

withCredentials

Czy wysyłać poświadczenia (za pośrednictwem plików cookie, nagłówków autoryzacji lub certyfikatów klienta TLS) podczas wysyłania żądania w przeglądarce do lokalizacji docelowej obejmującej wiele lokacji.

withCredentials: boolean

Wartość właściwości

boolean

Szczegóły metody

clone()

Sklonuj ten obiekt żądania HTTP WebResource.

function clone(): WebResource

Zwraca

WebResource

Klon tego obiektu żądania HTTP WebResource.

prepare(RequestPrepareOptions)

Przygotowuje żądanie.

function prepare(options: RequestPrepareOptions): WebResource

Parametry

options
RequestPrepareOptions

Opcje, które należy udostępnić do przygotowania żądania.

Zwraca

WebResource

Zwraca przygotowany obiekt WebResource (żądanie HTTP), który musi zostać przekazany potokowi żądania.

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.

function validateRequestProperties()