PipelineRequestOptions interface

Pakiet:

@azure/core-rest-pipeline

Ustawienia inicjowania żądania. Prawie równoważne częściowe, ale adres URL jest obowiązkowy.

Właściwości

abortSignal	Użyto do przerwania żądania później.
allowInsecureConnection	Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS
body	Zawartość treści HTTP (jeśli istnieje)
disableKeepAlive	Jeśli połączenie nie powinno być ponownie używane.
enableBrowserStreams	TYLKO PRZEGLĄDARKA Opcja tylko w przeglądarce umożliwiająca korzystanie z interfejsu API strumieni. Jeśli ta opcja jest ustawiona i jest używana funkcja przesyłania strumieniowego (zobacz streamResponseStatusCodes), odpowiedź będzie mieć właściwość browserStream , a nie blobBody będzie ona niezdefiniowana. Wartość domyślna to false
formData	Aby zasymulować wpis w formularzu przeglądarki
headers	Nagłówki HTTP do użycia podczas tworzenia żądania.
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.
requestId	Unikatowy identyfikator żądania. Służy do rejestrowania i śledzenia.
streamResponseStatusCodes	Lista kodów stanu odpowiedzi, których odpowiednia treść PipelineResponse 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 . Wartość domyślna to 0, co powoduje wyłączenie limitu czasu.
tracingOptions	Opcje używane do tworzenia zakresu po włączeniu śledzenia.
url	Adres URL, do którego ma być skierowane żądanie.
withCredentials	Jeśli poświadczenia (pliki cookie) powinny być wysyłane podczas XHR. Wartość domyślna to false.

Szczegóły właściwości

abortSignal

Użyto do przerwania żądania później.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

allowInsecureConnection

Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS

allowInsecureConnection?: boolean

Wartość właściwości

boolean

body

Zawartość treści HTTP (jeśli istnieje)

body?: RequestBodyType

Wartość właściwości

RequestBodyType

disableKeepAlive

Jeśli połączenie nie powinno być ponownie używane.

disableKeepAlive?: boolean

Wartość właściwości

boolean

enableBrowserStreams

TYLKO PRZEGLĄDARKA

Opcja tylko w przeglądarce umożliwiająca korzystanie z interfejsu API strumieni. Jeśli ta opcja jest ustawiona i jest używana funkcja przesyłania strumieniowego (zobacz streamResponseStatusCodes), odpowiedź będzie mieć właściwość browserStream , a nie blobBody będzie ona niezdefiniowana.

Wartość domyślna to false

enableBrowserStreams?: boolean

Wartość właściwości

boolean

formData

Aby zasymulować wpis w formularzu przeglądarki

formData?: FormDataMap

Wartość właściwości

FormDataMap

headers

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

headers?: HttpHeaders

Wartość właściwości

HttpHeaders

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

requestId

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

requestId?: string

Wartość właściwości

string

streamResponseStatusCodes

Lista kodów stanu odpowiedzi, których odpowiednia treść PipelineResponse 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 . Wartość domyślna to 0, co powoduje wyłączenie limitu czasu.

timeout?: number

Wartość właściwości

number

tracingOptions

Opcje używane do tworzenia zakresu po włączeniu śledzenia.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

url

Adres URL, do którego ma być skierowane żądanie.

url: string

Wartość właściwości

string

withCredentials

Jeśli poświadczenia (pliki cookie) powinny być wysyłane podczas XHR. Wartość domyślna to false.

withCredentials?: boolean

Wartość właściwości

boolean