-
Notifications
You must be signed in to change notification settings - Fork 180
/
WebActivity.yml
300 lines (300 loc) · 9.9 KB
/
WebActivity.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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
### YamlMime:TSType
name: WebActivity
uid: '@azure/arm-datafactory.WebActivity'
package: '@azure/arm-datafactory'
summary: Web activity.
fullName: WebActivity
remarks: ''
isDeprecated: false
type: interface
properties:
- name: authentication
uid: '@azure/arm-datafactory.WebActivity.authentication'
package: '@azure/arm-datafactory'
summary: Authentication method used for calling the endpoint.
fullName: authentication
remarks: ''
isDeprecated: false
syntax:
content: 'authentication?: WebActivityAuthentication'
return:
description: ''
type: <xref uid="@azure/arm-datafactory.WebActivityAuthentication" />
- name: body
uid: '@azure/arm-datafactory.WebActivity.body'
package: '@azure/arm-datafactory'
summary: >-
Represents the payload that will be sent to the endpoint. Required for
POST/PUT method, not allowed for GET method Type: string (or Expression
with resultType string).
fullName: body
remarks: ''
isDeprecated: false
syntax:
content: 'body?: any'
return:
description: ''
type: any
- name: connectVia
uid: '@azure/arm-datafactory.WebActivity.connectVia'
package: '@azure/arm-datafactory'
summary: The integration runtime reference.
fullName: connectVia
remarks: ''
isDeprecated: false
syntax:
content: 'connectVia?: IntegrationRuntimeReference'
return:
description: ''
type: <xref uid="@azure/arm-datafactory.IntegrationRuntimeReference" />
- name: datasets
uid: '@azure/arm-datafactory.WebActivity.datasets'
package: '@azure/arm-datafactory'
summary: List of datasets passed to web endpoint.
fullName: datasets
remarks: ''
isDeprecated: false
syntax:
content: 'datasets?: DatasetReference[]'
return:
description: ''
type: <xref uid="@azure/arm-datafactory.DatasetReference" />[]
- name: disableCertValidation
uid: '@azure/arm-datafactory.WebActivity.disableCertValidation'
package: '@azure/arm-datafactory'
summary: When set to true, Certificate validation will be disabled.
fullName: disableCertValidation
remarks: ''
isDeprecated: false
syntax:
content: 'disableCertValidation?: boolean'
return:
description: ''
type: boolean
- name: headers
uid: '@azure/arm-datafactory.WebActivity.headers'
package: '@azure/arm-datafactory'
summary: >-
Represents the headers that will be sent to the request. For example, to
set the language and type on a request: "headers" : { "Accept-Language":
"en-us", "Content-Type": "application/json" }. Type: string (or Expression
with resultType string).
fullName: headers
remarks: ''
isDeprecated: false
syntax:
content: 'headers?: {[propertyName: string]: any}'
return:
description: ''
type: '{[propertyName: string]: any}'
- name: httpRequestTimeout
uid: '@azure/arm-datafactory.WebActivity.httpRequestTimeout'
package: '@azure/arm-datafactory'
summary: >-
Timeout for the HTTP request to get a response. Format is in TimeSpan
(hh:mm:ss). This value is the timeout to get a response, not the activity
timeout. The default value is 00:01:00 (1 minute). The range is from 1 to
10 minutes
fullName: httpRequestTimeout
remarks: ''
isDeprecated: false
syntax:
content: 'httpRequestTimeout?: any'
return:
description: ''
type: any
- name: linkedServices
uid: '@azure/arm-datafactory.WebActivity.linkedServices'
package: '@azure/arm-datafactory'
summary: List of linked services passed to web endpoint.
fullName: linkedServices
remarks: ''
isDeprecated: false
syntax:
content: 'linkedServices?: LinkedServiceReference[]'
return:
description: ''
type: <xref uid="@azure/arm-datafactory.LinkedServiceReference" />[]
- name: method
uid: '@azure/arm-datafactory.WebActivity.method'
package: '@azure/arm-datafactory'
summary: Rest API method for target endpoint.
fullName: method
remarks: ''
isDeprecated: false
syntax:
content: 'method: string'
return:
description: ''
type: string
- name: turnOffAsync
uid: '@azure/arm-datafactory.WebActivity.turnOffAsync'
package: '@azure/arm-datafactory'
summary: >-
Option to disable invoking HTTP GET on location given in response header
of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http
location given in response header. If set false then continues to invoke
HTTP GET call on location given in http response headers.
fullName: turnOffAsync
remarks: ''
isDeprecated: false
syntax:
content: 'turnOffAsync?: boolean'
return:
description: ''
type: boolean
- name: type
uid: '@azure/arm-datafactory.WebActivity.type'
package: '@azure/arm-datafactory'
summary: >-
Polymorphic discriminator, which specifies the different types this object
can be
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type: "WebActivity"'
return:
description: ''
type: '"WebActivity"'
- name: url
uid: '@azure/arm-datafactory.WebActivity.url'
package: '@azure/arm-datafactory'
summary: >-
Web activity target endpoint and path. Type: string (or Expression with
resultType string).
fullName: url
remarks: ''
isDeprecated: false
syntax:
content: 'url: any'
return:
description: ''
type: any
inheritedProperties:
- name: dependsOn
uid: '@azure/arm-datafactory.WebActivity.dependsOn'
package: '@azure/arm-datafactory'
summary: Activity depends on condition.
fullName: dependsOn
remarks: ''
isDeprecated: false
syntax:
content: 'dependsOn?: ActivityDependency[]'
return:
description: ''
type: <xref uid="@azure/arm-datafactory.ActivityDependency" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[ExecutionActivity.dependsOn](xref:@azure/arm-datafactory.ExecutionActivity.dependsOn)
- name: description
uid: '@azure/arm-datafactory.WebActivity.description'
package: '@azure/arm-datafactory'
summary: Activity description.
fullName: description
remarks: ''
isDeprecated: false
syntax:
content: 'description?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ExecutionActivity.description](xref:@azure/arm-datafactory.ExecutionActivity.description)
- name: linkedServiceName
uid: '@azure/arm-datafactory.WebActivity.linkedServiceName'
package: '@azure/arm-datafactory'
summary: Linked service reference.
fullName: linkedServiceName
remarks: ''
isDeprecated: false
syntax:
content: 'linkedServiceName?: LinkedServiceReference'
return:
description: ''
type: <xref uid="@azure/arm-datafactory.LinkedServiceReference" />
inheritanceDescription: >-
<b>Inherited From</b>
[ExecutionActivity.linkedServiceName](xref:@azure/arm-datafactory.ExecutionActivity.linkedServiceName)
- name: name
uid: '@azure/arm-datafactory.WebActivity.name'
package: '@azure/arm-datafactory'
summary: Activity name.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ExecutionActivity.name](xref:@azure/arm-datafactory.ExecutionActivity.name)
- name: onInactiveMarkAs
uid: '@azure/arm-datafactory.WebActivity.onInactiveMarkAs'
package: '@azure/arm-datafactory'
summary: >-
Status result of the activity when the state is set to Inactive. This is
an optional property and if not provided when the activity is inactive,
the status will be Succeeded by default.
fullName: onInactiveMarkAs
remarks: ''
isDeprecated: false
syntax:
content: 'onInactiveMarkAs?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ExecutionActivity.onInactiveMarkAs](xref:@azure/arm-datafactory.ExecutionActivity.onInactiveMarkAs)
- name: policy
uid: '@azure/arm-datafactory.WebActivity.policy'
package: '@azure/arm-datafactory'
summary: Activity policy.
fullName: policy
remarks: ''
isDeprecated: false
syntax:
content: 'policy?: ActivityPolicy'
return:
description: ''
type: <xref uid="@azure/arm-datafactory.ActivityPolicy" />
inheritanceDescription: >-
<b>Inherited From</b>
[ExecutionActivity.policy](xref:@azure/arm-datafactory.ExecutionActivity.policy)
- name: state
uid: '@azure/arm-datafactory.WebActivity.state'
package: '@azure/arm-datafactory'
summary: >-
Activity state. This is an optional property and if not provided, the
state will be Active by default.
fullName: state
remarks: ''
isDeprecated: false
syntax:
content: 'state?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ExecutionActivity.state](xref:@azure/arm-datafactory.ExecutionActivity.state)
- name: userProperties
uid: '@azure/arm-datafactory.WebActivity.userProperties'
package: '@azure/arm-datafactory'
summary: Activity user properties.
fullName: userProperties
remarks: ''
isDeprecated: false
syntax:
content: 'userProperties?: UserProperty[]'
return:
description: ''
type: <xref uid="@azure/arm-datafactory.UserProperty" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[ExecutionActivity.userProperties](xref:@azure/arm-datafactory.ExecutionActivity.userProperties)
extends: <xref uid="@azure/arm-datafactory.ExecutionActivity" />