/
_help.py
774 lines (679 loc) · 36.6 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
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
# 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['eventhubs'] = """
type: group
short-summary: Manage Azure Event Hubs namespaces, eventhubs, consumergroups and geo recovery configurations - Alias
"""
helps['eventhubs eventhub'] = """
type: group
short-summary: Manage Azure EventHubs eventhub and authorization-rule
"""
helps['eventhubs eventhub authorization-rule'] = """
type: group
short-summary: Manage Azure Service Bus Authorizationrule for Eventhub
"""
helps['eventhubs eventhub authorization-rule create'] = """
type: command
short-summary: Creates Authorizationrule for the given Eventhub
examples:
- name: Creates Authorizationrule
text: az eventhubs eventhub authorization-rule create --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myauthorule --rights Listen
"""
helps['eventhubs eventhub authorization-rule delete'] = """
type: command
short-summary: Deletes the Authorizationrule of Eventhub.
examples:
- name: Deletes the Authorizationrule of Eventhub.
text: az eventhubs eventhub authorization-rule delete --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myauthorule
"""
helps['eventhubs eventhub authorization-rule keys'] = """
type: group
short-summary: Manage Azure Authorizationrule connection strings for Eventhub
"""
helps['eventhubs eventhub authorization-rule keys list'] = """
type: command
short-summary: Shows the connection strings of Authorizationrule for the Eventhub.
examples:
- name: Shows the connection strings of Authorizationrule for the eventhub.
text: az eventhubs eventhub authorization-rule keys list --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myauthorule
"""
helps['eventhubs eventhub authorization-rule keys renew'] = """
type: command
short-summary: Regenerate the connection strings of Authorizationrule for the namespace.
examples:
- name: Regenerate the connection strings of Authorizationrule for the namespace.
text: az eventhubs eventhub authorization-rule keys renew --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myauthorule --key PrimaryKey
"""
helps['eventhubs eventhub authorization-rule list'] = """
type: command
short-summary: shows the list of Authorization-rules by Eventhub
examples:
- name: shows the list of Authorization-rules by Eventhub
text: az eventhubs eventhub authorization-rule list --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub
"""
helps['eventhubs eventhub authorization-rule show'] = """
type: command
short-summary: shows the details of Authorizationrule
examples:
- name: shows the details of Authorizationrule
text: az eventhubs eventhub authorization-rule show --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myauthorule
"""
helps['eventhubs eventhub authorization-rule update'] = """
type: command
short-summary: Updates Authorizationrule for the given Eventhub
examples:
- name: Updates Authorizationrule
text: az eventhubs eventhub authorization-rule update --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myauthorule --rights Send
"""
helps['eventhubs eventhub consumer-group'] = """
type: group
short-summary: Manage Azure Event Hubs consumergroup
"""
helps['eventhubs eventhub consumer-group create'] = """
type: command
short-summary: Creates the EventHub ConsumerGroup
examples:
- name: Create EventHub ConsumerGroup.
text: az eventhubs eventhub consumer-group create --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myconsumergroup
"""
helps['eventhubs eventhub consumer-group delete'] = """
type: command
short-summary: Deletes the ConsumerGroup
examples:
- name: Deletes the ConsumerGroup
text: az eventhubs eventhub consumer-group delete --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myconsumergroup
"""
helps['eventhubs eventhub consumer-group list'] = """
type: command
short-summary: List the ConsumerGroup by Eventhub
examples:
- name: List the ConsumerGroup by Eventhub.
text: az eventhubs eventhub consumer-group list --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub
"""
helps['eventhubs eventhub consumer-group show'] = """
type: command
short-summary: Shows the ConsumerGroup Details
examples:
- name: Shows the ConsumerGroup details.
text: az eventhubs eventhub consumer-group show --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myconsumergroup
"""
helps['eventhubs eventhub consumer-group update'] = """
type: command
short-summary: Updates the EventHub ConsumerGroup
examples:
- name: Updates a ConsumerGroup.
text: az eventhubs eventhub consumer-group update --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myconsumergroup --user-metadata MyUserMetadata
"""
helps['eventhubs eventhub create'] = """
type: command
short-summary: Creates the EventHubs Eventhub
examples:
- name: Create a new Eventhub.
text: az eventhubs eventhub create --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub --cleanup-policy Delete --partition-count 15
"""
helps['eventhubs eventhub delete'] = """
type: command
short-summary: Deletes the Eventhub
examples:
- name: Deletes the Eventhub
text: az eventhubs eventhub delete --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub
"""
helps['eventhubs eventhub list'] = """
type: command
short-summary: List the EventHub by Namespace
examples:
- name: Get the Eventhubs by Namespace.
text: az eventhubs eventhub list --resource-group myresourcegroup --namespace-name mynamespace
"""
helps['eventhubs eventhub show'] = """
type: command
short-summary: shows the Eventhub Details
examples:
- name: Shows the Eventhub details.
text: az eventhubs eventhub show --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub
"""
helps['eventhubs eventhub update'] = """
type: command
short-summary: Updates the EventHubs Eventhub
examples:
- name: Updates a new Eventhub.
text: az eventhubs eventhub update --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub --retention-time-in-hours 3 --partition-count 12
- name: Updates the EventHubs Eventhub (autogenerated)
text: az eventhubs eventhub update --name myeventhub --namespace-name mynamespace --partition-count 12 --resource-group myresourcegroup
crafted: true
- name: Updates the EventHubs Eventhub (autogenerated)
text: az eventhubs eventhub update --retention-time-in-hours 3 --name myeventhub --namespace-name mynamespace --resource-group myresourcegroup --subscription MySubscription
crafted: true
"""
helps['eventhubs georecovery-alias'] = """
type: group
short-summary: Manage Azure EventHubs Geo Recovery configuration Alias
"""
helps['eventhubs georecovery-alias authorization-rule'] = """
type: group
short-summary: Manage Azure EventHubs Authorizationrule for Geo Recovery configuration Alias
"""
helps['eventhubs georecovery-alias authorization-rule keys'] = """
type: group
short-summary: Manage Azure Event Hubs Authorizationrule connection strings for Geo Recovery configuration Alias
"""
helps['eventhubs georecovery-alias authorization-rule keys list'] = """
type: command
short-summary: Shows the keys and connection strings of Authorizationrule for the EventHubs Namespace
examples:
- name: Shows the keys and connection strings of Authorizationrule for the namespace.
text: az eventhubs georecovery-alias authorization-rule keys list --resource-group myresourcegroup --namespace-name mynamespace --name myauthorule --alias myaliasname
"""
helps['eventhubs georecovery-alias authorization-rule list'] = """
type: command
short-summary: List of Authorizationrule by EventHubs Namespace
examples:
- name: List of Authorizationrule by EventHubs Namespace
text: az eventhubs georecovery-alias authorization-rule list --resource-group myresourcegroup --namespace-name mynamespace --alias myaliasname
"""
helps['eventhubs georecovery-alias authorization-rule show'] = """
type: command
short-summary: Show properties of EventHubs Geo-Disaster Recovery Configuration Alias and Namespace Authorizationrule
examples:
- name: Show properties Authorizationrule by EventHubs Namespace
text: az eventhubs georecovery-alias authorization-rule show --resource-group myresourcegroup --namespace-name mynamespace
"""
helps['eventhubs georecovery-alias break-pair'] = """
type: command
short-summary: Disables Geo-Disaster Recovery Configuration Alias and stops replicating changes from primary to secondary namespaces
examples:
- name: Disables Geo-Disaster Recovery Configuration Alias and stops replicating changes from primary to secondary namespaces
text: az eventhubs georecovery-alias break-pair --resource-group myresourcegroup --namespace-name primarynamespace --alias myaliasname
"""
helps['eventhubs georecovery-alias delete'] = """
type: command
short-summary: Delete Geo-Disaster Recovery Configuration Alias
examples:
- name: Delete Geo-Disaster Recovery Configuration Alias
text: az eventhubs georecovery-alias delete --resource-group myresourcegroup --namespace-name secondarynamespace --alias myaliasname
"""
helps['eventhubs georecovery-alias exists'] = """
type: command
short-summary: Check the availability of Geo-Disaster Recovery Configuration Alias Name
examples:
- name: Check the availability of Geo-Disaster Recovery Configuration Alias Name
text: az eventhubs georecovery-alias exists --resource-group myresourcegroup --namespace-name primarynamespace --alias myaliasname
"""
helps['eventhubs georecovery-alias fail-over'] = """
type: command
short-summary: Invokes Geo-Disaster Recovery Configuration Alias to point to the secondary namespace
examples:
- name: Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace
text: az eventhubs georecovery-alias fail-over --resource-group myresourcegroup --namespace-name secondarynamespace --alias myaliasname
"""
helps['eventhubs georecovery-alias set'] = """
type: command
short-summary: Sets a Geo-Disaster Recovery Configuration Alias for the give Namespace
examples:
- name: Sets Geo-Disaster Recovery Configuration Alias for the give Namespace
text: az eventhubs georecovery-alias set --resource-group myresourcegroup --namespace-name primarynamespace --alias myaliasname --partner-namespace resourcearmid
- name: Sets a Geo-Disaster Recovery Configuration Alias for the give Namespace (autogenerated)
text: az eventhubs georecovery-alias set --alias myaliasname --namespace-name primarynamespace --partner-namespace resourcearmid --resource-group myresourcegroup --subscription MySubscription
crafted: true
"""
helps['eventhubs georecovery-alias show'] = """
type: command
short-summary: shows properties of Geo-Disaster Recovery Configuration Alias for Primay or Secondary Namespace
examples:
- name: Shows properties of Geo-Disaster Recovery Configuration Alias of the Primary Namespace
text: az eventhubs georecovery-alias show --resource-group myresourcegroup --namespace-name primarynamespace --alias myaliasname
- name: Shows properties of Geo-Disaster Recovery Configuration Alias of the Secondary Namespace
text: az eventhubs georecovery-alias show --resource-group myresourcegroup --namespace-name secondarynamespace --alias myaliasname
"""
helps['eventhubs namespace'] = """
type: group
short-summary: Manage Azure EventHubs namespace and Authorizationrule
"""
helps['eventhubs namespace authorization-rule'] = """
type: group
short-summary: Manage Azure EventHubs Authorizationrule for Namespace
"""
helps['eventhubs namespace authorization-rule create'] = """
type: command
short-summary: Creates Authorizationrule for the given Namespace
examples:
- name: Creates Authorizationrule
text: az eventhubs namespace authorization-rule create --resource-group myresourcegroup --namespace-name mynamespace --name myauthorule --rights Send Listen
"""
helps['eventhubs namespace authorization-rule delete'] = """
type: command
short-summary: Deletes the Authorizationrule of the namespace.
examples:
- name: Deletes the Authorizationrule of the namespace.
text: az eventhubs namespace authorization-rule delete --resource-group myresourcegroup --namespace-name mynamespace --name myauthorule
"""
helps['eventhubs namespace authorization-rule keys'] = """
type: group
short-summary: Manage Azure EventHubs Authorizationrule connection strings for Namespace
"""
helps['eventhubs namespace authorization-rule keys list'] = """
type: command
short-summary: Shows the connection strings for namespace
examples:
- name: Shows the connection strings of Authorizationrule for the namespace.
text: az eventhubs namespace authorization-rule keys list --resource-group myresourcegroup --namespace-name mynamespace --name myauthorule
"""
helps['eventhubs namespace authorization-rule keys renew'] = """
type: command
short-summary: Regenerate the connection strings of Authorizationrule for the namespace.
examples:
- name: Regenerate the connection strings of Authorizationrule for the namespace.
text: az eventhubs namespace authorization-rule keys renew --resource-group myresourcegroup --namespace-name mynamespace --name myauthorule --key PrimaryKey
"""
helps['eventhubs namespace authorization-rule list'] = """
type: command
short-summary: Shows the list of Authorizationrule by Namespace
examples:
- name: Shows the list of Authorizationrule by Namespace
text: az eventhubs namespace authorization-rule list --resource-group myresourcegroup --namespace-name mynamespace
"""
helps['eventhubs namespace authorization-rule show'] = """
type: command
short-summary: Shows the details of Authorizationrule
examples:
- name: Shows the details of Authorizationrule
text: az eventhubs namespace authorization-rule show --resource-group myresourcegroup --namespace-name mynamespace --name myauthorule
"""
helps['eventhubs namespace authorization-rule update'] = """
type: command
short-summary: Updates Authorizationrule for the given Namespace
examples:
- name: Updates Authorizationrule
text: az eventhubs namespace authorization-rule update --resource-group myresourcegroup --namespace-name mynamespace --name myauthorule --rights Send
"""
helps['eventhubs namespace create'] = """
type: command
short-summary: Creates the EventHubs Namespace
examples:
- name: Creates a new namespace.
text: az eventhubs namespace create --resource-group myresourcegroup --name mynamespace --location westus --tags tag1=value1 tag2=value2 --sku Standard --enable-auto-inflate --maximum-throughput-units 20
- name: Create a new namespace with Identity and Encryption enabled.
text: az eventhubs namespace create --resource-group myresourcegroup --name mynamespace --location westus --sku Premium --mi-user-assigned /subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName
"""
helps['eventhubs namespace delete'] = """
type: command
short-summary: Deletes the Namespaces
examples:
- name: Deletes the Namespace
text: az eventhubs namespace delete --resource-group myresourcegroup --name mynamespace
"""
helps['eventhubs namespace exists'] = """
type: command
short-summary: check for the availability of the given name for the Namespace
examples:
- name: Create a new topic.
text: az eventhubs namespace exists --name mynamespace
- name: check for the availability of the given name for the Namespace (autogenerated)
text: az eventhubs namespace exists --name mynamespace --subscription MySubscription
crafted: true
"""
helps['eventhubs namespace list'] = """
type: command
short-summary: Lists the EventHubs Namespaces
examples:
- name: List the Event Hubs Namespaces by resource group.
text: az eventhubs namespace list --resource-group myresourcegroup
"""
helps['eventhubs namespace network-rule-set'] = """
type: group
short-summary: Manage Azure eventhubs networkruleSet for namespace
"""
helps['eventhubs namespace network-rule-set ip-rule'] = """
type: group
short-summary: Manage Azure eventhubs ip-rules in networkruleSet for namespace
"""
helps['eventhubs namespace network-rule-set virtual-network-rule'] = """
type: group
short-summary: Manage Azure eventhubs subnet-rule in networkruleSet for namespace
"""
helps['eventhubs namespace network-rule-set ip-rule add'] = """
type: command
short-summary: Add a IP-Rule for network rule of namespace.
examples:
- name: add a IP rule in NetworkruleSet for a namespace
text: az eventhubs namespace network-rule-set ip-rule add --resource-group myresourcegroup --namespace-name mynamespace --ip-rule ip-address=10.0.0.0/24 action=Allow
"""
helps['eventhubs namespace network-rule-set virtual-network-rule add'] = """
type: command
short-summary: Add a Virtual-Network-Rule for network rule of namespace.
examples:
- name: add a VirtualNetwork rule in NetworkruleSet for a namespace
text: az eventhubs namespace network-rule-set virtual-network-rule add --resource-group myresourcegroup --namespace-name mynamespace --subnet id=/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.Network/virtualNetworks/{vnetname}/subnets/{subnetname} ignore-missing-endpoint=True
"""
helps['eventhubs namespace network-rule-set list'] = """
type: command
short-summary: Show properties of Network rule of the given Namespace.
examples:
- name: Show properties of Network rule of the given Namespace
text: az eventhubs namespace network-rule-set list --resource-group myresourcegroup --namespace-name mynamespace
"""
helps['eventhubs namespace network-rule-set update'] = """
type: command
short-summary: Update network rule properties of the given Namespace.
examples:
- name: Update network rule properties of the given Namespace, can be used to update public network access, trusted service and default action.
text: az eventhubs namespace network-rule-set update --resource-group myresourcegroup --namespace-name mynamespace --public-network-access Enabled
"""
helps['eventhubs namespace network-rule-set ip-rule remove'] = """
type: command
short-summary: Remove Ip-Rule from network rule of namespace
examples:
- name: remove IP rule from NetworkruleSet for a namespace
text: az eventhubs namespace network-rule-set ip-rule remove --resource-group myresourcegroup --namespace-name mynamespace --ip-rule ip-address=10.0.0.0/24
"""
helps['eventhubs namespace network-rule-set virtual-network-rule remove'] = """
type: command
short-summary: Remove network rule for a namespace
examples:
- name: remove VirtualNetwork rule from NetworkruleSet of namespace
text: az eventhubs namespace network-rule-set virtual-network-rule remove --resource-group myresourcegroup --namespace-name mynamespace --subnet id=/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.Network/virtualNetworks/{vnetname}/subnets/{subnetname}
"""
helps['eventhubs namespace show'] = """
type: command
short-summary: shows the Event Hubs Namespace Details
examples:
- name: shows the Namespace details.
text: az eventhubs namespace show --resource-group myresourcegroup --name mynamespace
"""
helps['eventhubs namespace update'] = """
type: command
short-summary: Updates the EventHubs Namespace
examples:
- name: Update a new namespace.
text: az eventhubs namespace update --resource-group myresourcegroup --name mynamespace --tags tag=value --enable-auto-inflate True
"""
helps['eventhubs cluster'] = """
type: group
short-summary: Manage Azure EventHubs Clusters
"""
helps['eventhubs cluster create'] = """
type: command
short-summary: Create EventHubs Cluster
examples:
- name: Create a new cluster.
text: az eventhubs cluster create --resource-group myresourcegroup --name mycluster --location mylocation --capacity 1 --tags tag=value
"""
helps['eventhubs cluster update'] = """
type: command
short-summary: Update tags of EventHubs Cluster
examples:
- name: Update tags of a existing cluster.
text: az eventhubs cluster update --resource-group myresourcegroup --name mycluster --tags tag=value
"""
helps['eventhubs cluster available-region'] = """
type: command
short-summary: List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
examples:
- name: List of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
text: az eventhubs cluster available-region
"""
helps['eventhubs cluster show'] = """
type: command
short-summary: Get the resource description of the specified Event Hubs Cluster.
examples:
- name: Get the resource description of the specified Event Hubs Cluster.
text: az eventhubs cluster show --resource-group myresourcegroup --name mycluster
"""
helps['eventhubs cluster delete'] = """
type: command
short-summary: Delete an existing Event Hubs Cluster.
examples:
- name: Delete an existing Event Hubs Cluster.
text: az eventhubs cluster delete --resource-group myresourcegroup --name mycluster
"""
helps['eventhubs cluster list'] = """
type: command
short-summary: List the available Event Hubs Clusters within an ARM resource group.
examples:
- name: List the available Event Hubs Clusters within an ARM resource group.
text: az eventhubs cluster list --resource-group myresourcegroup
"""
helps['eventhubs cluster namespace'] = """
type: group
short-summary: Manage Azure EventHubs Cluster for namespace
"""
helps['eventhubs cluster namespace list'] = """
type: command
short-summary: List of Namespaces within given Cluster.
examples:
- name: List of Namespaces within given Cluster.
text: az eventhubs cluster namespace list --resource-group myresourcegroup --name mycluster
"""
helps['eventhubs cluster wait'] = """
type: command
short-summary: Place the CLI in a waiting state until a condition of the Cluster operation is completed.
"""
helps['eventhubs namespace private-endpoint-connection'] = """
type: group
short-summary: Manage eventhubs namespace private endpoint connection.
"""
helps['eventhubs namespace private-endpoint-connection approve'] = """
type: command
short-summary: Approve a private endpoint connection request for eventhubs namesapce.
examples:
- name: Approve a private endpoint connection request for eventhubs namespace by ID.
text: |
az eventhubs namespace private-endpoint-connection approve --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Eventhub/namesapces/mynamepsace/privateEndpointConnections/mynamespace.b56b5a95-0588-4f8b-b348-15db61590a6c"
- name: Approve a private endpoint connection request for eventhubs namespace by ID.
text: |
id = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].id")
az eventhubs namespace private-endpoint-connection approve --id $id
- name: Approve a private endpoint connection request for eventhubs namespace using namespace name and connection name.
text: |
az eventhubs namespace private-endpoint-connection approve -g myRg --namespace-name mynamespace --name myconnection
- name: Approve a private endpoint connection request for eventhubs namespace using namespace name and connection name.
text: |
name = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].name")
az eventhubs namespace private-endpoint-connection approve -g myRg --namespace-name mynamespace --name $name
"""
helps['eventhubs namespace private-endpoint-connection delete'] = """
type: command
short-summary: Delete a private endpoint connection request for eventhubs namespace.
examples:
- name: Delete a private endpoint connection request for eventhubs namespace by ID.
text: |
az eventhubs namespace private-endpoint-connection delete --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.EventHub/namespaces/mynamespace/privateEndpointConnections/mynamespace.b56b5a95-0588-4f8b-b348-15db61590a6c"
- name: Delete a private endpoint connection request for eventhubs namespace by ID.
text: |
id = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].id")
az eventhubs namespace private-endpoint-connection delete --id $id
- name: Delete a private endpoint connection request for eventhubs namespace using account name and connection name.
text: |
az eventhubs namespace private-endpoint-connection delete -g myRg --namespace-name mynamespace --name myconnection
- name: Delete a private endpoint connection request for eventhubs namespace using namespace name and connection name.
text: |
name = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].name")
az eventhubs namespace private-endpoint-connection delete -g myRg --namespace-name mynamespace --name $name
"""
helps['eventhubs namespace private-endpoint-connection reject'] = """
type: command
short-summary: Reject a private endpoint connection request for eventhubs namespace.
examples:
- name: Reject a private endpoint connection request for eventhubs namespace by ID.
text: |
az eventhubs namespace private-endpoint-connection reject --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.EventHub/namespaces/mynamespace/privateEndpointConnections/mynamespace.b56b5a95-0588-4f8b-b348-15db61590a6c"
- name: Reject a private endpoint connection request for eventhubs namespace by ID.
text: |
id = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].id")
az eventhubs namespace private-endpoint-connection reject --id $id
- name: Reject a private endpoint connection request for eventhubs namespace using namespace name and connection name.
text: |
az eventhubs namespace private-endpoint-connection reject -g myRg --namespace-name mynamespace --name myconnection
- name: Reject a private endpoint connection request for eventhubs namespace using namespace name and connection name.
text: |
name = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].name")
az eventhubs namespace private-endpoint-connection reject -g myRg --namespace-name mynamespace --name $name
"""
helps['eventhubs namespace private-endpoint-connection show'] = """
type: command
short-summary: Show details of a private endpoint connection request for eventhubs namespace.
examples:
- name: Show details of a private endpoint connection request for eventhubs namespace by ID.
text: |
az eventhubs namespace private-endpoint-connection show --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.EventHub/namespaces/mynamespace/privateEndpointConnections/mynamespace.b56b5a95-0588-4f8b-b348-15db61590a6c"
- name: Show details of a private endpoint connection request for eventhubs namespace by ID.
text: |
id = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].id")
az eventhubs namespace private-endpoint-connection show --id $id
- name: Show details of a private endpoint connection request for eventhubs namespace using namespace name and connection name.
text: |
az eventhubs namespace private-endpoint-connection show -g myRg --namespace-name mynamespace --name myconnection
- name: Show details of a private endpoint connection request for eventhubs namespace using namespace name and connection name.
text: |
name = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].name")
az eventhubs namespace private-endpoint-connection show -g myRg --namespace-name mynamespace --name $name
"""
helps['eventhubs namespace private-link-resource'] = """
type: group
short-summary: Manage eventhubs namespace private link resources.
"""
helps['eventhubs namespace private-link-resource show'] = """
type: command
short-summary: Get the private link resources that need to be created for a eventhubs namespace.
examples:
- name: Get the private link resources that need to be created for a eventhubs namespace.
text: |
az eventhubs namespace private-link-resource show --namespace-name mynamespace -g MyResourceGroup
"""
helps['eventhubs namespace encryption'] = """
type: group
short-summary: Manage eventhubs namespace encryption properties.
"""
helps['eventhubs namespace encryption add'] = """
type: command
short-summary: Add Encryption properties to a namespace.
examples:
- name: Set 2 different encryption properties for a namespace that has User Assigned Identity already enabled
text: |
az eventhubs namespace encryption add --namespace-name mynamespace -g MyResourceGroup --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName2
"""
helps['eventhubs namespace encryption remove'] = """
type: command
short-summary: Remove one or more Encryption properties from a namespace.
examples:
- name: Remove encryption properties for a namespace that has User Assigned Identity already enabled
text: |
az eventhubs namespace encryption remove --namespace-name mynamespace -g MyResourceGroup --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName
"""
helps['eventhubs namespace identity'] = """
type: group
short-summary: Manage eventhubs namespace identity.
"""
helps['eventhubs namespace identity assign'] = """
type: command
short-summary: Assign System or User or System,User assigned identities to a namespace
examples:
- name: Assign system assigned and user assigned identity to a namespace. (give a list of identity id's for --user-assigned)
text: |
az eventhubs namespace identity assign --namespace-name mynamespace -g MyResourceGroup --system-assigned --user-assigned /subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName /subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName2
"""
helps['eventhubs namespace identity remove'] = """
type: command
short-summary: Remove System or User or System,User assigned identities from a namespace
examples:
- name: Remove system assigned and a user assigned identity from a namespace. (give a list of identity id's for --user-assigned)
text: |
az eventhubs namespace identity remove --namespace-name mynamespace -g MyResourceGroup --system-assigned --user-assigned /subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName
"""
helps['eventhubs namespace schema-registry'] = """
type: group
short-summary: Manages eventhubs namespace schema registry.
"""
helps['eventhubs namespace schema-registry create'] = """
type: command
short-summary: Creates a schema group for an EventHub namespace
examples:
- name: Create a schema group mySchemaGroup for eventhub namespace mynamespace
text: |
az eventhubs namespace schema-registry create --namespace-name mynamespace -g MyResourceGroup --name mySchemaGroup --schema-compatibility Forward --schema-type Avro --group-properties k1=v1 k2=v2
"""
helps['eventhubs namespace schema-registry list'] = """
type: command
short-summary: Lists all schema groups of the EventHub Namespace
examples:
- name: List all schema groups within eventhub namespace mynamespace.
text: |
az eventhubs namespace schema-registry list --namespace-name mynamespace -g MyResourceGroup
"""
helps['eventhubs namespace schema-registry show'] = """
type: command
short-summary: Get a specific schema group from an EventHub namespace.
examples:
- name: Get mySchemaGroup from namespace mynamespace
text: |
az eventhubs namespace schema-registry show --namespace-name mynamespace -g MyResourceGroup --name mySchemaGroup
"""
helps['eventhubs namespace schema-registry delete'] = """
type: command
short-summary: Deletes a schema group from a namespace
examples:
- name: Deletes a schema group mySchemaGroup from a namespace
text: |
az eventhubs namespace schema-registry delete --namespace-name mynamespace -g MyResourceGroup --name mySchemaGroup
"""
helps['eventhubs namespace application-group'] = """
type: group
short-summary: Manages Application Groups for premium eventhubs namespace.
"""
helps['eventhubs namespace application-group policy'] = """
type: group
short-summary: Append or Remove application group policies.
"""
helps['eventhubs namespace application-group create'] = """
type: command
short-summary: Creates an application group for an EventHub namespace
examples:
- name: Create an application group myAppGroup for eventhub namespace mynamespace with 2 throttling policies. Maximum allowed throttling policies is 4.
text: |
az eventhubs namespace application-group create --namespace-name mynamespace -g MyResourceGroup --name myAppGroup --client-app-group-identifier NamespaceSASKeyName=keyname --throttling-policy-config name=policy1 metric-id=IncomingMessages rate-limit-threshold=10000 --throttling-policy-config name=policy2 metric-id=IncomingBytes rate-limit-threshold=20000
"""
helps['eventhubs namespace application-group update'] = """
type: command
short-summary: Updates an application group in an EventHub namespace
examples:
- name: Updates an application group myAppGroup for eventhub namespace mynamespace.
text: |
az eventhubs namespace application-group update --namespace-name mynamespace -g MyResourceGroup --name myAppGroup --is-enabled false
"""
helps['eventhubs namespace application-group show'] = """
type: command
short-summary: Gets an application group in an EventHub namespace
examples:
- name: Gets an application group myAppGroup for eventhub namespace mynamespace.
text: |
az eventhubs namespace application-group show --namespace-name mynamespace -g MyResourceGroup --name myAppGroup
"""
helps['eventhubs namespace application-group list'] = """
type: command
short-summary: Lists all application groups in an EventHub namespace
examples:
- name: Lists all application groups in eventhub namespace mynamespace.
text: |
az eventhubs namespace application-group list --namespace-name mynamespace -g MyResourceGroup
"""
helps['eventhubs namespace application-group policy add'] = """
type: command
short-summary: Appends an application group policy to the existing policy. This cmdlet can be used to append one or more throttling policies.
examples:
- name: Append 2 throttling policies to an application group. Maximum allowed throttling policies is 4.
text: |
az eventhubs namespace application-group policy add --namespace-name mynamespace -g MyResourceGroup --name myAppGroup --throttling-policy-config name=policy1 metric-id=OutgoingMessages rate-limit-threshold=10500 --throttling-policy-config name=policy2 metric-id=IncomingBytes rate-limit-threshold=20000
"""
helps['eventhubs namespace application-group policy remove'] = """
type: command
short-summary: Removes an application group policy from the existing policies. This cmdlet can be used to remove one or more throttling policies.
examples:
- name: Removes a throttling policy from an application group myAppGroup.
text: |
az eventhubs namespace application-group policy remove --namespace-name mynamespace -g MyResourceGroup --name myAppGroup --policy name=policy1
"""