PipelineRequest interface

Пакет:

@azure/core-rest-pipeline

Метаданные о запросе, выполняемом конвейером.

Свойства

abortSignal	Используется для прерывания запроса позже.
agent	ТОЛЬКО NODEJS Параметр только для узла для предоставления пользовательской http.Agent/https.Agent. Ничего не делает при выполнении в браузере.
allowInsecureConnection	Задайте значение true, если запрос отправляется по протоколу HTTP вместо HTTPS
body	Содержимое текста HTTP (если таковые есть)
disableKeepAlive	Если подключение не должно использоваться повторно.
enableBrowserStreams	ТОЛЬКО БРАУЗЕР В браузере можно включить только потоки браузера. Если этот параметр задан и ответ является потоком, ответ будет иметь свойство browserStream вместо blobBody, которые будут неопределенными. Значение по умолчанию равно false
formData	Имитация записи формы браузера
headers	Заголовки HTTP, используемые при выполнении запроса.
method	Метод HTTP, используемый при выполнении запроса.
multipartBody	Текст многопартийного запроса.
onDownloadProgress	Обратный вызов, который запускается при выполнении скачивания.
onUploadProgress	Обратный вызов, который запускается при выполнении отправки.
proxySettings	Конфигурация прокси-сервера.
requestId	Уникальный идентификатор запроса. Используется для ведения журнала и трассировки.
streamResponseStatusCodes	Список кодов состояния ответа, соответствующий текст PipelineResponse, должен рассматриваться как поток. Если streamResponseStatusCodes содержит значение, Number.POSITIVE_INFINITY любое состояние будет рассматриваться как поток.
timeout	Число миллисекундах запроса может приниматься перед автоматическим завершением. Если запрос завершается, создается AbortError. Значение по умолчанию — 0, которое отключает время ожидания.
tlsSettings	Параметры настройки проверки подлинности TLS
tracingOptions	Параметры трассировки для любых созданных диапазонов.
url	URL-адрес для выполнения запроса.
withCredentials	Указывает, должен ли агент пользователя отправлять файлы cookie из другого домена в случае запросов между источниками. По умолчанию используется значение false.

Сведения о свойстве

abortSignal

Используется для прерывания запроса позже.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

agent

ТОЛЬКО NODEJS

Параметр только для узла для предоставления пользовательской http.Agent/https.Agent. Ничего не делает при выполнении в браузере.

agent?: Agent

Значение свойства

Agent

allowInsecureConnection

Задайте значение true, если запрос отправляется по протоколу HTTP вместо HTTPS

allowInsecureConnection?: boolean

Значение свойства

boolean

body

Содержимое текста HTTP (если таковые есть)

body?: RequestBodyType

Значение свойства

RequestBodyType

disableKeepAlive

Если подключение не должно использоваться повторно.

disableKeepAlive?: boolean

Значение свойства

boolean

enableBrowserStreams

ТОЛЬКО БРАУЗЕР

В браузере можно включить только потоки браузера. Если этот параметр задан и ответ является потоком, ответ будет иметь свойство browserStream вместо blobBody, которые будут неопределенными.

Значение по умолчанию равно false

enableBrowserStreams?: boolean

Значение свойства

boolean

formData

Имитация записи формы браузера

formData?: FormDataMap

Значение свойства

FormDataMap

headers

Заголовки HTTP, используемые при выполнении запроса.

headers: HttpHeaders

Значение свойства

HttpHeaders

method

Метод HTTP, используемый при выполнении запроса.

method: HttpMethods

Значение свойства

HttpMethods

multipartBody

Текст многопартийного запроса.

multipartBody?: MultipartRequestBody

Значение свойства

MultipartRequestBody

onDownloadProgress

Обратный вызов, который запускается при выполнении скачивания.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

onUploadProgress

Обратный вызов, который запускается при выполнении отправки.

onUploadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

proxySettings

Конфигурация прокси-сервера.

proxySettings?: ProxySettings

Значение свойства

ProxySettings

requestId

Уникальный идентификатор запроса. Используется для ведения журнала и трассировки.

requestId: string

Значение свойства

string

streamResponseStatusCodes

Список кодов состояния ответа, соответствующий текст PipelineResponse, должен рассматриваться как поток. Если streamResponseStatusCodes содержит значение, Number.POSITIVE_INFINITY любое состояние будет рассматриваться как поток.

streamResponseStatusCodes?: Set<number>

Значение свойства

Set<number>

timeout

Число миллисекундах запроса может приниматься перед автоматическим завершением. Если запрос завершается, создается AbortError. Значение по умолчанию — 0, которое отключает время ожидания.

timeout: number

Значение свойства

number

tlsSettings

Параметры настройки проверки подлинности TLS

tlsSettings?: TlsSettings

Значение свойства

TlsSettings

tracingOptions

Параметры трассировки для любых созданных диапазонов.

tracingOptions?: OperationTracingOptions

Значение свойства

OperationTracingOptions

url

URL-адрес для выполнения запроса.

url: string

Значение свойства

string

withCredentials

Указывает, должен ли агент пользователя отправлять файлы cookie из другого домена в случае запросов между источниками. По умолчанию используется значение false.

withCredentials: boolean

Значение свойства

boolean