-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Expand file tree
/
Copy path_help.py
More file actions
3063 lines (2817 loc) · 151 KB
/
Copy path_help.py
File metadata and controls
3063 lines (2817 loc) · 151 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
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# 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['account lock'] = """
type: group
short-summary: Manage Azure subscription level locks.
"""
helps['account lock create'] = """
type: command
short-summary: Create a subscription lock.
examples:
- name: Create a read-only subscription level lock.
text: >
az account lock create --lock-type ReadOnly -n lockName
"""
helps['account lock delete'] = """
type: command
short-summary: Delete a subscription lock.
examples:
- name: Delete a subscription lock
text: >
az account lock delete --name lockName
"""
helps['account lock list'] = """
type: command
short-summary: List lock information in the subscription.
examples:
- name: List out all locks on the subscription level
text: >
az account lock list
"""
helps['account lock show'] = """
type: command
short-summary: Show the details of a subscription lock
examples:
- name: Show a subscription level lock
text: >
az account lock show -n lockname
"""
helps['account lock update'] = """
type: command
short-summary: Update a subscription lock.
examples:
- name: Update a subscription lock with new notes and type
text: >
az account lock update --name lockName --notes newNotesHere --lock-type CanNotDelete
"""
helps['account management-group'] = """
type: group
short-summary: Manage Azure Management Groups.
"""
helps['account management-group tenant-backfill'] = """
type: group
short-summary: Backfill Tenant Subscription Operations for Management Groups
"""
helps['account management-group tenant-backfill get'] = """
type: command
short-summary: Get the backfill status for a tenant.
examples:
- name: Get the backfill status for a tenant.
text: >
az account management-group tenant-backfill get
"""
helps['account management-group tenant-backfill start'] = """
type: command
short-summary: Start backfilling subscriptions for a tenant.
examples:
- name: Start backfilling subscriptions for a tenant.
text: >
az account management-group tenant-backfill start
"""
helps['account management-group check-name-availability'] = """
type: command
short-summary: Check if a Management Group Name is Valid.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
examples:
- name: Check if a Management Group Name is Valid.
text: >
az account management-group check-name-availability --name GroupName
"""
helps['account management-group create'] = """
type: command
short-summary: Create a new management group.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
- name: --display-name -d
type: string
short-summary: Sets the display name of the management group. If null, the group name is set as the display name.
- name: --parent -p
type: string
short-summary: Sets the parent of the management group. Can be the fully qualified id or the name of the management group. If null, the root tenant group is set as the parent.
examples:
- name: Create a new management group.
text: >
az account management-group create --name GroupName
- name: Create a new management group with a specific display name.
text: >
az account management-group create --name GroupName --display-name DisplayName
- name: Create a new management group with a specific parent.
text: >
az account management-group create --name GroupName --parent ParentId/ParentName
- name: Create a new management group with a specific display name and parent.
text: >
az account management-group create --name GroupName --display-name DisplayName --parent ParentId/ParentName
"""
helps['account management-group delete'] = """
type: command
short-summary: Delete an existing management group.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
examples:
- name: Delete an existing management group
text: >
az account management-group delete --name GroupName
"""
helps['account management-group list'] = """
type: command
short-summary: List all management groups in the current tenant.
examples:
- name: List all management groups
text: >
az account management-group list
"""
helps['account management-group show'] = """
type: command
short-summary: Get the details of the management group.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group (the last segment of the resource ID). Do not use display name.
- name: --expand -e
type: bool
short-summary: If given, lists the children in the first level of hierarchy.
- name: --recurse -r
type: bool
short-summary: If given, lists the children in all levels of hierarchy.
examples:
- name: Get a management group.
text: >
az account management-group show --name GroupName
- name: Get a management group with children in the first level of hierarchy.
text: >
az account management-group show --name GroupName -e
- name: Get a management group with children in all levels of hierarchy.
text: >
az account management-group show --name GroupName -e -r
"""
helps['account management-group subscription'] = """
type: group
short-summary: Subscription operations for Management Groups.
"""
helps['account management-group subscription add'] = """
type: command
short-summary: Add a subscription to a management group.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
- name: --subscription -s
type: string
short-summary: Subscription Id or Name
examples:
- name: Add a subscription to a management group.
text: >
az account management-group subscription add --name GroupName --subscription Subscription
"""
helps['account management-group subscription show'] = """
type: command
short-summary: Show the details of a subscription under a known management group.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
- name: --subscription -s
type: string
short-summary: Subscription Id or Name
examples:
- name: Show the details of a subscription under a known management group.
text: >
az account management-group subscription show --name GroupName --subscription Subscription
"""
helps['account management-group subscription show-sub-under-mg'] = """
type: command
short-summary: Get the subscription under a management group.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
examples:
- name: Get the subscription under a management group.
text: >
az account management-group subscription show-sub-under-mg --name GroupName
"""
helps['account management-group entities'] = """
type: group
short-summary: Entity operations (Management Group and Subscriptions) for Management Groups.
"""
helps['account management-group entities list'] = """
type: command
short-summary: List all entities for the authenticated user.
examples:
- name: List all entities for the authenticated user.
text: >
az account management-group entities list
"""
helps['account management-group subscription remove'] = """
type: command
short-summary: Remove an existing subscription from a management group.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
- name: --subscription -s
type: string
short-summary: Subscription Id or Name
examples:
- name: Remove an existing subscription from a management group.
text: >
az account management-group subscription remove --name GroupName --subscription Subscription
"""
helps['account management-group update'] = """
type: command
short-summary: Update an existing management group.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
- name: --display-name -d
type: string
short-summary: Updates the display name of the management group. If null, no change is made.
- name: --parent -p
type: string
short-summary: Update the parent of the management group. Can be the fully qualified id or the name of the management group. If null, no change is made.
examples:
- name: Update an existing management group with a specific display name.
text: >
az account management-group update --name GroupName --display-name DisplayName
- name: Update an existing management group with a specific parent.
text: >
az account management-group update --name GroupName --parent ParentId/ParentName
- name: Update an existing management group with a specific display name and parent.
text: >
az account management-group update --name GroupName --display-name DisplayName --parent ParentId/ParentName
"""
helps['account management-group hierarchy-settings'] = """
type: group
short-summary: Provide operations for hierarchy settings defined at the management group level. Settings can only be set on the root Management Group of the hierarchy.
"""
helps['account management-group hierarchy-settings create'] = """
type: command
short-summary: Create hierarchy settings defined at the Management Group level.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
- name: --default-management-group -m
type: string
short-summary: Set the default Management Group under which new subscriptions get added in this tenant. Default setting is the Root Management Group.
- name: --require-authorization-for-group-creation -r
type: boolean
short-summary: Indicate whether RBAC access is required upon group creation under the root Management Group. True means user will require Microsoft.Management/managementGroups/write action on the root Management Group. Default setting is false.
examples:
- name: Create hierarchy settings defined at the Management Group level.
text: >
az account management-group hierarchy-settings create --name GroupName
- name: Set the default Management Group new Subscriptions get placed under.
text: >
az account management-group hierarchy-settings create --name GroupName -m /providers/Microsoft.Management/managementGroups/DefaultGroup
- name: Require user to have Microsoft.Management/managementGroups/write access on the Root to create new Management Groups under the Root.
text: >
az account management-group hierarchy-settings create --name GroupName -r True
- name: Update both hierarchy settings.
text: >
az account management-group hierarchy-settings create --name GroupName -m /providers/Microsoft.Management/managementGroups/DefaultGroup -r True
"""
helps['account management-group hierarchy-settings list'] = """
type: command
short-summary: Get all the hierarchy settings defined at the Management Group level.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
examples:
- name: Get all hierarchy settings defined at the Management Group level.
text: >
az account management-group hierarchy-settings list --name GroupName
"""
helps['account management-group hierarchy-settings delete'] = """
type: command
short-summary: Delete the hierarchy settings defined at the Management Group level.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
examples:
- name: Delete all hierarchy settings defined at the Management Group level.
text: >
az account management-group hierarchy-settings delete --name GroupName
"""
helps['account management-group hierarchy-settings update'] = """
type: command
short-summary: Update the hierarchy settings defined at the Management Group level.
parameters:
- name: --name -n
type: string
short-summary: Name of the management group.
- name: --default-management-group -m
type: string
short-summary: Set the default Management Group under which new subscriptions get added in this tenant. Default setting is the Root Management Group.
- name: --require-authorization-for-group-creation -r
type: boolean
short-summary: Indicate whether RBAC access is required upon group creation under the root Management Group. True means user will require Microsoft.Management/managementGroups/write action on the root Management Group. Default setting is false.
examples:
- name: Create hierarchy settings defined at the Management Group level.
text: >
az account management-group hierarchy-settings update --name GroupName
- name: Set the default Management Group new Subscriptions get placed under.
text: >
az account management-group hierarchy-settings update --name GroupName -m /providers/Microsoft.Management/managementGroups/DefaultGroup
- name: Require user to have Microsoft.Management/managementGroups/write access on the Root to create new Management Groups under the Root.
text: >
az account management-group hierarchy-settings update --name GroupName -r True
- name: Update both hierarchy settings.
text: >
az account management-group hierarchy-settings update --name GroupName -m /providers/Microsoft.Management/managementGroups/DefaultGroup -r True
"""
helps['deployment'] = """
type: group
short-summary: Manage Azure Resource Manager template deployment at subscription scope.
"""
helps['deployment list'] = """
type: command
short-summary: List deployments at subscription scope.
examples:
- name: List deployments at subscription scope.
text: az deployment list
"""
helps['deployment show'] = """
type: command
short-summary: Show a deployment at subscription scope.
examples:
- name: Show a deployment at subscription scope.
text: az deployment show -n deployment01
"""
helps['deployment delete'] = """
type: command
short-summary: Delete a deployment at subscription scope.
examples:
- name: Delete a deployment at subscription scope.
text: az deployment delete -n deployment01
"""
helps['deployment cancel'] = """
type: command
short-summary: Cancel a deployment at subscription scope.
examples:
- name: Cancel a deployment at subscription scope.
text: az deployment cancel -n deployment01
"""
helps['deployment validate'] = """
type: command
short-summary: Validate whether a template is valid at subscription scope.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --location -l
short-summary: The location to store the deployment metadata.
- name: --name -n
short-summary: The deployment name.
examples:
- name: Validate whether a template is valid at subscription scope.
text: |
az deployment validate --location westus2 --parameters MyValue=This MyArray=@array.json --template-file azuredeploy.json
"""
helps['deployment create'] = """
type: command
short-summary: Start a deployment at subscription scope.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --location -l
short-summary: The location to store the deployment metadata.
- name: --name -n
short-summary: The deployment name.
- name: --what-if-result-format -r
short-summary: The format of What-If results. Applicable when `--confirm-with-what-if` is set.
examples:
- name: Create a deployment at subscription scope from a remote template file, using parameters from a local JSON file.
text: >
az deployment create --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json
- name: Create a deployment at subscription scope from a local template file, using parameters from a JSON string.
text: |
az deployment create --location WestUS --template-file azuredeploy.json \\
--parameters "{ \\"policyName\\": { \\"value\\": \\"policy2\\" }}"
- name: Create a deployment at subscription scope from a local template, using a parameter file, a remote parameter file, and selectively overriding key/value pairs.
text: >
az deployment create --location WestUS --template-file azuredeploy.json \\
--parameters @params.json --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json
- name: Create a deployment at subscription scope from a template-spec
text: >
az deployment create --location WestUS --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0"
"""
helps['deployment export'] = """
type: command
short-summary: Export the template used for a deployment.
examples:
- name: Export the template used for a deployment at subscription scope.
text: |
az deployment export --name MyDeployment
"""
helps['deployment wait'] = """
type: command
short-summary: Place the CLI in a waiting state until a deployment condition is met.
examples:
- name: Place the CLI in a waiting state until a deployment condition is met. (autogenerated)
text: |
az deployment wait --deleted --name MyDeployment --subscription MySubscription
crafted: true
"""
helps['deployment operation'] = """
type: group
short-summary: Manage deployment operations at subscription scope.
"""
helps['deployment operation list'] = """
type: command
short-summary: List deployment operations at subscription scope.
examples:
- name: List deployment operations at subscription scope. (autogenerated)
text: |
az deployment operation list --name MyDeployment
crafted: true
"""
helps['deployment operation show'] = """
type: command
short-summary: Show a deployment operation at subscription scope.
"""
helps['deployment sub'] = """
type: group
short-summary: Manage Azure Resource Manager template deployment at subscription scope.
"""
helps['deployment sub list'] = """
type: command
short-summary: List deployments at subscription scope.
examples:
- name: List deployments at subscription scope.
text: az deployment sub list
"""
helps['deployment sub show'] = """
type: command
short-summary: Show a deployment at subscription scope.
examples:
- name: Show a deployment at subscription scope.
text: az deployment sub show -n deployment01
"""
helps['deployment sub delete'] = """
type: command
short-summary: Delete a deployment at subscription scope.
examples:
- name: Delete a deployment at subscription scope.
text: az deployment sub delete -n deployment01
"""
helps['deployment sub cancel'] = """
type: command
short-summary: Cancel a deployment at subscription scope.
examples:
- name: Cancel a deployment at subscription scope.
text: az deployment sub cancel -n deployment01
"""
helps['deployment sub validate'] = """
type: command
short-summary: Validate whether a template is valid at subscription scope.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --location -l
short-summary: The location to store the deployment metadata.
- name: --name -n
short-summary: The deployment name.
examples:
- name: Validate whether a template is valid at subscription scope.
text: az deployment sub validate --location westus2 --template-file {template-file}
- name: Validate whether a template is valid at subscription scope. (autogenerated)
text: |
az deployment sub validate --location westus2 --parameters MyValue=This MyArray=@array.json --template-file azuredeploy.json
crafted: true
"""
helps['deployment sub create'] = """
type: command
short-summary: Start a deployment at subscription scope.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --location -l
short-summary: The location to store the deployment metadata.
- name: --name -n
short-summary: The deployment name.
- name: --what-if-result-format -r
short-summary: The format of What-If results. Applicable when `--confirm-with-what-if` is set.
examples:
- name: Create a deployment at subscription scope from a remote template file, using parameters from a local JSON file.
text: >
az deployment sub create --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json
- name: Create a deployment at subscription scope from a local template file, using parameters from a JSON string.
text: |
az deployment sub create --location WestUS --template-file azuredeploy.json \\
--parameters '{ \\"policyName\\": { \\"value\\": \\"policy2\\" } }'
- name: Create a deployment at subscription scope from a local template, using a parameter file, a remote parameter file, and selectively overriding key/value pairs.
text: >
az deployment sub create --location WestUS --template-file azuredeploy.json \\
--parameters @params.json --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json
"""
helps['deployment sub what-if'] = """
type: command
short-summary: Execute a deployment What-If operation at subscription scope.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --location -l
short-summary: The location to store the deployment What-If operation metadata.
- name: --name -n
short-summary: The deployment name.
- name: --result-format -r
short-summary: The format of What-If results.
examples:
- name: Execute a deployment What-If operation at a subscription.
text: >
az deployment sub what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json
- name: Execute a deployment What-If operation at a subscription with ResourceIdOnly format.
text: >
az deployment sub what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly
- name: Execute a deployment What-If operation at a subscription without pretty-printing the result.
text: >
az deployment sub what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print
"""
helps['deployment sub export'] = """
type: command
short-summary: Export the template used for a deployment.
examples:
- name: Export the template used for a deployment at subscription scope.
text: az deployment sub export --name MyDeployment
"""
helps['deployment sub wait'] = """
type: command
short-summary: Place the CLI in a waiting state until a deployment condition is met.
examples:
- name: Place the CLI in a waiting state until a deployment condition is met. (autogenerated)
text: |
az deployment sub wait --created --name MyDeployment
crafted: true
"""
helps['deployment operation sub'] = """
type: group
short-summary: Manage deployment operations at subscription scope.
"""
helps['deployment operation sub list'] = """
type: command
short-summary: List deployment operations at subscription scope.
examples:
- name: List deployment operations at subscription scope. (autogenerated)
text: |
az deployment operation sub list --name mydeployment
crafted: true
"""
helps['deployment operation sub show'] = """
type: command
short-summary: Show a deployment operation at subscription scope.
"""
helps['deployment group'] = """
type: group
short-summary: Manage Azure Resource Manager template deployment at resource group.
"""
helps['deployment group list'] = """
type: command
short-summary: List deployments at resource group.
examples:
- name: List deployments at resource group.
text: az deployment group list -g testrg
"""
helps['deployment group show'] = """
type: command
short-summary: Show a deployment at resource group.
examples:
- name: Show a deployment at resource group.
text: az deployment group show -g testrg -n deployment01
"""
helps['deployment group delete'] = """
type: command
short-summary: Delete a deployment at resource group.
examples:
- name: Delete a deployment at resource group.
text: az deployment group delete -g testrg -n deployment01
"""
helps['deployment group cancel'] = """
type: command
short-summary: Cancel a deployment at resource group.
examples:
- name: Cancel a deployment at resource group.
text: az deployment group cancel -g testrg -n deployment01
"""
helps['deployment group validate'] = """
type: command
short-summary: Validate whether a template is valid at resource group.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --resource-group -g
short-summary: The resource group to create deployment at.
- name: --name -n
short-summary: The deployment name.
- name: --mode
short-summary: The deployment mode.
examples:
- name: Validate whether a template is valid at resource group.
text: az deployment group validate --resource-group testrg --template-file {template-file}
- name: Validate whether a template is valid at resource group. (autogenerated)
text: |
az deployment group validate --parameters MyValue=This MyArray=@array.json --resource-group testrg --template-file azuredeploy.json
crafted: true
"""
helps['deployment group create'] = """
type: command
short-summary: Start a deployment at resource group.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax. Also note if you are providing a bicepparam file then you can use this argument only once.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --resource-group -g
short-summary: The resource group to create deployment at.
- name: --name -n
short-summary: The deployment name.
- name: --mode
short-summary: The deployment mode.
- name: --what-if-result-format -r
short-summary: The format of What-If results. Applicable when `--confirm-with-what-if` is set.
examples:
- name: Create a deployment at resource group from a remote template file, using parameters from a local JSON file.
text: >
az deployment group create --resource-group testrg --name rollout01 \\
--template-uri https://myresource/azuredeploy.json --parameters @myparameters.json
- name: Create a deployment at resource group from a local template file, using parameters from a JSON string.
text: |
az deployment group create --resource-group testrg --name rollout01 \\
--template-file azuredeploy.json \\
--parameters '{ \\"policyName\\": { \\"value\\": \\"policy2\\" } }'
- name: Create a deployment at resource group from a local template file, using parameters from an array string.
text: |
az deployment group create --resource-group testgroup --template-file demotemplate.json --parameters exampleString='inline string' exampleArray='("value1", "value2")'
- name: Create a deployment at resource group from a local template, using a parameter file, a remote parameter file, and selectively overriding key/value pairs.
text: >
az deployment group create --resource-group testrg --name rollout01 \\
--template-file azuredeploy.json --parameters @params.json \\
--parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json
- name: Create a deployment at resource group scope from a template-spec
text: >
az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0"
- name: Create a deployment at resource group scope from a bicepparam parameter file
text: >
az deployment group create --resource-group testrg --parameters parameters.bicepparam
- name: Create a deployment at resource group across tenants
text: >
az deployment group create --resource-group testrg --name rollout01 \\
--template-file azuredeploy.json --parameters @myparameters.json --aux-tenants auxiliary_tenant01 auxiliary_tenant02
"""
helps['deployment group what-if'] = """
type: command
short-summary: Execute a deployment What-If operation at resource group scope.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --resource-group -g
short-summary: The resource group to execute deployment What-If operation at.
- name: --name -n
short-summary: The deployment name.
- name: --mode
short-summary: The deployment mode.
- name: --result-format -r
short-summary: The format of What-If results.
examples:
- name: Execute a deployment What-If operation at a resource group.
text: >
az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json
- name: Execute a deployment What-If operation at a resource group with ResourceIdOnly format.
text: >
az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly
- name: Execute a deployment What-If operation at a resource group without pretty-printing the result.
text: >
az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print
"""
helps['deployment group export'] = """
type: command
short-summary: Export the template used for a deployment.
examples:
- name: Export the template used for a deployment at resource group.
text: az deployment group export --resource-group testrg --name MyDeployment
"""
helps['deployment group wait'] = """
type: command
short-summary: Place the CLI in a waiting state until a deployment condition is met.
examples:
- name: Place the CLI in a waiting state until a deployment condition is met. (autogenerated)
text: |
az deployment group wait --created --name MyDeployment --resource-group MyResourceGroup
crafted: true
"""
helps['deployment operation group'] = """
type: group
short-summary: Manage deployment operations at resource group.
"""
helps['deployment operation group list'] = """
type: command
short-summary: List deployment operations at resource group.
examples:
- name: List deployment operations at resource group (autogenerated)
text: |
az deployment operation group list --name MyDeployment --resource-group MyResourceGroup
crafted: true
"""
helps['deployment operation group show'] = """
type: command
short-summary: Show a deployment operation at resource group.
"""
helps['deployment mg'] = """
type: group
short-summary: Manage Azure Resource Manager template deployment at management group.
"""
helps['deployment mg list'] = """
type: command
short-summary: List deployments at management group.
examples:
- name: List deployments at management group.
text: az deployment mg list -m testmg
"""
helps['deployment mg show'] = """
type: command
short-summary: Show a deployment at management group.
examples:
- name: Show a deployment at management group.
text: az deployment mg show -m testmg -n deployment01
"""
helps['deployment mg delete'] = """
type: command
short-summary: Delete a deployment at management group.
examples:
- name: Delete a deployment at management group.
text: az deployment mg delete -m testmg -n deployment01
"""
helps['deployment mg cancel'] = """
type: command
short-summary: Cancel a deployment at management group.
examples:
- name: Cancel a deployment at management group.
text: az deployment mg cancel -m testmg -n deployment01
"""
helps['deployment mg validate'] = """
type: command
short-summary: Validate whether a template is valid at management group.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --management-group-id -m
short-summary: The management group id to create deployment at.
- name: --name -n
short-summary: The deployment name.
- name: --location -l
short-summary: The location to store the deployment metadata.
examples:
- name: Validate whether a template is valid at management group.
text: az deployment mg validate --management-group-id testmg --location WestUS --template-file {template-file}
- name: Validate whether a template is valid at management group. (autogenerated)
text: |
az deployment mg validate --location WestUS --management-group-id testmg --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json
crafted: true
"""
helps['deployment mg what-if'] = """
type: command
short-summary: Execute a deployment What-If operation at management group scope.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --management-group-id -m
short-summary: The management group id to create deployment at.
- name: --name -n
short-summary: The deployment name.
- name: --location -l
short-summary: The location to store the deployment metadata.
- name: --result-format -r
short-summary: The format of What-If results.
examples:
- name: Execute a deployment What-If operation at a management group.
text: >
az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json
- name: Execute a deployment What-If operation at a management group with ResourceIdOnly format.
text: >
az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly
- name: Execute a deployment What-If operation at a management group without pretty-printing the result.
text: >
az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print
"""
helps['deployment mg create'] = """
type: command
short-summary: Start a deployment at management group.
long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template.
parameters:
- name: --parameters -p
short-summary: Supply deployment parameter values.
long-summary: >
Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as `<KEY=VALUE>` pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used.
It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax.
- name: --template-file -f
short-summary: The path to the template file or Bicep file.
- name: --template-uri -u
short-summary: The URI to the template file.
- name: --template-spec -s
short-summary: The template spec resource id.
- name: --management-group-id -m