-
Notifications
You must be signed in to change notification settings - Fork 180
/
AzureDatabricksLinkedService.yml
367 lines (367 loc) · 12.9 KB
/
AzureDatabricksLinkedService.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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
### YamlMime:TSType
name: AzureDatabricksLinkedService
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService'
package: '@azure/arm-datafactory'
summary: Azure Databricks linked service.
fullName: AzureDatabricksLinkedService
remarks: ''
isDeprecated: false
type: interface
properties:
- name: accessToken
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.accessToken'
package: '@azure/arm-datafactory'
summary: >-
Access token for databricks REST API. Refer to
https://docs.azuredatabricks.net/api/latest/authentication.html. Type:
string (or Expression with resultType string).
fullName: accessToken
remarks: ''
isDeprecated: false
syntax:
content: 'accessToken?: SecretBaseUnion'
return:
description: ''
type: <xref uid="@azure/arm-datafactory.SecretBaseUnion" />
- name: authentication
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.authentication'
package: '@azure/arm-datafactory'
summary: >-
Required to specify MSI, if using Workspace resource id for databricks
REST API. Type: string (or Expression with resultType string).
fullName: authentication
remarks: ''
isDeprecated: false
syntax:
content: 'authentication?: any'
return:
description: ''
type: any
- name: credential
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.credential'
package: '@azure/arm-datafactory'
summary: The credential reference containing authentication information.
fullName: credential
remarks: ''
isDeprecated: false
syntax:
content: 'credential?: CredentialReference'
return:
description: ''
type: <xref uid="@azure/arm-datafactory.CredentialReference" />
- name: domain
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.domain'
package: '@azure/arm-datafactory'
summary: >-
<REGION>.azuredatabricks.net, domain name of your Databricks deployment.
Type: string (or Expression with resultType string).
fullName: domain
remarks: ''
isDeprecated: false
syntax:
content: 'domain: any'
return:
description: ''
type: any
- name: encryptedCredential
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.encryptedCredential'
package: '@azure/arm-datafactory'
summary: >-
The encrypted credential used for authentication. Credentials are
encrypted using the integration runtime credential manager. Type: string.
fullName: encryptedCredential
remarks: ''
isDeprecated: false
syntax:
content: 'encryptedCredential?: string'
return:
description: ''
type: string
- name: existingClusterId
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.existingClusterId'
package: '@azure/arm-datafactory'
summary: >-
The id of an existing interactive cluster that will be used for all runs
of this activity. Type: string (or Expression with resultType string).
fullName: existingClusterId
remarks: ''
isDeprecated: false
syntax:
content: 'existingClusterId?: any'
return:
description: ''
type: any
- name: instancePoolId
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.instancePoolId'
package: '@azure/arm-datafactory'
summary: >-
The id of an existing instance pool that will be used for all runs of this
activity. Type: string (or Expression with resultType string).
fullName: instancePoolId
remarks: ''
isDeprecated: false
syntax:
content: 'instancePoolId?: any'
return:
description: ''
type: any
- name: newClusterCustomTags
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.newClusterCustomTags'
package: '@azure/arm-datafactory'
summary: >-
Additional tags for cluster resources. This property is ignored in
instance pool configurations.
fullName: newClusterCustomTags
remarks: ''
isDeprecated: false
syntax:
content: 'newClusterCustomTags?: {[propertyName: string]: any}'
return:
description: ''
type: '{[propertyName: string]: any}'
- name: newClusterDriverNodeType
uid: >-
@azure/arm-datafactory.AzureDatabricksLinkedService.newClusterDriverNodeType
package: '@azure/arm-datafactory'
summary: >-
The driver node type for the new job cluster. This property is ignored in
instance pool configurations. Type: string (or Expression with resultType
string).
fullName: newClusterDriverNodeType
remarks: ''
isDeprecated: false
syntax:
content: 'newClusterDriverNodeType?: any'
return:
description: ''
type: any
- name: newClusterEnableElasticDisk
uid: >-
@azure/arm-datafactory.AzureDatabricksLinkedService.newClusterEnableElasticDisk
package: '@azure/arm-datafactory'
summary: >-
Enable the elastic disk on the new cluster. This property is now ignored,
and takes the default elastic disk behavior in Databricks (elastic disks
are always enabled). Type: boolean (or Expression with resultType
boolean).
fullName: newClusterEnableElasticDisk
remarks: ''
isDeprecated: false
syntax:
content: 'newClusterEnableElasticDisk?: any'
return:
description: ''
type: any
- name: newClusterInitScripts
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.newClusterInitScripts'
package: '@azure/arm-datafactory'
summary: >-
User-defined initialization scripts for the new cluster. Type: array of
strings (or Expression with resultType array of strings).
fullName: newClusterInitScripts
remarks: ''
isDeprecated: false
syntax:
content: 'newClusterInitScripts?: any'
return:
description: ''
type: any
- name: newClusterLogDestination
uid: >-
@azure/arm-datafactory.AzureDatabricksLinkedService.newClusterLogDestination
package: '@azure/arm-datafactory'
summary: >-
Specify a location to deliver Spark driver, worker, and event logs. Type:
string (or Expression with resultType string).
fullName: newClusterLogDestination
remarks: ''
isDeprecated: false
syntax:
content: 'newClusterLogDestination?: any'
return:
description: ''
type: any
- name: newClusterNodeType
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.newClusterNodeType'
package: '@azure/arm-datafactory'
summary: >-
The node type of the new job cluster. This property is required if
newClusterVersion is specified and instancePoolId is not specified. If
instancePoolId is specified, this property is ignored. Type: string (or
Expression with resultType string).
fullName: newClusterNodeType
remarks: ''
isDeprecated: false
syntax:
content: 'newClusterNodeType?: any'
return:
description: ''
type: any
- name: newClusterNumOfWorker
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.newClusterNumOfWorker'
package: '@azure/arm-datafactory'
summary: >-
If not using an existing interactive cluster, this specifies the number of
worker nodes to use for the new job cluster or instance pool. For new job
clusters, this a string-formatted Int32, like '1' means numOfWorker is 1
or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools,
this is a string-formatted Int32, and can only specify a fixed number of
worker nodes, such as '2'. Required if newClusterVersion is specified.
Type: string (or Expression with resultType string).
fullName: newClusterNumOfWorker
remarks: ''
isDeprecated: false
syntax:
content: 'newClusterNumOfWorker?: any'
return:
description: ''
type: any
- name: newClusterSparkConf
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.newClusterSparkConf'
package: '@azure/arm-datafactory'
summary: A set of optional, user-specified Spark configuration key-value pairs.
fullName: newClusterSparkConf
remarks: ''
isDeprecated: false
syntax:
content: 'newClusterSparkConf?: {[propertyName: string]: any}'
return:
description: ''
type: '{[propertyName: string]: any}'
- name: newClusterSparkEnvVars
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.newClusterSparkEnvVars'
package: '@azure/arm-datafactory'
summary: >-
A set of optional, user-specified Spark environment variables key-value
pairs.
fullName: newClusterSparkEnvVars
remarks: ''
isDeprecated: false
syntax:
content: 'newClusterSparkEnvVars?: {[propertyName: string]: any}'
return:
description: ''
type: '{[propertyName: string]: any}'
- name: newClusterVersion
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.newClusterVersion'
package: '@azure/arm-datafactory'
summary: >-
If not using an existing interactive cluster, this specifies the Spark
version of a new job cluster or instance pool nodes created for each run
of this activity. Required if instancePoolId is specified. Type: string
(or Expression with resultType string).
fullName: newClusterVersion
remarks: ''
isDeprecated: false
syntax:
content: 'newClusterVersion?: any'
return:
description: ''
type: any
- name: policyId
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.policyId'
package: '@azure/arm-datafactory'
summary: >-
The policy id for limiting the ability to configure clusters based on a
user defined set of rules. Type: string (or Expression with resultType
string).
fullName: policyId
remarks: ''
isDeprecated: false
syntax:
content: 'policyId?: any'
return:
description: ''
type: any
- name: type
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.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: "AzureDatabricks"'
return:
description: ''
type: '"AzureDatabricks"'
- name: workspaceResourceId
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.workspaceResourceId'
package: '@azure/arm-datafactory'
summary: >-
Workspace resource id for databricks REST API. Type: string (or Expression
with resultType string).
fullName: workspaceResourceId
remarks: ''
isDeprecated: false
syntax:
content: 'workspaceResourceId?: any'
return:
description: ''
type: any
inheritedProperties:
- name: annotations
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.annotations'
package: '@azure/arm-datafactory'
summary: List of tags that can be used for describing the linked service.
fullName: annotations
remarks: ''
isDeprecated: false
syntax:
content: 'annotations?: any[]'
return:
description: ''
type: any[]
inheritanceDescription: >-
<b>Inherited From</b>
[LinkedService.annotations](xref:@azure/arm-datafactory.LinkedService.annotations)
- name: connectVia
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.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" />
inheritanceDescription: >-
<b>Inherited From</b>
[LinkedService.connectVia](xref:@azure/arm-datafactory.LinkedService.connectVia)
- name: description
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.description'
package: '@azure/arm-datafactory'
summary: Linked service description.
fullName: description
remarks: ''
isDeprecated: false
syntax:
content: 'description?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[LinkedService.description](xref:@azure/arm-datafactory.LinkedService.description)
- name: parameters
uid: '@azure/arm-datafactory.AzureDatabricksLinkedService.parameters'
package: '@azure/arm-datafactory'
summary: Parameters for linked service.
fullName: parameters
remarks: ''
isDeprecated: false
syntax:
content: 'parameters?: {[propertyName: string]: ParameterSpecification}'
return:
description: ''
type: >-
{[propertyName: string]: <xref
uid="@azure/arm-datafactory.ParameterSpecification" />}
inheritanceDescription: >-
<b>Inherited From</b>
[LinkedService.parameters](xref:@azure/arm-datafactory.LinkedService.parameters)
extends: <xref uid="@azure/arm-datafactory.LinkedService" />