-
Notifications
You must be signed in to change notification settings - Fork 180
/
PipelineRequest.yml
268 lines (258 loc) · 8.44 KB
/
PipelineRequest.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
### YamlMime:TSType
name: PipelineRequest
uid: '@azure/core-rest-pipeline.PipelineRequest'
package: '@azure/core-rest-pipeline'
summary: Metadata about a request being made by the pipeline.
fullName: PipelineRequest
remarks: ''
isDeprecated: false
type: interface
properties:
- name: abortSignal
uid: '@azure/core-rest-pipeline.PipelineRequest.abortSignal'
package: '@azure/core-rest-pipeline'
summary: Used to abort the request later.
fullName: abortSignal
remarks: ''
isDeprecated: false
syntax:
content: 'abortSignal?: AbortSignalLike'
return:
description: ''
type: <xref uid="@azure/abort-controller.AbortSignalLike" />
- name: agent
uid: '@azure/core-rest-pipeline.PipelineRequest.agent'
package: '@azure/core-rest-pipeline'
summary: |-
NODEJS ONLY
A Node-only option to provide a custom `http.Agent`/`https.Agent`.
Does nothing when running in the browser.
fullName: agent
remarks: ''
isDeprecated: false
syntax:
content: 'agent?: Agent'
return:
description: ''
type: <xref uid="@azure/core-rest-pipeline.Agent" />
- name: allowInsecureConnection
uid: '@azure/core-rest-pipeline.PipelineRequest.allowInsecureConnection'
package: '@azure/core-rest-pipeline'
summary: Set to true if the request is sent over HTTP instead of HTTPS
fullName: allowInsecureConnection
remarks: ''
isDeprecated: false
syntax:
content: 'allowInsecureConnection?: boolean'
return:
description: ''
type: boolean
- name: body
uid: '@azure/core-rest-pipeline.PipelineRequest.body'
package: '@azure/core-rest-pipeline'
summary: The HTTP body content (if any)
fullName: body
remarks: ''
isDeprecated: false
syntax:
content: 'body?: RequestBodyType'
return:
description: ''
type: <xref uid="@azure/core-rest-pipeline.RequestBodyType" />
- name: disableKeepAlive
uid: '@azure/core-rest-pipeline.PipelineRequest.disableKeepAlive'
package: '@azure/core-rest-pipeline'
summary: If the connection should not be reused.
fullName: disableKeepAlive
remarks: ''
isDeprecated: false
syntax:
content: 'disableKeepAlive?: boolean'
return:
description: ''
type: boolean
- name: enableBrowserStreams
uid: '@azure/core-rest-pipeline.PipelineRequest.enableBrowserStreams'
package: '@azure/core-rest-pipeline'
summary: >-
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
fullName: enableBrowserStreams
remarks: ''
isDeprecated: false
syntax:
content: 'enableBrowserStreams?: boolean'
return:
description: ''
type: boolean
- name: formData
uid: '@azure/core-rest-pipeline.PipelineRequest.formData'
package: '@azure/core-rest-pipeline'
summary: To simulate a browser form post
fullName: formData
remarks: ''
isDeprecated: false
syntax:
content: 'formData?: FormDataMap'
return:
description: ''
type: <xref uid="@azure/core-rest-pipeline.FormDataMap" />
- name: headers
uid: '@azure/core-rest-pipeline.PipelineRequest.headers'
package: '@azure/core-rest-pipeline'
summary: The HTTP headers to use when making the request.
fullName: headers
remarks: ''
isDeprecated: false
syntax:
content: 'headers: HttpHeaders'
return:
description: ''
type: <xref uid="@azure/core-rest-pipeline.HttpHeaders" />
- name: method
uid: '@azure/core-rest-pipeline.PipelineRequest.method'
package: '@azure/core-rest-pipeline'
summary: The HTTP method to use when making the request.
fullName: method
remarks: ''
isDeprecated: false
syntax:
content: 'method: HttpMethods'
return:
description: ''
type: <xref uid="@azure/core-rest-pipeline.HttpMethods" />
- name: onDownloadProgress
uid: '@azure/core-rest-pipeline.PipelineRequest.onDownloadProgress'
package: '@azure/core-rest-pipeline'
summary: Callback which fires upon download progress.
fullName: onDownloadProgress
remarks: ''
isDeprecated: false
syntax:
content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void'
return:
description: ''
type: '(progress: TransferProgressEvent) => void'
- name: onUploadProgress
uid: '@azure/core-rest-pipeline.PipelineRequest.onUploadProgress'
package: '@azure/core-rest-pipeline'
summary: Callback which fires upon upload progress.
fullName: onUploadProgress
remarks: ''
isDeprecated: false
syntax:
content: 'onUploadProgress?: (progress: TransferProgressEvent) => void'
return:
description: ''
type: '(progress: TransferProgressEvent) => void'
- name: proxySettings
uid: '@azure/core-rest-pipeline.PipelineRequest.proxySettings'
package: '@azure/core-rest-pipeline'
summary: Proxy configuration.
fullName: proxySettings
remarks: ''
isDeprecated: false
syntax:
content: 'proxySettings?: ProxySettings'
return:
description: ''
type: <xref uid="@azure/core-rest-pipeline.ProxySettings" />
- name: requestId
uid: '@azure/core-rest-pipeline.PipelineRequest.requestId'
package: '@azure/core-rest-pipeline'
summary: A unique identifier for the request. Used for logging and tracing.
fullName: requestId
remarks: ''
isDeprecated: false
syntax:
content: 'requestId: string'
return:
description: ''
type: string
- name: streamResponseStatusCodes
uid: '@azure/core-rest-pipeline.PipelineRequest.streamResponseStatusCodes'
package: '@azure/core-rest-pipeline'
summary: >-
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.
fullName: streamResponseStatusCodes
remarks: ''
isDeprecated: false
syntax:
content: 'streamResponseStatusCodes?: Set<number>'
return:
description: ''
type: Set<number>
- name: timeout
uid: '@azure/core-rest-pipeline.PipelineRequest.timeout'
package: '@azure/core-rest-pipeline'
summary: >-
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.
fullName: timeout
remarks: ''
isDeprecated: false
syntax:
content: 'timeout: number'
return:
description: ''
type: number
- name: tlsSettings
uid: '@azure/core-rest-pipeline.PipelineRequest.tlsSettings'
package: '@azure/core-rest-pipeline'
summary: Settings for configuring TLS authentication
fullName: tlsSettings
remarks: ''
isDeprecated: false
syntax:
content: 'tlsSettings?: TlsSettings'
return:
description: ''
type: <xref uid="@azure/core-rest-pipeline.TlsSettings" />
- name: tracingOptions
uid: '@azure/core-rest-pipeline.PipelineRequest.tracingOptions'
package: '@azure/core-rest-pipeline'
summary: Tracing options to use for any created Spans.
fullName: tracingOptions
remarks: ''
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
description: ''
type: <xref uid="@azure/core-tracing.OperationTracingOptions" />
- name: url
uid: '@azure/core-rest-pipeline.PipelineRequest.url'
package: '@azure/core-rest-pipeline'
summary: The URL to make the request to.
fullName: url
remarks: ''
isDeprecated: false
syntax:
content: 'url: string'
return:
description: ''
type: string
- name: withCredentials
uid: '@azure/core-rest-pipeline.PipelineRequest.withCredentials'
package: '@azure/core-rest-pipeline'
summary: >-
Indicates whether the user agent should send cookies from the other domain
in the case of cross-origin requests.
Defaults to false.
fullName: withCredentials
remarks: ''
isDeprecated: false
syntax:
content: 'withCredentials: boolean'
return:
description: ''
type: boolean