forked from MicrosoftDocs/azure-docs-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.pycliyml
More file actions
485 lines (485 loc) · 15.9 KB
/
Copy pathindex.pycliyml
File metadata and controls
485 lines (485 loc) · 15.9 KB
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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
commandList:
- name: az account
description: Manage subscriptions.
href: account
isGroup: true
- name: az acr
description: Manage Azure Container Registries.
href: acr
isGroup: true
- name: az acs
description: Manage Azure Container Services.
href: acs
isGroup: true
- name: az ad
description: Synchronize on-premises directories and manage Azure Active Directory resources.
href: ad
isGroup: true
- name: az appservice
description: Manage your App Service plans.
href: appservice
isGroup: true
- name: az batch
description: Manage Azure Batch.
href: batch
isGroup: true
- name: az billing
description: Manage Azure Billing.
href: billing
isGroup: true
- name: az cdn
description: Manage Azure Content Delivery Networks (CDN).
href: cdn
isGroup: true
- name: az cloud
description: Manage the registered Azure clouds.
href: cloud
isGroup: true
- name: az cognitiveservices
description: Manage Cognitive Services accounts in Azure Resource Manager.
href: cognitiveservices
isGroup: true
- name: az component
description: Manage and update Azure CLI 2.0 components.
href: component
isGroup: true
- name: az configure
description: Configure Azure CLI 2.0 or view your configuration. The command is interactive, so just type az configure and respond to the prompts.
href: '#configure'
- name: az consumption
description: Manage Azure Consumption.
href: consumption
isGroup: true
- name: az cosmosdb
description: Manage Azure Cosmos DB database accounts.
href: cosmosdb
isGroup: true
- name: az disk
description: Manage Azure Managed Disks.
href: disk
isGroup: true
- name: az dla
description: Commands to manage Data Lake Analytics accounts, jobs, and catalogs.
href: dla
isGroup: true
- name: az dls
description: Commands to manage Data Lake Store accounts, and filesystems.
href: dls
isGroup: true
- name: az feature
description: Manage resource provider features, such as previews.
href: feature
isGroup: true
- name: az feedback
description: Loving or hating the CLI? Let us know!
href: '#feedback'
- name: az find
description: Find Azure CLI commands based on a given query.
href: '#find'
- name: az functionapp
description: Manage your function app.
href: functionapp
isGroup: true
- name: az group
description: Manage resource groups and template deployments.
href: group
isGroup: true
- name: az image
description: Manage custom Virtual Machine Images.
href: image
isGroup: true
- name: az interactive
description: Start the interactive experience.
href: '#interactive'
- name: az iot
description: Connect, monitor, and control millions of IoT assets.
href: iot
isGroup: true
- name: az keyvault
description: Safeguard and maintain control of keys, secrets, and certificates.
href: keyvault
isGroup: true
- name: az lab
description: Commands to manage DevTest Labs.
href: lab
isGroup: true
- name: az lock
description: Manage Azure locks.
href: lock
isGroup: true
- name: az login
description: Log in to access Azure subscriptions.
href: '#login'
- name: az logout
description: Log out to remove access to Azure subscriptions.
href: '#logout'
- name: az managedapp
description: Manage template solutions provided and maintained by the ISV using managedapp and managedapp definitions.
href: managedapp
isGroup: true
- name: az monitor
description: Commands to manage Azure Monitor service.
href: monitor
isGroup: true
- name: az mysql
description: Commands to manage Azure Database for MySQL servers.
href: mysql
isGroup: true
- name: az network
description: Manages Azure Network resources.
href: network
isGroup: true
- name: az policy
description: Manage resource policies.
href: policy
isGroup: true
- name: az postgres
description: Commands to manage Azure Database for PostgreSQL servers.
href: postgres
isGroup: true
- name: az provider
description: Manage resource providers.
href: provider
isGroup: true
- name: az redis
description: Access to a secure, dedicated cache for your Azure applications.
href: redis
isGroup: true
- name: az resource
description: Manage Azure resources.
href: resource
isGroup: true
- name: az role
description: Use role assignments to manage access to your Azure resources.
href: role
isGroup: true
- name: az sf
description: Manage and administer a Service Fabric cluster.
href: sf
isGroup: true
- name: az snapshot
description: Manage point-in-time copies of managed disks, native blobs, or other snapshots.
href: snapshot
isGroup: true
- name: az sql
description: Manage Azure SQL Databases and Data Warehouses.
href: sql
isGroup: true
- name: az storage
description: Durable, highly available, and massively scalable cloud storage.
href: storage
isGroup: true
- name: az tag
description: Manage resource tags.
href: tag
isGroup: true
- name: az taskhelp
description: Provides long-form help content by topic.
href: taskhelp
isGroup: true
- name: az vm
description: Provision Linux or Windows virtual machines in seconds.
href: vm
isGroup: true
- name: az vmss
description: Create highly available, auto-scalable Linux or Windows virtual machines.
href: vmss
isGroup: true
- name: az webapp
description: Manage web apps.
href: webapp
isGroup: true
htmlId: az
examples: []
source:
remote:
path: src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children:
- commandList: []
htmlId: configure
examples: []
parameters:
- name: --defaults -d
isRequired: False
summary: Space separated 'name=value' pairs for common arguments defaults, e.g. '--defaults group=myRG web=myweb vm=myvm'. Use '' to clear the defaults, e.g. --defaults vm='' web=''.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-configure/azure/cli/command_modules/configure/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_configure
name: az configure
description: ''
summary: Configure Azure CLI 2.0 or view your configuration. The command is interactive, so just type az configure and respond to the prompts.
Metadata: {}
- commandList: []
htmlId: feedback
examples: []
parameters:
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-feedback/azure/cli/command_modules/feedback/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_feedback
name: az feedback
description: ''
summary: Loving or hating the CLI? Let us know!
Metadata: {}
- commandList: []
htmlId: find
examples:
- title: Search for things containing 'vm' or 'secret'
code: az find -q vm secret
parameters:
- name: --search-query -q
isRequired: True
summary: Query text to find.
description: ''
- name: --reindex
isRequired: False
summary: Clear the current index and reindex the command modules.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-find/azure/cli/command_modules/find/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_find
name: az find
description: ''
summary: Find Azure CLI commands based on a given query.
Metadata: {}
- commandList: []
htmlId: interactive
examples: []
parameters:
- name: --style -s
isRequired: False
summary: The colors of the shell.
description: ''
parameterValueGroup: bg, br, contrast, default, grey, halloween, neon, none, pastel, primary, purple, quiet
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-interactive/azure/cli/command_modules/interactive/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_interactive
name: az interactive
description: An interactive environment that makes it easier to learn and use Azure CLI commands. see <a href="https://azure.microsoft.com/en-us/blog/welcome-to-azure-cli-shell/">https://azure.microsoft.com/en-us/blog/welcome-to-azure-cli-shell/</a>.
summary: Start the interactive experience.
Metadata: {}
- commandList: []
htmlId: login
examples:
- title: Log in interactively.
code: az login
- title: Log in with user name and password. This doesn't work with Microsoft accounts or accounts that have two-factor authentication enabled.
code: az login -u johndoe@contoso.com -p VerySecret
- title: Log in with a service principal using client secret.
code: az login --service-principal -u http://azure-cli-2016-08-05-14-31-15 -p VerySecret --tenant contoso.onmicrosoft.com
- title: Log in with a service principal using client certificate.
code: az login --service-principal -u http://azure-cli-2016-08-05-14-31-15 -p ~/mycertfile.pem --tenant contoso.onmicrosoft.com
- title: Log in with subscription id and port number if in a VM with Managed Service Identity
code: az login -u 0b1f6471-1bf0-4dda-aec3-cb9272f11111@50342
parameters:
- name: --allow-no-subscriptions
isRequired: False
summary: Support access tenants without subscriptions. It's uncommon but useful to run tenant level commands, such as 'az ad'.
description: ''
- name: --password -p
isRequired: False
summary: Credentials like user password, or for a service principal, provide client secret or a pem file with key and public certificate. Will prompt if not given.
description: ''
- name: --service-principal
isRequired: False
summary: The credential representing a service principal.
description: ''
- name: --tenant -t
isRequired: False
summary: The AAD tenant, must provide when using service principals.
description: ''
- name: --username -u
isRequired: False
summary: Organization id or service principal.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_login
name: az login
description: ''
summary: Log in to access Azure subscriptions.
Metadata: {}
- commandList: []
htmlId: logout
examples: []
parameters:
- name: --username
isRequired: False
summary: Account user, if missing, logout the current active account.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
source:
remote:
path: src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
branch: master
repo: https://github.com/Azure/azure-cli.git
children: []
uid: az_logout
name: az logout
description: ''
summary: Log out to remove access to Azure subscriptions.
Metadata: {}
uid: az
name: 'Azure CLI 2.0: Command reference - az'
description: ''
summary: ''
Metadata:
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
doc_source_url_path: src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
gitcommit: https://github.com/Azure/azure-cli/blob/2b6a49180f52618c2718eeca44563561cdfede0a/src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
updated_at: 7/13/2017 7:24:10 PM
ms.date: 7/13/2017