-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
_help.py
435 lines (376 loc) · 12.7 KB
/
_help.py
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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
# coding=utf-8
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
from knack.help_files import helps # pylint: disable=unused-import
# pylint: disable=line-too-long, too-many-lines
helps['dla'] = """
type: group
short-summary: Manage Data Lake Analytics accounts, jobs, and catalogs.
"""
helps['dla account'] = """
type: group
short-summary: Manage Data Lake Analytics accounts.
"""
helps['dla account blob-storage'] = """
type: group
short-summary: Manage links between Data Lake Analytics accounts and Azure Storage.
"""
helps['dla account blob-storage add'] = """
type: command
short-summary: Links an Azure Storage account to the specified Data Lake Analytics account.
"""
helps['dla account blob-storage update'] = """
type: command
short-summary: Updates an Azure Storage account linked to the specified Data Lake Analytics account.
"""
helps['dla account compute-policy'] = """
type: group
short-summary: Manage Data Lake Analytics account compute policies.
"""
helps['dla account compute-policy create'] = """
type: command
short-summary: Create a compute policy in the Data Lake Analytics account.
parameters:
- name: --max-dop-per-job
type: int
short-summary: The maximum degree of parallelism allowed per job for this policy. At least one of `--min-priority-per-job` and `--max-dop-per-job` must be specified.
- name: --min-priority-per-job
type: int
short-summary: The minimum priority allowed per job for this policy. At least one of `--min-priority-per-job` and `--max-dop-per-job` must be specified.
- name: --compute-policy-name
type: string
short-summary: The name of the compute policy to create.
- name: --object-id
type: string
short-summary: The Azure Active Directory object ID of the user, group, or service principal to apply the policy to.
- name: --object-type
type: string
short-summary: The Azure Active Directory object type associated with the supplied object ID.
"""
helps['dla account compute-policy delete'] = """
type: command
short-summary: Delete a compute policy in a Data Lake Analytics account.
"""
helps['dla account compute-policy list'] = """
type: command
short-summary: List compute policies in the a Lake Analytics account.
"""
helps['dla account compute-policy show'] = """
type: command
short-summary: Retrieve a compute policy in a Data Lake Analytics account.
"""
helps['dla account compute-policy update'] = """
type: command
short-summary: Update a compute policy in the Data Lake Analytics account.
parameters:
- name: --max-dop-per-job
type: int
short-summary: The maximum degree of parallelism allowed per job for this policy. At least one of `--min-priority-per-job` and `--max-dop-per-job` must be specified.
- name: --min-priority-per-job
type: int
short-summary: The minimum priority allowed per job for this policy. At least one of `--min-priority-per-job` and `--max-dop-per-job` must be specified.
- name: --compute-policy-name
type: string
short-summary: The name of the compute policy to update.
"""
helps['dla account create'] = """
type: command
short-summary: Create a Data Lake Analytics account.
parameters:
- name: --default-data-lake-store
type: string
short-summary: The default Data Lake Store account to associate with the created account.
- name: --max-degree-of-parallelism
type: int
short-summary: The maximum degree of parallelism for this account.
- name: --max-job-count
type: int
short-summary: The maximum number of concurrent jobs for this account.
- name: --query-store-retention
type: int
short-summary: The number of days to retain job metadata.
"""
helps['dla account data-lake-store'] = """
type: group
short-summary: Manage links between Data Lake Analytics and Data Lake Store accounts.
"""
helps['dla account delete'] = """
type: command
short-summary: Delete a Data Lake Analytics account.
"""
helps['dla account firewall'] = """
type: group
short-summary: Manage Data Lake Analytics account firewall rules.
"""
helps['dla account firewall create'] = """
type: command
short-summary: Create a firewall rule in a Data Lake Analytics account.
parameters:
- name: --end-ip-address
type: string
short-summary: The end of the valid IP range for the firewall rule.
- name: --start-ip-address
type: string
short-summary: The start of the valid IP range for the firewall rule.
- name: --firewall-rule-name
type: string
short-summary: The name of the firewall rule.
"""
helps['dla account firewall delete'] = """
type: command
short-summary: Delete a firewall rule in a Data Lake Analytics account.
"""
helps['dla account firewall list'] = """
type: command
short-summary: List firewall rules in a Data Lake Analytics account.
"""
helps['dla account firewall show'] = """
type: command
short-summary: Retrieve a firewall rule in a Data Lake Analytics account.
"""
helps['dla account firewall update'] = """
type: command
short-summary: Update a firewall rule in a Data Lake Analytics account.
"""
helps['dla account list'] = """
type: command
short-summary: List available Data Lake Analytics accounts.
"""
helps['dla account show'] = """
type: command
short-summary: Get the details of a Data Lake Analytics account.
"""
helps['dla account update'] = """
type: command
short-summary: Update a Data Lake Analytics account.
parameters:
- name: --max-degree-of-parallelism
type: int
short-summary: The maximum degree of parallelism for this account.
- name: --max-job-count
type: int
short-summary: The maximum number of concurrent jobs for this account.
- name: --query-store-retention
type: int
short-summary: The number of days to retain job metadata.
- name: --firewall-state
type: string
short-summary: Enable or disable existing firewall rules.
- name: --allow-azure-ips
type: string
short-summary: Allow or block IPs originating from Azure through the firewall.
"""
helps['dla catalog'] = """
type: group
short-summary: Manage Data Lake Analytics catalogs.
"""
helps['dla catalog assembly'] = """
type: group
short-summary: Manage Data Lake Analytics catalog assemblies.
"""
helps['dla catalog credential'] = """
type: group
short-summary: Manage Data Lake Analytics catalog credentials.
"""
helps['dla catalog credential create'] = """
type: command
short-summary: Create a new catalog credential for use with an external data source.
parameters:
- name: --credential-name
type: string
short-summary: The name of the credential.
- name: --database-name
type: string
short-summary: The name of the database in which to create the credential.
- name: --user-name
type: string
short-summary: The user name that will be used when authenticating with this credential.
"""
helps['dla catalog credential delete'] = """
type: command
short-summary: Delete a catalog credential.
"""
helps['dla catalog credential list'] = """
type: command
short-summary: List catalog credentials.
"""
helps['dla catalog credential show'] = """
type: command
short-summary: Retrieve a catalog credential.
"""
helps['dla catalog credential update'] = """
type: command
short-summary: Update a catalog credential for use with an external data source.
parameters:
- name: --credential-name
type: string
short-summary: The name of the credential to update.
- name: --database-name
type: string
short-summary: The name of the database in which the credential exists.
- name: --user-name
type: string
short-summary: The user name associated with the credential that will have its password updated.
"""
helps['dla catalog database'] = """
type: group
short-summary: Manage Data Lake Analytics catalog databases.
"""
helps['dla catalog external-data-source'] = """
type: group
short-summary: Manage Data Lake Analytics catalog external data sources.
"""
helps['dla catalog package'] = """
type: group
short-summary: Manage Data Lake Analytics catalog packages.
"""
helps['dla catalog procedure'] = """
type: group
short-summary: Manage Data Lake Analytics catalog stored procedures.
"""
helps['dla catalog schema'] = """
type: group
short-summary: Manage Data Lake Analytics catalog schemas.
"""
helps['dla catalog table'] = """
type: group
short-summary: Manage Data Lake Analytics catalog tables.
"""
helps['dla catalog table list'] = """
type: command
short-summary: List tables in a database or schema.
parameters:
- name: --database-name
type: string
short-summary: The name of the database.
- name: --schema-name
type: string
short-summary: The schema assocated with the tables to list.
"""
helps['dla catalog table-partition'] = """
type: group
short-summary: Manage Data Lake Analytics catalog table partitions.
"""
helps['dla catalog table-stats'] = """
type: group
short-summary: Manage Data Lake Analytics catalog table statistics.
"""
helps['dla catalog table-stats list'] = """
type: command
short-summary: List table statistics in a database, table, or schema.
parameters:
- name: --database-name
type: string
short-summary: The name of the database.
- name: --schema-name
type: string
short-summary: The schema associated with the tables to list.
- name: --table-name
type: string
short-summary: The table to list statistics for. `--schema-name` must also be specified.
"""
helps['dla catalog table-type'] = """
type: group
short-summary: Manage Data Lake Analytics catalog table types.
"""
helps['dla catalog tvf'] = """
type: group
short-summary: Manage Data Lake Analytics catalog table valued functions.
"""
helps['dla catalog tvf list'] = """
type: command
short-summary: List table valued functions in a database or schema.
parameters:
- name: --database-name
type: string
short-summary: The name of the database.
- name: --schema-name
type: string
short-summary: The name of the schema assocated with table valued functions to list.
"""
helps['dla catalog view'] = """
type: group
short-summary: Manage Data Lake Analytics catalog views.
"""
helps['dla catalog view list'] = """
type: command
short-summary: List views in a database or schema.
parameters:
- name: --database-name
type: string
short-summary: The name of the database.
- name: --schema-name
type: string
short-summary: The name of the schema associated with the views to list.
"""
helps['dla job'] = """
type: group
short-summary: Manage Data Lake Analytics jobs.
"""
helps['dla job cancel'] = """
type: command
short-summary: Cancel a Data Lake Analytics job.
"""
helps['dla job list'] = """
type: command
short-summary: List Data Lake Analytics jobs.
"""
helps['dla job pipeline'] = """
type: group
short-summary: Manage Data Lake Analytics job pipelines.
"""
helps['dla job pipeline list'] = """
type: command
short-summary: List job pipelines in a Data Lake Analytics account.
"""
helps['dla job pipeline show'] = """
type: command
short-summary: Retrieve a job pipeline in a Data Lake Analytics account.
"""
helps['dla job recurrence'] = """
type: group
short-summary: Manage Data Lake Analytics job recurrences.
"""
helps['dla job recurrence list'] = """
type: command
short-summary: List job recurrences in a Data Lake Analytics account.
"""
helps['dla job recurrence show'] = """
type: command
short-summary: Retrieve a job recurrence in a Data Lake Analytics account.
"""
helps['dla job show'] = """
type: command
short-summary: Get information for a Data Lake Analytics job.
"""
helps['dla job submit'] = """
type: command
short-summary: Submit a job to a Data Lake Analytics account.
parameters:
- name: --job-name
type: string
short-summary: Name for the submitted job.
- name: --script
type: string
short-summary: Script to submit. This may be '@{file}' to load from a file.
- name: --runtime-version
short-summary: The runtime version to use.
long-summary: This parameter is used for explicitly overwriting the default runtime. It should only be done if you know what you are doing.
- name: --degree-of-parallelism
short-summary: The degree of parallelism for the job.
long-summary: Higher values equate to more parallelism and will usually yield faster running jobs, at the cost of more AUs.
- name: --priority
short-summary: The priority of the job.
long-summary: Lower values increase the priority, with the lowest value being 1. This determines the order jobs are run in.
"""
helps['dla job wait'] = """
type: command
short-summary: Wait for a Data Lake Analytics job to finish.
long-summary: This command exits when the job completes.
parameters:
- name: --job-id
type: string
short-summary: 'Job ID to poll for completion.'
"""