PipelineRequest interface

Pakiet:

@azure/core-rest-pipeline

Metadane dotyczące żądania wykonywanego przez potok.

Właściwości

abortSignal	Służy do przerwania żądania później.
agent	TYLKO NODEJS Opcja tylko dla węzła umożliwiająca podanie niestandardowego http.Agent/https.Agent. Nie działa w przeglądarce.
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 przeglądarki tylko w celu włączenia strumieni przeglądarki. Jeśli ta opcja jest ustawiona, a odpowiedź jest strumieniem, odpowiedź będzie mieć właściwość browserStream zamiast blobBody, która będzie 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 wykonywania żądania.
multipartBody	Treść żądania wieloczęściowego.
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ń. Gdy element streamResponseStatusCodes zawiera wartość Number.POSITIVE_INFINITY każdy stan będzie traktowany 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. Wartość domyślna to 0, co powoduje wyłączenie limitu czasu.
tlsSettings	Ustawienia konfigurowania uwierzytelniania TLS
tracingOptions	Opcje śledzenia do użycia dla dowolnych utworzonych spans.
url	Adres URL, do którego ma być skierowane żądanie.
withCredentials	Wskazuje, czy agent użytkownika powinien wysyłać pliki cookie z innej domeny w przypadku żądań między źródłami. Wartość domyślna to false.

Szczegóły właściwości

abortSignal

Służy do przerwania żądania później.

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. Nie działa w przeglądarce.

agent?: Agent

Wartość właściwości

Agent

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 przeglądarki tylko w celu włączenia strumieni przeglądarki. Jeśli ta opcja jest ustawiona, a odpowiedź jest strumieniem, odpowiedź będzie mieć właściwość browserStream zamiast blobBody, która będzie 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 wykonywania żądania.

method: HttpMethods

Wartość właściwości

HttpMethods

multipartBody

Treść żądania wieloczęściowego.

multipartBody?: MultipartRequestBody

Wartość właściwości

MultipartRequestBody

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ń. Gdy element streamResponseStatusCodes zawiera wartość Number.POSITIVE_INFINITY każdy stan będzie traktowany 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. Wartość domyślna to 0, co powoduje wyłączenie limitu czasu.

timeout: number

Wartość właściwości

number

tlsSettings

Ustawienia konfigurowania uwierzytelniania TLS

tlsSettings?: TlsSettings

Wartość właściwości

TlsSettings

tracingOptions

Opcje śledzenia do użycia dla dowolnych utworzonych spans.

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

Wskazuje, czy agent użytkownika powinien wysyłać pliki cookie z innej domeny w przypadku żądań między źródłami. Wartość domyślna to false.

withCredentials: boolean

Wartość właściwości

boolean