PipelineRequestOptions interface
Settings to initialize a request. Almost equivalent to Partial, but url is mandatory.
Properties
| abort |
Used to abort the request later. |
| allow |
Set to true if the request is sent over HTTP instead of HTTPS |
| body | The HTTP body content (if any) |
| disable |
If the connection should not be reused. |
| enable |
BROWSER ONLY A browser only option to enable use of the Streams API. If this option is set and streaming is used
(see Default value is false |
| form |
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. |
| multipart |
Body for a multipart request. |
| on |
Callback which fires upon download progress. |
| on |
Callback which fires upon upload progress. |
| proxy |
Proxy configuration. |
| request |
A unique identifier for the request. Used for logging and tracing. |
| stream |
A list of response status codes whose corresponding PipelineResponse body should be treated as a stream. |
| timeout | The number of milliseconds a request can take before automatically being terminated.
If the request is terminated, an |
| tracing |
Options used to create a span when tracing is enabled. |
| url | The URL to make the request to. |
| with |
If credentials (cookies) should be sent along during an XHR. Defaults to false. |
Property Details
abortSignal
allowInsecureConnection
Set to true if the request is sent over HTTP instead of HTTPS
allowInsecureConnection?: booleanProperty Value
boolean
body
disableKeepAlive
If the connection should not be reused.
disableKeepAlive?: booleanProperty Value
boolean
enableBrowserStreams
BROWSER ONLY
A browser only option to enable use of the Streams API. If this option is set and streaming is used
(see streamResponseStatusCodes), the response will have a property browserStream instead of
blobBody which will be undefined.
Default value is false
enableBrowserStreams?: booleanProperty Value
boolean
formData
headers
method
multipartBody
Body for a multipart request.
multipartBody?: MultipartRequestBodyProperty Value
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: (progress: TransferProgressEvent) => voidProperty Value
(progress: TransferProgressEvent) => void
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: (progress: TransferProgressEvent) => voidProperty Value
(progress: TransferProgressEvent) => void
proxySettings
requestId
A unique identifier for the request. Used for logging and tracing.
requestId?: stringProperty Value
string
streamResponseStatusCodes
A list of response status codes whose corresponding PipelineResponse body should 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?: numberProperty Value
number
tracingOptions
Options used to create a span when tracing is enabled.
tracingOptions?: OperationTracingOptionsProperty Value
url
The URL to make the request to.
url: stringProperty Value
string
withCredentials
If credentials (cookies) should be sent along during an XHR. Defaults to false.
withCredentials?: booleanProperty Value
boolean