/
_help.py
2332 lines (2189 loc) · 143 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
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['eventgrid'] = """
type: group
short-summary: Manage Azure Event Grid topics, domains, domain topics, system topics partner topics, event subscriptions, system topic event subscriptions and partner topic event subscriptions.
"""
helps['eventgrid domain'] = """
type: group
short-summary: Manage event domains.
"""
helps['eventgrid domain create'] = """
type: command
short-summary: Create a domain.
parameters:
- name: --inbound-ip-rules
short-summary: List of inbound IP rules.
long-summary: |
List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
examples:
- name: Create a new domain.
text: az eventgrid domain create -g rg1 --name domain1 -l westus2
- name: Create a new domain with custom input mappings.
text: az eventgrid domain create -g rg1 --name domain1 -l westus2 --input-schema customeventschema --input-mapping-fields topic=mytopicField eventType=myEventTypeField --input-mapping-default-values subject=DefaultSubject dataVersion=1.0
- name: Create a new domain that accepts events published in CloudEvents V1.0 schema and maps a property mytopicfield to the topic name.
text: az eventgrid domain create -g rg1 --name domain1 -l westus2 --input-schema cloudeventschemav1_0 --input-mapping-fields topic=mytopicfield
- name: Create a new domain which allows specific inbound ip rules.
text: az eventgrid domain create -g rg1 --name domain1 -l westus2 --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --sku basic
"""
helps['eventgrid domain delete'] = """
type: command
short-summary: Delete a domain.
examples:
- name: Delete a domain.
text: az eventgrid domain delete -g rg1 --name domain1
"""
helps['eventgrid domain key'] = """
type: group
short-summary: Manage shared access keys of a domain.
"""
helps['eventgrid domain key list'] = """
type: command
short-summary: List shared access keys of a domain.
examples:
- name: List shared access keys of a domain. (autogenerated)
text: az eventgrid domain key list --name MyDomain --resource-group MyResourceGroup
crafted: true
"""
helps['eventgrid domain key regenerate'] = """
type: command
short-summary: Regenerate a shared access key of a domain.
"""
helps['eventgrid domain list'] = """
type: command
short-summary: List available domains.
examples:
- name: List all domains in the current Azure subscription.
text: az eventgrid domain list
- name: List all domains in a resource group.
text: az eventgrid domain list -g rg1
- name: List all domains in a resource group whose name contains the pattern "XYZ"
text: az eventgrid domain list -g rg1 --odata-query "Contains(name, 'XYZ')"
- name: List all domains in a resource group except the domain with name "name1"
text: az eventgrid domain list -g rg1 --odata-query "NOT (name eq 'name1')"
"""
helps['eventgrid domain show'] = """
type: command
short-summary: Get the details of a domain.
examples:
- name: Show the details of a domain.
text: az eventgrid domain show -g rg1 -n domain1
- name: Show the details of a domain based on resource ID.
text: az eventgrid domain show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/domain1
- name: Get the details of a domain (autogenerated)
text: az eventgrid domain show --name domain1 --resource-group rg1 --subscription MySubscription
crafted: true
"""
helps['eventgrid domain topic'] = """
type: group
short-summary: Manage event domain topics.
"""
helps['eventgrid domain topic create'] = """
type: command
short-summary: Create a domain topic under a domain.
examples:
- name: Create a new domain topic under domain.
text: az eventgrid domain topic create -g rg1 --domain-name domain1 --name domaintopic1
"""
helps['eventgrid domain topic delete'] = """
type: command
short-summary: Delete a domain topic under a domain.
examples:
- name: Delete a domain topic.
text: az eventgrid domain topic delete -g rg1 --domain-name domain1 --name domaintopic1
"""
helps['eventgrid domain topic list'] = """
type: command
short-summary: List available topics in a domain.
examples:
- name: List all topics in a domain.
text: az eventgrid domain topic list -g rg1 --domain-name domain1
- name: List all domain topics in a domain whose name contains the pattern "XYZ"
text: az eventgrid domain topic list -g rg1 --domain-name domain1 --odata-query "Contains(name, 'XYZ')"
- name: List all domain topics in a domain except the domain topic with name "name1"
text: az eventgrid domain topic list -g rg1 --domain-name domain1 --odata-query "NOT (name eq 'name1')"
"""
helps['eventgrid domain topic show'] = """
type: command
short-summary: Get the details of a domain topic.
examples:
- name: Show the details of a domain topic.
text: az eventgrid domain topic show -g rg1 --domain-name domain1 --name topic1
"""
helps['eventgrid domain update'] = """
type: command
short-summary: Update a domain.
parameters:
- name: --inbound-ip-rules
short-summary: List of inbound IP rules.
long-summary: |
List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
examples:
- name: Update the properties of an existing domain.
text: az eventgrid domain update -g rg1 --name domain1 --sku Basic --identity noidentity --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT --sku basic
"""
helps['eventgrid domain topic event-subscription'] = """
type: group
short-summary: Manage event subscriptions of a domain topic.
"""
helps['eventgrid domain topic event-subscription create'] = """
type: command
short-summary: Create a new event subscription for a domain topic
parameters:
- name: --advanced-filter
short-summary: An advanced filter enables filtering of events based on a specific event property.
long-summary: |
Usage: --advanced-filter KEY[.INNERKEY] FILTEROPERATOR VALUE [VALUE ...]
StringIn: --advanced-filter data.Color StringIn Blue Red Orange Yellow
StringNotIn: --advanced-filter data.Color StringNotIn Blue Red Orange Yellow
StringContains: --advanced-filter subject StringContains Blue Red
StringNotContains: --advanced-filter subject StringNotContains Blue Red
StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red
StringNotBeginsWith: --advanced-filter subject StringNotBeginsWith Blue Red
StringEndsWith: --advanced-filter subject StringEndsWith img png jpg
StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png jpg
NumberIn: --advanced-filter data.property1 NumberIn 5 10 20
NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50
NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300
NumberNotInRange: --advanced-filter data.property2 NumberNotInRange 100,110 200,210 300,310
NumberLessThan: --advanced-filter data.property3 NumberLessThan 100
NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100
NumberGreaterThan: --advanced-filter data.property3 NumberGreaterThan 100
NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100
BoolEquals: --advanced-filter data.property3 BoolEquals true
IsNullOrUndefined: --advanced-filter data.property3 IsNullOrUndefined
IsNotNull: --advanced-filter data.property3 IsNotNull
Multiple advanced filters can be specified by using more than one `--advanced-filter` argument.
- name: --deadletter-endpoint
short-summary: The Azure resource ID of an Azure Storage blob container destination where EventGrid should deadletter undeliverable events for this event subscription.
long-summary: |
Example: --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/containerName
- name: --endpoint-type
short-summary: The type of the destination endpoint.
- name: --delivery-attribute-mapping -d
short-summary: Add delivery attribute mapping to send additional information via HTTP headers when delivering events. This attribute is valid for all destination types except StorageQueue. Multiple attributes can be specified by using more than one `--delivery-attribute-mapping` argument.
long-summary: |
Usage: --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret]
Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue
Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue false
Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true
Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue
Both Static and Dynamic: --delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue
examples:
- name: Create a new event subscription for an Event Grid domain topic, using default filters.
text: |
az eventgrid domain topic event-subscription create --name es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
- name: Create a new event subscription for an Event Grid domain topic, with a filter specifying a subject prefix.
text: |
az eventgrid domain topic event-subscription create --name es4 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \\
--subject-begins-with mysubject_prefix
- name: Create a new event subscription for an Event Grid domain topic, using default filters, and CloudEvent V 1.0 as the delivery schema.
text: |
az eventgrid domain topic event-subscription create -n es2 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \\
--event-delivery-schema cloudeventschemav1_0
- name: Create a new event subscription for an Event Grid domain topic, with a deadletter destination and custom retry policy of maximum 10 delivery attempts and an Event TTL of 2 hours (whichever happens earlier) and expiration date.
text: |
az eventgrid domain topic event-subscription create --name es2 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \\
--deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/s2/blobServices/default/containers/blobcontainer1 \\
--max-delivery-attempts 10 --event-ttl 120 --expiration-date "2022-10-31"
- name: Create a new event subscription for an Event Grid domain topic, using Azure Active Directory enabled Webhook as a destination.
text: |
az eventgrid domain topic event-subscription create --name es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--azure-active-directory-tenant-id azureactivedirectorytenantid
--azure-active-directory-application-id-or-uri azureactivedirectoryapplicationidoruri
- name: Create a new event subscription for an Event Grid domain topic, using Azure Function as destination.
text: |
az eventgrid domain topic event-subscription create -n es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction
- name: Create a new event subscription for an Event Grid domain topic using Storage Queue as destination with a ttl of 5 mins
text: |
az eventgrid domain topic event-subscription create -n es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--endpoint-type storagequeue \\
--endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \\
--storage-queue-msg-ttl 300
- name: Create a new event subscription for an Event Grid domain topic and enable advanced filtering on arrays
text: |
az eventgrid domain topic event-subscription create -n es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction \\
--enable-advanced-filtering-on-arrays true
"""
helps['eventgrid domain topic event-subscription delete'] = """
type: command
short-summary: Delete an event subscription of a domain topic
examples:
- name: Delete an event subscription for an Event Grid domain topic.
text: |
az eventgrid domain topic event-subscription delete --name es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
"""
helps['eventgrid domain topic event-subscription list'] = """
type: command
short-summary: List event subscriptions of a specific domain topic.
examples:
- name: List all event subscriptions created for an Event Grid domain topic.
text: |
az eventgrid domain topic event-subscription list -g rg1 --domain-name domain1 --domain-topic-name topic1
"""
helps['eventgrid domain topic event-subscription show'] = """
type: command
short-summary: Get the details of an event subscription of a domain topic.
examples:
- name: Show the details of an event subscription for an Event Grid domain topic.
text: |
az eventgrid domain topic event-subscription show --name es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1
- name: Show the details of an event subscription for an Event Grid domain topic include any static delivery attribute secrets.
text: |
az eventgrid domain topic event-subscription show --name es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 --include-attrib-secret
"""
helps['eventgrid domain topic event-subscription update'] = """
type: command
short-summary: Update an event subscription of a domain topic.
parameters:
- name: --update-endpoint-type
short-summary: The type of the destination endpoint.
- name: --advanced-filter
short-summary: An advanced filter enables filtering of events based on a specific event property.
long-summary: |
Usage: --advanced-filter KEY[.INNERKEY] FILTEROPERATOR VALUE [VALUE ...]
StringIn: --advanced-filter data.Color StringIn Blue Red Orange Yellow
StringNotIn: --advanced-filter data.Color StringNotIn Blue Red Orange Yellow
StringContains: --advanced-filter subject StringContains Blue Red
StringNotContains: --advanced-filter subject StringNotContains Blue Red
StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red
StringNotBeginsWith: --advanced-filter subject StringNotBeginsWith Blue Red
StringEndsWith: --advanced-filter subject StringEndsWith img png jpg
StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png jpg
NumberIn: --advanced-filter data.property1 NumberIn 5 10 20
NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50
NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300
NumberNotInRange: --advanced-filter data.property2 NumberNotInRange 100,110 200,210 300,310
NumberLessThan: --advanced-filter data.property3 NumberLessThan 100
NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100
NumberGreaterThan: --advanced-filter data.property3 NumberGreaterThan 100
NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100
BoolEquals: --advanced-filter data.property3 BoolEquals true
IsNullOrUndefined: --advanced-filter data.property3 IsNullOrUndefined
IsNotNull: --advanced-filter data.property3 IsNotNull
Multiple advanced filters can be specified by using more than one `--advanced-filter` argument.
- name: --delivery-attribute-mapping -d
short-summary: Add delivery attribute mapping to send additional information via HTTP headers when delivering events. This attribute is valid for all destination types except StorageQueue. Multiple attributes can be specified by using more than one `--delivery-attribute-mapping` argument.
long-summary: |
Usage: --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret]
Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue
Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue false
Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true
Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue
Both Static and Dynamic: --delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue
examples:
- name: Update an event subscription for an Event Grid domain topic to specify a new endpoint.
text: |
az eventgrid domain topic event-subscription update --name es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 --endpoint https://contoso.azurewebsites.net/api/f1?code=code
- name: Update an event subscription for an Event Grid domain topic to specify a new subject-ends-with filter.
text: |
az eventgrid domain topic event-subscription update --name es2 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--subject-ends-with .jpg
- name: Update an event subscription for an Event Grid domain topic to specify a new endpoint and a new subject-ends-with filter a new list of included event types.
text: |
az eventgrid domain topic event-subscription update --name es3 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--subject-ends-with .png \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--included-event-types Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted
- name: Update an event subscription for an Azure Event Grid domain topic, to include a deadletter destination.
text: |
az eventgrid domain topic event-subscription update --name es2 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/blobcontainer1
- name: Update an event subscription for an Azure Event Grid domain topic, using advanced filters.
text: |
az eventgrid domain topic event-subscription update --name es3 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--advanced-filter data.blobType StringIn BlockBlob
--advanced-filter data.url StringBeginsWith https://myaccount.blob.core.windows.net
- name: Update an event subscription for an Event Grid domain topic with Storage Queue as destination with ttl of 5 mins
text: |
az eventgrid domain topic event-subscription update -n es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--storage-queue-msg-ttl 300
- name: Update an event subscription for an Event Grid domain topic with advanced filtering on arrays enabled
text: |
az eventgrid domain topic event-subscription update -n es1 \\
-g rg1 --domain-name domain1 --domain-topic-name topic1 \\
--enable-advanced-filtering-on-arrays true
"""
helps['eventgrid partner'] = """
type: group
short-summary: Manage partner resources.
"""
helps['eventgrid partner registration'] = """
type: group
short-summary: Manage partner registrations.
"""
helps['eventgrid partner registration create'] = """
type: command
short-summary: Create a new partner registration.
examples:
- name: Create a new partner registration with basic information.
text: az eventgrid partner registration create -g rg1 --name partnerRegistrationName1 --partner-name Contoso --resource-type-name Accounts --authorized-subscription-ids 533ad9de-25db-46e2-b94a-d00c37cf022b 05aa2228-7d34-4635-922d-2b582c422445
- name: Create a new partner registration with partner information.
text: az eventgrid partner registration create -g rg1 --name partnerRegistrationName1 --partner-name Contoso --resource-type-name Accounts --authorized-subscription-ids 533ad9de-25db-46e2-b94a-d00c37cf022b 05aa2228-7d34-4635-922d-2b582c422445 --description ExampleDescription --display-name ExampleDisplayName1 --logo-uri \'https://www.example.com/logo.png\' --setup-uri \'https://www.example.com\' --long-description \'This is sample description}\' --customer-service-number \'+1 800 123 4567' --customer-service-extension \'125\' --customer-service-uri \'https://www.example.com/customerservice\'
"""
helps['eventgrid partner registration list'] = """
type: command
short-summary: List all partner registrations in specific resource group or all under the specified azure subscription.
examples:
- name: List all partner registrations in the current Azure subscription.
text: az eventgrid partner registration list
- name: List all partner registrations in a resource group.
text: az eventgrid partner registration list -g rg1
- name: List all partner registrations in a resource group whose name contains the pattern "XYZ"
text: az eventgrid partner registration list -g rg1 --odata-query "Contains(name, 'XYZ')"
- name: List all partner registrations in a resource group except the partner registration with name "name1"
text: az eventgrid partner registration list -g rg1 --odata-query "NOT (name eq 'name1')"
"""
helps['eventgrid partner namespace'] = """
type: group
short-summary: Manage partner namespaces.
"""
helps['eventgrid partner namespace create'] = """
type: command
short-summary: Create a partner namespace.
examples:
- name: Create a new partner namespace.
text: az eventgrid partner namespace create -g rg1 --name namespaceName1 -l westus2 --partner-registration-id 795c9f2f-6d2d-42ff-a570-42fd3043192c
"""
helps['eventgrid partner namespace list'] = """
type: command
short-summary: List available partner namespaces.
examples:
- name: List all partner namespaces in the current Azure subscription.
text: az eventgrid partner namespace list
- name: List all partner namespaces in a resource group.
text: az eventgrid partner namespace list -g rg1
- name: List all partner namespaces in a resource group whose name contains the pattern "XYZ"
text: az eventgrid partner namespace list -g rg1 --odata-query "Contains(name, 'XYZ')"
- name: List all partner namespaces in a resource group except the partner namespace with name "name1"
text: az eventgrid partner namespace list -g rg1 --odata-query "NOT (name eq 'name1')"
"""
helps['eventgrid partner namespace delete'] = """
type: command
short-summary: Delete a partner namespace.
examples:
- name: Delete a specific partner namespace.
text: az eventgrid partner namespace delete -g rg1 --name partnernamespace1
"""
helps['eventgrid partner namespace show'] = """
type: command
short-summary: Get the details of a partner namespace.
examples:
- name: Show the details of a partner namespace.
text: az eventgrid partner namespace show -g rg1 -n partnernamespace1
- name: Show the details of a partner namespace based on resource ID.
text: az eventgrid partner namespace show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/partnenamespaces/partnernamespace1
"""
helps['eventgrid partner namespace key'] = """
type: group
short-summary: Manage shared access keys of a partner namespace.
"""
helps['eventgrid partner namespace key list'] = """
type: command
short-summary: List shared access keys of a partner namespace.
examples:
- name: List shared access keys of a partner namespace (autogenerated)
text: az eventgrid partner namespace key list --partner-namespace-name MyNamespace --resource-group MyResourceGroup
crafted: true
"""
helps['eventgrid partner namespace key regenerate'] = """
type: command
short-summary: Regenerate a shared access key of a partner namespace.
"""
helps['eventgrid partner namespace event-channel'] = """
type: group
short-summary: Manage partner event channels.
"""
helps['eventgrid partner namespace channel'] = """
type: group
short-summary: Manage partner channels.
"""
helps['eventgrid partner namespace event-channel create'] = """
type: command
short-summary: Create an event channel under a partner namespace.
parameters:
- name: --publisher-filter
short-summary: A publisher filter that is used to enable filtering of events based on a specific event property. This set of filters that are specified by the publisher in order to determine which events to be received by the subscriber.
long-summary: |
Usage: --publisher-filter KEY[.INNERKEY] FILTEROPERATOR VALUE [VALUE ...]
StringIn: --publisher-filter data.Color StringIn Blue Red Orange Yellow
StringNotIn: --publisher-filter data.Color StringNotIn Blue Red Orange Yellow
StringContains: --publisher-filter subject StringContains Blue Red
StringBeginsWith: --publisher-filter subject StringBeginsWith Blue Red
StringEndsWith: --publisher-filter subject StringEndsWith img png jpg
NumberIn: --publisher-filter data.property1 NumberIn 5 10 20
NumberNotIn: --publisher-filter data.property2 NumberNotIn 100 200 300
NumberLessThan: --publisher-filter data.property3 NumberLessThan 100
NumberLessThanOrEquals: --publisher-filter data.property2 NumberLessThanOrEquals 100
NumberGreaterThan: --publisher-filter data.property3 NumberGreaterThan 100
NumberGreaterThanOrEquals: --publisher-filter data.property2 NumberGreaterThanOrEquals 100
BoolEquals: --publisher-filter data.property3 BoolEquals true
Multiple publisher filters can be specified by using more than one `--publisher-filter` argument.
examples:
- name: Create a specific event channel.
text: az eventgrid partner namespace event-channel create -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1 --source SourceExample1 --destination-sub-id 61f7c265-374d-499e-866d-5f4cc302b888 --destination-rg rg2 --destination-topic-name topicName1
- name: Create a specific event channel with an activation expiration time and partner topic friendly description.
text: az eventgrid partner namespace event-channel create -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1 --source SourceExample1 --destination-sub-id 61f7c265-374d-499e-866d-5f4cc302b888 --destination-rg rg2 --destination-topic-name topicName1 --activation-expiration-date \'2020-05-20T10:00\' --partner-topic-description \'This topic is created by Costoco corp on user behavior.\'
- name: Create a specific event channel with publisher filters.
text: az eventgrid partner namespace event-channel create -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1 --source SourceExample1 --destination-sub-id 61f7c265-374d-499e-866d-5f4cc302b888 --destination-rg rg2 --destination-topic-name topicName1 --publisher-filter data.key1 NumberIn 2 3 4 100 200 --publisher-filter data.key2 StringIn 2 3 4 100 200
"""
helps['eventgrid partner namespace event-channel list'] = """
type: command
short-summary: List available partner event-channels.
examples:
- name: List all event-channels in a specific partner namespace.
text: az eventgrid partner namespace event-channel list -g rg1 --partner-namespace-name partnernamespace1
- name: List all event channel under a partner namespace whose name contains the pattern "XYZ"
text: az eventgrid partner namespace event-channel list -g rg1 --partner-namespace-name partnernamespace1 --odata-query "Contains(name, 'XYZ')"
"""
helps['eventgrid partner namespace event-channel delete'] = """
type: command
short-summary: Delete a partner namespace.
examples:
- name: Delete a specific partner namespace.
text: az eventgrid partner namespace event-channel delete -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1
"""
helps['eventgrid partner namespace event-channel show'] = """
type: command
short-summary: Get the details of an event channel under a partner namespace.
examples:
- name: Show the details of an event channel.
text: az eventgrid partner namespace event-channel show -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1
- name: Show the details of an event-channel based on resource ID.
text: az eventgrid partner namespace event-channel show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/partnenamespaces/partnernamespace1/eventChannels/eventChannelName1
"""
helps['eventgrid partner topic'] = """
type: group
short-summary: Manage partner topics.
"""
helps['eventgrid system-topic'] = """
type: group
short-summary: Manage system topics.
"""
helps['eventgrid system-topic create'] = """
type: command
short-summary: Create a system topic.
examples:
- name: Create a new system topic for storage account source.
text: az eventgrid system-topic create -g rg1 --name systemtopic1 --location westus2 --topic-type microsoft.storage.storageaccounts --source /subscriptions/1b3b4501-23b9-4790-c31b-ddbd88d72123/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/stgaccountname
- name: Create a new system topic with systemassigned identity
text: az eventgrid system-topic create -g rg1 --name systemtopic1 --location westus2 --topic-type microsoft.storage.storageaccounts --source /subscriptions/1b3b4501-23b9-4790-c31b-ddbd88d72123/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/stgaccountname --identity systemassigned
"""
helps['eventgrid system-topic delete'] = """
type: command
short-summary: Delete a system topic.
examples:
- name: Delete a specific system topic.
text: az eventgrid system-topic delete -g rg1 --name systemtopic1
"""
helps['eventgrid system-topic list'] = """
type: command
short-summary: List available system topics.
examples:
- name: List all system topics in the current Azure subscription.
text: az eventgrid system-topic list
- name: List all system topics in a resource group.
text: az eventgrid system-topic list -g rg1
- name: List all system topics in a resource group whose name contains the pattern "XYZ"
text: az eventgrid system-topic list -g rg1 --odata-query "Contains(name, 'XYZ')"
- name: List all system topics in a resource group except the system topic with name "name1"
text: az eventgrid system-topic list -g rg1 --odata-query "NOT (name eq 'name1')"
"""
helps['eventgrid system-topic show'] = """
type: command
short-summary: Get the details of a system topic.
examples:
- name: Show the details of a system topic.
text: az eventgrid system-topic show -g rg1 -n systemtopic1
- name: Show the details of a system topic based on resource ID.
text: az eventgrid system-topic show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/systemtopics/systemtopic1
"""
helps['eventgrid system-topic update'] = """
type: command
short-summary: Update a system topic.
examples:
- name: Update the properties of an existing system topic.
text: az eventgrid system-topic update -g rg1 --name systemtopic1 --tags Dept=IT
- name: Update the identity of an existing system topic.
text: az eventgrid system-topic update -g rg1 --name systemtopic1 --identity systemassigned
"""
helps['eventgrid partner topic list'] = """
type: command
short-summary: List available partner topics.
examples:
- name: List all partner topics in the current Azure subscription.
text: az eventgrid partner topic list
- name: List all partner topics in a resource group.
text: az eventgrid partner topic list -g rg1
- name: List all partner topics in a resource group whose name contains the pattern "XYZ"
text: az eventgrid partner topic list -g rg1 --odata-query "Contains(name, 'XYZ')"
- name: List all partner topics in a resource group except the partner topic with name "name1"
text: az eventgrid partner topic list -g rg1 --odata-query "NOT (name eq 'name1')"
"""
helps['eventgrid partner topic delete'] = """
type: command
short-summary: Delete a partner topic.
examples:
- name: Delete a specific partner topic.
text: az eventgrid partner topic delete -g rg1 --name partnertopic1
"""
helps['eventgrid partner topic show'] = """
type: command
short-summary: Get the details of a partner topic.
examples:
- name: Show the details of a partner topic.
text: az eventgrid partner topic show -g rg1 -n partnertopic1
- name: Show the details of a partner topic based on resource ID.
text: az eventgrid partner topic show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/partnetopics/topic1
"""
helps['eventgrid partner topic activate'] = """
type: command
short-summary: Activate a partner topic.
examples:
- name: Activate a specific partner topic.
text: az eventgrid partner topic activate -g rg1 -n partnertopic1
"""
helps['eventgrid partner topic deactivate'] = """
type: command
short-summary: Deactivate a partner topic.
examples:
- name: Deactivate a specific partner topic.
text: az eventgrid partner topic deactivate -g rg1 -n partnertopic1
"""
helps['eventgrid partner verified-partner'] = """
type: group
short-summary: Manage verified partners.
"""
helps['eventgrid partner verified-partner show'] = """
type: command
short-summary: Get the details of a verified partner.
examples:
- name: Show the details of a partner verified partner.
text: az eventgrid partner verified-partner show --verified-partner-name verifiedpartner1
"""
helps['eventgrid partner verified-partner list'] = """
type: command
short-summary: List available verified partners.
examples:
- name: List all verified partners in the current tenant.
text: az eventgrid partner verified-partner list
"""
helps['eventgrid partner destination'] = """
type: group
short-summary: Manage partner destinations.
"""
helps['eventgrid partner destination activate'] = """
type: command
short-summary: Activate a partner destination.
examples:
- name: Activate a partner destination.
text: az eventgrid partner destination activate -g rg1 -n destination1
"""
helps['eventgrid partner destination create'] = """
type: command
short-summary: Create a partner destination.
examples:
- name: Create a partner destination.
text: az eventgrid partner destination create --location westus2 -g rg1 -n destination1
- name: Create a partner destination with an activation message and expiration time.
text: |
az eventgrid partner destination create --location westus2 -g rg1 -n destination1 \\
--activation-expiration-date 2022-06-14T05:37:51.272Z \\
--message-for-activation "This is an activation message"
"""
helps['eventgrid partner destination delete'] = """
type: command
short-summary: Delete a partner destination.
examples:
- name: Delete a partner destination.
text: az eventgrid partner destination delete -g rg1 -n destination1
"""
helps['eventgrid partner destination list'] = """
type: command
short-summary: List available partner destinations.
examples:
- name: List all partner destinations in the current Azure subscription.
text: az eventgrid partner destination list
- name: List all partner destinations in the current Azure subscription whose name contains the pattern "XYZ"
text: az eventgrid partner destination list --odata-query "Contains(name, 'XYZ')"
- name: List all partner destinations in the current Azure subscription except the partner destination with name "name1"
text: az eventgrid partner destination list --odata-query "NOT (name eq 'name1')"
- name: List all partner destinations in a resource group.
text: az eventgrid partner destination list -g rg1
"""
helps['eventgrid partner destination show'] = """
type: command
short-summary: Get the details of a partner destination.
examples:
- name: Show the details of a partner destination.
text: az eventgrid partner destination show -g rg1 -n destinationname1
"""
helps['eventgrid partner destination update'] = """
type: command
short-summary: Update the details of a partner destination.
examples:
- name: Update the tags of a partner destination.
text: az eventgrid partner destination update -g rg1 -n destinationname1 --tags Dept=IT
"""
helps['eventgrid partner configuration'] = """
type: group
short-summary: Manage partner configurations.
"""
helps['eventgrid partner configuration create'] = """
type: command
short-summary: Create a partner configuration.
parameters:
- name: --authorized-partner
short-summary: Add authorized partner information. Multiple authorized partners can be specified by using more than one `--authorized-partner` argument.
long-summary: |
Add authorized partner information. Multiple authorized partners can be specified by using more than one `--authorized-partner` argument. `partner-name` represents the verified partner resource name corresponding to the partner if it is a verified publisher. `partner-registration-immutable-id` represents the immutable id of the publisher registration ARM resource. `partner-name` and `partner-registration-immutable-id` are optional parameters but at least one parameter should be specified when authorizing a partner. When both are present, they both should correspond to the same verified parner information.
Usage: --authorized-partner [partner-name=<name>] \\
[partner-registration-immutable-id=<id>] \\
[expiration-time=<timestamp>]
Partner Name: --authorized-partner partner-name=somename \\
expiration-time=2022-06-14T05:37:51.272Z
Partner Registration ID: --authorized-partner \\
partner-registration-immutable-id=795c9f2f-6d2d-42ff-a570-42fd3043192c \\
expiration-time=2022-06-14T05:37:51.272Z
Both Name and ID: --authorized-partner partner-name=somename \\
partner-registration-immutable-id=795c9f2f-6d2d-42ff-a570-42fd3043192c \\
expiration-time=2022-06-14T05:37:51.272Z
examples:
- name: Create a partner configuration with multiple authorized partners.
text: |
az eventgrid partner configuration create -g rg1 \\
--authorized-partner partner-name=somepartner1 \\
--authorized-partner partner-name=somepartner2 \\
--default-maximum-expiration-time-in-days 5
"""
helps['eventgrid partner configuration list'] = """
type: command
short-summary: List available partner configurations.
examples:
- name: List all partner configurations in the current Azure subscription.
text: az eventgrid partner configuration list
- name: List all partner configurations in the current Azure subscription whose name contains the pattern "XYZ"
text: az eventgrid partner configuration list --odata-query "Contains(name, 'XYZ')"
- name: List all partner configurations in the current Azure subscription except the partner configuration with name "name1"
text: az eventgrid partner configuration list --odata-query "NOT (name eq 'name1')"
- name: List all partner configurations in a resource group.
text: az eventgrid partner configuration list -g rg1
"""
helps['eventgrid partner configuration delete'] = """
type: command
short-summary: Delete a partner configuration.
examples:
- name: Delete a partner configuration.
text: az eventgrid partner configuration delete -g rg1
"""
helps['eventgrid partner configuration show'] = """
type: command
short-summary: Get the details of a partner configuration.
examples:
- name: Show the details of a partner configuration.
text: az eventgrid partner configuration show -g rg1
"""
helps['eventgrid partner configuration authorize'] = """
type: command
short-summary: Authorize a partner configuration.
examples:
- name: Authorize a partner based on partner registration immutable ID.
text: az eventgrid partner configuration authorize -g rg1 --partner-registration-immutable-id 795c9f2f-6d2d-42ff-a570-42fd3043192c --authorization-expiration-date 2022-06-14T05:37:51.272Z
- name: Authorize a partner based on partner name.
text: az eventgrid partner configuration authorize -g rg1 --partner-name partner1 --authorization-expiration-date 2022-06-14T05:37:51.272Z
"""
helps['eventgrid partner configuration unauthorize'] = """
type: command
short-summary: Unauthorize a partner configuration.
examples:
- name: Unauthorize a partner based on partner registration immutable ID.
text: az eventgrid partner configuration unauthorize -g rg1 --partner-registration-immutable-id 795c9f2f-6d2d-42ff-a570-42fd3043192c --authorization-expiration-date 2022-06-14T05:37:51.272Z
- name: Unauthorize a partner based on partner name.
text: az eventgrid partner configuration unauthorize -g rg1 --partner-name partner1 --authorization-expiration-date 2022-06-14T05:37:51.272Z
"""
helps['eventgrid partner configuration update'] = """
type: command
short-summary: Update a partner configuration.
examples:
- name: Update a partner configuration's default maximum expiration time.
text: az eventgrid partner configuration update -g rg1 --default-maximum-expiration-time-in-days 5
"""
helps['eventgrid system-topic event-subscription'] = """
type: group
short-summary: Manage event subscriptions of system topic.
"""
helps['eventgrid partner namespace channel create'] = """
type: command
short-summary: Create a new channel for a partner namespace.
parameters:
- name: --inline-event-type
short-summary: Create a channel for an existing partner namespace, either of type partner topic or partner destination. You can also add inline event type info if channel type is partner topic. Multiple attributes can be specified by using more than one `--inline-event-type` argument.
long-summary: |
Usage: --inline-event-type KEY [description=<description>] [documentation-url=<url>] \\
[data-schema-url=<url>]
Example: --inline-event-type event1 \\
description="My inline event type." \\
documentation-url=https://www.microsoft.com \\
data-schema-url=https://www.microsoft.com
examples:
- name: Create a new channel of type PartnerDestination with inline event types.
text: |
az eventgrid partner namespace channel create -g rg1 --name channel1 \\
--channel-type PartnerDestination --partner-namespace-name namespace1 \\
--partner-destination-name destination1 --destination-sub-id e14e31c8-0ce7-4ff5-be5b-dd2b2a3f3535 --destination-rg rg2
- name: Create a new channel of type PartnerTopic with inline event types.
text: |
az eventgrid partner namespace channel create -g rg1 --name channel1 \\
--channel-type PartnerTopic --partner-namespace-name namespace1 \\
--partner-topic-name topic1 \\
--destination-sub-id e14e31c8-0ce7-4ff5-be5b-dd2b2a3f3535 --destination-rg rg2 \\
--partner-topic-source /subscriptions/1b3b4501-23b9-4790-c31b-ddbd88d72123/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/stgaccountname \\
--inline-event-type eventkey1 description="My event type." \\
--inline-event-type eventkey2 description="My second event type."
"""
helps['eventgrid partner namespace channel list'] = """
type: command
short-summary: List available partner channels.
examples:
- name: List all channels in a specific partner namespace.
text: az eventgrid partner namespace channel list -g rg1 --partner-namespace-name partnernamespace1
- name: List all channel under a partner namespace whose name contains the pattern "XYZ"
text: az eventgrid partner namespace channel list -g rg1 --partner-namespace-name partnernamespace1 --odata-query "Contains(name, 'XYZ')"
"""
helps['eventgrid partner namespace channel delete'] = """
type: command
short-summary: Delete a partner namespace.
examples:
- name: Delete a specific partner namespace.
text: az eventgrid partner namespace channel delete -g rg1 --partner-namespace-name partnernamespace1 --name channelname1
"""
helps['eventgrid partner namespace channel show'] = """
type: command
short-summary: Get the details of a channel under a partner namespace.
examples:
- name: Show the details of a channel.
text: az eventgrid partner namespace channel show -g rg1 --partner-namespace-name partnernamespace1 --name channelname1
- name: Show the details of a channel based on resource ID.
text: az eventgrid partner namespace channel show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/partnenamespaces/partnernamespace1/channels/channelName1
"""
helps['eventgrid partner namespace channel update'] = """
type: command
short-summary: Update the details of a channel under a partner namespace.
parameters:
- name: --inline-event-type
short-summary: Add inline event type info. Multiple attributes can be specified by using more than one `--inline-event-type` argument.
long-summary: |
Usage: --inline-event-type KEY [description=<description>] [documentation-url=<url>] \\
[data-schema-url=<url>]
Example: --inline-event-type event1 \\
description="My inline event type." \\
documentation-url=https://www.microsoft.com \\
data-schema-url=https://www.microsoft.com
examples:
- name: Update the expiration time of a channel.
text: |
az eventgrid partner namespace channel update -g rg1 \\
--partner-namespace-name partnernamespace1 \\
--name channelname1 \\
--activation-expiration-date 2022-06-14T05:37:51.272Z \\
- name: Update the inline events of a channel.
text: |
az eventgrid partner namespace channel update -g rg1 \\
--partner-namespace-name partnernamespace1 \\
--name channelname1 \\
--event-type-kind inline --inline-event-type eventtype1 documentation-url=https://www.microsoft.com
"""
helps['eventgrid system-topic event-subscription create'] = """
type: command
short-summary: Create a new event subscription for a system topic
parameters:
- name: --advanced-filter
short-summary: An advanced filter enables filtering of events based on a specific event property.
long-summary: |
Usage: --advanced-filter KEY[.INNERKEY] FILTEROPERATOR VALUE [VALUE ...]
StringIn: --advanced-filter data.Color StringIn Blue Red Orange Yellow
StringNotIn: --advanced-filter data.Color StringNotIn Blue Red Orange Yellow
StringContains: --advanced-filter subject StringContains Blue Red
StringNotContains: --advanced-filter subject StringNotContains Blue Red
StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red
StringNotBeginsWith: --advanced-filter subject StringNotBeginsWith Blue Red
StringEndsWith: --advanced-filter subject StringEndsWith img png jpg
StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png jpg
NumberIn: --advanced-filter data.property1 NumberIn 5 10 20
NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50
NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300
NumberNotInRange: --advanced-filter data.property2 NumberNotInRange 100,110 200,210 300,310
NumberLessThan: --advanced-filter data.property3 NumberLessThan 100
NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100
NumberGreaterThan: --advanced-filter data.property3 NumberGreaterThan 100
NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100
BoolEquals: --advanced-filter data.property3 BoolEquals true
IsNullOrUndefined: --advanced-filter data.property3 IsNullOrUndefined
IsNotNull: --advanced-filter data.property3 IsNotNull
Multiple advanced filters can be specified by using more than one `--advanced-filter` argument.
- name: --deadletter-endpoint
short-summary: The Azure resource ID of an Azure Storage blob container destination where EventGrid should deadletter undeliverable events for this event subscription.
long-summary: |
Example: --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/containerName
- name: --endpoint-type
short-summary: The type of the destination endpoint.
- name: --delivery-attribute-mapping
short-summary: Add delivery attribute mapping to send additional information via HTTP headers when delivering events. This attribute is valid for all destination types except StorageQueue. Multiple attributes can be specified by using more than one `--delivery-attribute-mapping` argument.
long-summary: |
Usage: --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret]
Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue
Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue false
Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true
Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue
Both Static and Dynamic: --delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue
examples:
- name: Create a new event subscription for an Event Grid system topic, using default filters.
text: |
az eventgrid system-topic event-subscription create --name es1 \\
-g rg1 --system-topic-name systemtopic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
- name: Create a new event subscription for an Event Grid system topic, with a filter specifying a subject prefix.
text: |
az eventgrid system-topic event-subscription create --name es4 \\
-g rg1 --system-topic-name systemtopic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \\
--subject-begins-with mysubject_prefix
- name: Create a new event subscription for an Event Grid system topic, using default filters, and CloudEvent V 1.0 as the delivery schema.
text: |
az eventgrid system-topic event-subscription create -n es2 \\
-g rg1 --system-topic-name systemtopic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \\
--event-delivery-schema cloudeventschemav1_0
- name: Create a new event subscription for an Event Grid system topic, with a deadletter destination and custom retry policy of maximum 10 delivery attempts and an Event TTL of 2 hours (whichever happens earlier) and expiration date.
text: |
az eventgrid system-topic event-subscription create --name es2 \\
-g rg1 --system-topic-name systemtopic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \\
--deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/s2/blobServices/default/containers/blobcontainer1 \\
--max-delivery-attempts 10 --event-ttl 120 --expiration-date "2022-10-31"
- name: Create a new event subscription for an Event Grid system topic, using Azure Active Directory enabled Webhook as a destination .
text: |
az eventgrid system-topic event-subscription create --name es1 \\
-g rg1 --system-topic-name systemtopic1 \\
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--azure-active-directory-tenant-id azureactivedirectorytenantid
--azure-active-directory-application-id-or-uri azureactivedirectoryapplicationidoruri
- name: Create a new event subscription for an Event Grid system topic, using Azure Function as destination.
text: |
az eventgrid system-topic event-subscription create -n es1 \\
-g rg1 --system-topic-name systemtopic1 \\
--endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction
- name: Create a new event subscription for an Event Grid system topic using Storage Queue as destination with a ttl of 5 mins
text: |
az eventgrid system-topic event-subscription create -n es1 \\