PipelineRequest interface

Package:

@azure/core-rest-pipeline

Metadata about a request being made by the pipeline.

Properties

abortSignal	Used to abort the request later.
agent	NODEJS ONLY A Node-only option to provide a custom http.Agent/https.Agent. Does nothing when running in the browser.
allowInsecureConnection	Set to true if the request is sent over HTTP instead of HTTPS
body	The HTTP body content (if any)
disableKeepAlive	If the connection should not be reused.
enableBrowserStreams	BROWSER ONLY A browser only option to enable browser Streams. If this option is set and a response is a stream the response will have a property browserStream instead of blobBody which will be undefined. Default value is false
formData	To simulate a browser form post
headers	The HTTP headers to use when making the request.
method	The HTTP method to use when making the request.
multipartBody	Body for a multipart request.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
proxySettings	Proxy configuration.
requestId	A unique identifier for the request. Used for logging and tracing.
streamResponseStatusCodes	A list of response status codes whose corresponding PipelineResponse body should be treated as a stream. When streamResponseStatusCodes contains the value Number.POSITIVE_INFINITY any status would be treated as a stream.
timeout	The number of milliseconds a request can take before automatically being terminated. If the request is terminated, an AbortError is thrown. Defaults to 0, which disables the timeout.
tlsSettings	Settings for configuring TLS authentication
tracingOptions	Tracing options to use for any created Spans.
url	The URL to make the request to.
withCredentials	Indicates whether the user agent should send cookies from the other domain in the case of cross-origin requests. Defaults to false.

Property Details

abortSignal

Used to abort the request later.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

agent

NODEJS ONLY

A Node-only option to provide a custom http.Agent/https.Agent. Does nothing when running in the browser.

agent?: Agent

Property Value

Agent

allowInsecureConnection

Set to true if the request is sent over HTTP instead of HTTPS

allowInsecureConnection?: boolean

Property Value

boolean

body

The HTTP body content (if any)

body?: RequestBodyType

Property Value

RequestBodyType

disableKeepAlive

If the connection should not be reused.

disableKeepAlive?: boolean

Property Value

boolean

enableBrowserStreams

BROWSER ONLY

A browser only option to enable browser Streams. If this option is set and a response is a stream the response will have a property browserStream instead of blobBody which will be undefined.

Default value is false

enableBrowserStreams?: boolean

Property Value

boolean

formData

To simulate a browser form post

formData?: FormDataMap

Property Value

FormDataMap

headers

The HTTP headers to use when making the request.

headers: HttpHeaders

Property Value

HttpHeaders

method

The HTTP method to use when making the request.

method: HttpMethods

Property Value

HttpMethods

multipartBody

Body for a multipart request.

multipartBody?: MultipartRequestBody

Property Value

MultipartRequestBody

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

proxySettings

Proxy configuration.

proxySettings?: ProxySettings

Property Value

ProxySettings

requestId

A unique identifier for the request. Used for logging and tracing.

requestId: string

Property Value

string

streamResponseStatusCodes

A list of response status codes whose corresponding PipelineResponse body should be treated as a stream. When streamResponseStatusCodes contains the value Number.POSITIVE_INFINITY any status would be treated as a stream.

streamResponseStatusCodes?: Set<number>

Property Value

Set<number>

timeout

The number of milliseconds a request can take before automatically being terminated. If the request is terminated, an AbortError is thrown. Defaults to 0, which disables the timeout.

timeout: number

Property Value

number

tlsSettings

Settings for configuring TLS authentication

tlsSettings?: TlsSettings

Property Value

TlsSettings

tracingOptions

Tracing options to use for any created Spans.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

url

The URL to make the request to.

url: string

Property Value

string

withCredentials

Indicates whether the user agent should send cookies from the other domain in the case of cross-origin requests. Defaults to false.

withCredentials: boolean

Property Value

boolean