Share via

PipelineRequest interface

  • Ссылка
Пакет:
@azure/core-rest-pipeline

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

Свойства

abortSignal

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

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

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

Содержимое текста HTTP (при наличии)
disableKeepAlive

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

ТОЛЬКО БРАУЗЕР. Параметр только для браузера для включения потоков браузера. Если этот параметр задан и ответ является потоком, то ответ будет иметь свойство browserStream , а не blobBody значение которого будет неопределенным.

Значение по умолчанию — false.
formData

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

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

Метод HTTP, используемый при выполнении запроса.
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 ONLY Параметр только для узла для предоставления пользовательского 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

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