/
OperationRequestOptions.yml
90 lines (89 loc) · 3 KB
/
OperationRequestOptions.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
### YamlMime:TSType
name: OperationRequestOptions
uid: '@azure/core-client.OperationRequestOptions'
package: '@azure/core-client'
summary: Options used when creating and sending HTTP requests for this operation.
fullName: OperationRequestOptions
remarks: ''
isDeprecated: false
type: interface
properties:
- name: allowInsecureConnection
uid: '@azure/core-client.OperationRequestOptions.allowInsecureConnection'
package: '@azure/core-client'
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: customHeaders
uid: '@azure/core-client.OperationRequestOptions.customHeaders'
package: '@azure/core-client'
summary: |-
User defined custom request headers that
will be applied before the request is sent.
fullName: customHeaders
remarks: ''
isDeprecated: false
syntax:
content: 'customHeaders?: {[key: string]: string}'
return:
description: ''
type: '{[key: string]: string}'
- name: onDownloadProgress
uid: '@azure/core-client.OperationRequestOptions.onDownloadProgress'
package: '@azure/core-client'
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-client.OperationRequestOptions.onUploadProgress'
package: '@azure/core-client'
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: shouldDeserialize
uid: '@azure/core-client.OperationRequestOptions.shouldDeserialize'
package: '@azure/core-client'
summary: >-
Whether or not the HttpOperationResponse should be deserialized. If this
is undefined, then the
HttpOperationResponse should be deserialized.
fullName: shouldDeserialize
remarks: ''
isDeprecated: false
syntax:
content: 'shouldDeserialize?: boolean | (response: PipelineResponse) => boolean'
return:
description: ''
type: 'boolean | (response: PipelineResponse) => boolean'
- name: timeout
uid: '@azure/core-client.OperationRequestOptions.timeout'
package: '@azure/core-client'
summary: >-
The number of milliseconds a request can take before automatically being
terminated.
fullName: timeout
remarks: ''
isDeprecated: false
syntax:
content: 'timeout?: number'
return:
description: ''
type: number