Skip to content

Commit 3b7ac99

Browse files
lijinpei2008lijinpei2008
authored
[EventGrid] Added breaking change message. (#24447)
* Added breaking change message. * Added breaking change message. * update * update * Modify the description content: This parameter will be deprecated. * update changelog * update changelog * update changelog
1 parent d8254d7 commit 3b7ac99

32 files changed

+144
-0
lines changed

‎src/EventGrid/EventGrid/ChangeLog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@
1818
- Additional information about change #1
1919
-->
2020
## Upcoming Release
21+
* Added breaking change messages due to structure update:
22+
- The cmdlet `Set-AzEventGridTopic` will be removed.
23+
- In the `Remove-AzEventGridSubscription` parameters will be deprecated.
24+
- In the `Get-AzEventGrid*` the parameter `ODataQuery`, `NextLink`, `ResourceId` will be removed.
25+
- In the `New/Update-AzEventGrid*` parameters will be deprecated.
2126

2227
## Version 1.6.0
2328
* Added fix for DeliveryAttributeMapping

‎src/EventGrid/EventGrid/Channel/GetAzureEventGridChannel.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
using Microsoft.Azure.Management.EventGrid.Models;
2121
using Microsoft.Azure.Commands.EventGrid.Utilities;
2222
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
23+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2324

2425
namespace Microsoft.Azure.Commands.EventGrid
2526
{
@@ -76,6 +77,7 @@ public class GetAzureEventGridChannel : AzureEventGridCmdletBase
7677
[Alias("ChannelName")]
7778
public string Name { get; set; }
7879

80+
[CmdletParameterBreakingChangeWithVersion("ODataQuery", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
7981
[Parameter(
8082
Mandatory = false,
8183
ValueFromPipelineByPropertyName = true,
@@ -92,6 +94,7 @@ public class GetAzureEventGridChannel : AzureEventGridCmdletBase
9294
[ValidateRange(1, 100)]
9395
public int? Top { get; set; }
9496

97+
[CmdletParameterBreakingChangeWithVersion("NextLink", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
9598
[Parameter(
9699
Mandatory = true,
97100
ValueFromPipelineByPropertyName = true,

‎src/EventGrid/EventGrid/Domain/GetAzureEventGridDomain.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
using Microsoft.Azure.Commands.EventGrid.Utilities;
2020
using Microsoft.Azure.Management.EventGrid.Models;
2121
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
22+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2223

2324
namespace Microsoft.Azure.Commands.EventGrid
2425
{
@@ -64,6 +65,7 @@ public class GetAzureEventGridDomain : AzureEventGridCmdletBase
6465
[Alias("DomainName")]
6566
public string Name { get; set; }
6667

68+
[CmdletParameterBreakingChangeWithVersion("ResourceId", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
6769
[Parameter(
6870
Mandatory = true,
6971
ValueFromPipelineByPropertyName = true,
@@ -73,6 +75,7 @@ public class GetAzureEventGridDomain : AzureEventGridCmdletBase
7375
[ValidateNotNullOrEmpty]
7476
public string ResourceId { get; set; }
7577

78+
[CmdletParameterBreakingChangeWithVersion("ODataQuery", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
7679
[Parameter(
7780
Mandatory = false,
7881
ValueFromPipelineByPropertyName = true,
@@ -109,6 +112,7 @@ public class GetAzureEventGridDomain : AzureEventGridCmdletBase
109112
[ValidateRange(1, 100)]
110113
public int Top { get; set; }
111114

115+
[CmdletParameterBreakingChangeWithVersion("NextLink", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
112116
[Parameter(
113117
Mandatory = false,
114118
ValueFromPipelineByPropertyName = true,

‎src/EventGrid/EventGrid/Domain/GetAzureEventGridDomainTopic.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
using Microsoft.Azure.Commands.EventGrid.Utilities;
2020
using Microsoft.Azure.Management.EventGrid.Models;
2121
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
22+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2223

2324
namespace Microsoft.Azure.Commands.EventGrid
2425
{
@@ -68,6 +69,7 @@ public class GetAzureEventGridDomainTopic : AzureEventGridCmdletBase
6869
[Alias(AliasDomainTopicName)]
6970
public string Name { get; set; }
7071

72+
[CmdletParameterBreakingChangeWithVersion("ResourceId", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
7173
[Parameter(
7274
Mandatory = true,
7375
ValueFromPipelineByPropertyName = true,
@@ -77,6 +79,7 @@ public class GetAzureEventGridDomainTopic : AzureEventGridCmdletBase
7779
[ValidateNotNullOrEmpty]
7880
public string ResourceId { get; set; }
7981

82+
[CmdletParameterBreakingChangeWithVersion("ODataQuery", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
8083
[Parameter(
8184
Mandatory = false,
8285
ValueFromPipelineByPropertyName = true,
@@ -103,6 +106,7 @@ public class GetAzureEventGridDomainTopic : AzureEventGridCmdletBase
103106
[ValidateRange(1, 100)]
104107
public int Top { get; set; }
105108

109+
[CmdletParameterBreakingChangeWithVersion("NextLink", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
106110
[Parameter(
107111
Mandatory = false,
108112
ValueFromPipelineByPropertyName = true,

‎src/EventGrid/EventGrid/Domain/NewAzureEventGridDomain.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
using Microsoft.Azure.Management.EventGrid.Models;
2222
using Microsoft.Azure.Commands.EventGrid.Utilities;
2323
using EventGridModels = Microsoft.Azure.Management.EventGrid.Models;
24+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2425

2526
namespace Microsoft.Azure.Commands.EventGrid
2627
{
@@ -84,13 +85,15 @@ public class NewAzureEventGridDomain : AzureEventGridCmdletBase
8485
[ValidateSet(EventGridModels.InputSchema.EventGridSchema, EventGridModels.InputSchema.CustomEventSchema, EventGridModels.InputSchema.CloudEventSchemaV10, IgnoreCase = true)]
8586
public string InputSchema { get; set; } = EventGridModels.InputSchema.EventGridSchema;
8687

88+
[CmdletParameterBreakingChangeWithVersion("InputMappingField", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
8789
[Parameter(
8890
Mandatory = false,
8991
ValueFromPipelineByPropertyName = true,
9092
HelpMessage = EventGridConstants.InputMappingFieldHelp,
9193
ParameterSetName = DomainNameParameterSet)]
9294
public Hashtable InputMappingField { get; set; }
9395

96+
[CmdletParameterBreakingChangeWithVersion("InputMappingDefaultValue", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
9497
[Parameter(
9598
Mandatory = false,
9699
ValueFromPipelineByPropertyName = true,
@@ -101,6 +104,7 @@ public class NewAzureEventGridDomain : AzureEventGridCmdletBase
101104
/// <summary>
102105
/// Hashtable which represents the Inbound IP Rules.
103106
/// </summary>
107+
[CmdletParameterBreakingChangeWithVersion("InboundIpRule", "12.0.0", "2.0.0", OldParamaterType = typeof(Hashtable), NewParameterTypeName="IInboundIPRule[]")]
104108
[Parameter(
105109
Mandatory = false,
106110
ValueFromPipelineByPropertyName = true,
@@ -156,6 +160,7 @@ public class NewAzureEventGridDomain : AzureEventGridCmdletBase
156160
/// <summary>
157161
/// string which represents the IdentityType.
158162
/// </summary>
163+
[CmdletParameterBreakingChangeWithVersion("IdentityType", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
159164
[Parameter(
160165
Mandatory = false,
161166
ValueFromPipelineByPropertyName = true,

‎src/EventGrid/EventGrid/EventSubscription/GetAzureEventGridSubscription.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
using Microsoft.Azure.Commands.EventGrid.Utilities;
2020
using Microsoft.Azure.Management.EventGrid.Models;
2121
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
22+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2223

2324
namespace Microsoft.Azure.Commands.EventGrid
2425
{
@@ -67,6 +68,7 @@ public class GetAzureRmEventGridSubscription : AzureEventGridCmdletBase
6768
[Alias(AliasResourceGroup)]
6869
public string ResourceGroupName { get; set; }
6970

71+
[CmdletParameterBreakingChangeWithVersion("ResourceId", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
7072
[Parameter(
7173
Mandatory = true,
7274
ValueFromPipelineByPropertyName = true,
@@ -100,6 +102,7 @@ public class GetAzureRmEventGridSubscription : AzureEventGridCmdletBase
100102
[ResourceNameCompleter("Microsoft.EventGrid/domains/topics", nameof(ResourceGroupName), nameof(DomainName))]
101103
public string DomainTopicName { get; set; }
102104

105+
[CmdletParameterBreakingChangeWithVersion("TopicTypeName", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
103106
[Parameter(
104107
Mandatory = false,
105108
ValueFromPipelineByPropertyName = true,
@@ -108,6 +111,7 @@ public class GetAzureRmEventGridSubscription : AzureEventGridCmdletBase
108111
[ValidateNotNullOrEmpty]
109112
public string TopicTypeName { get; set; }
110113

114+
[CmdletParameterBreakingChangeWithVersion("Location", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
111115
[Parameter(
112116
Mandatory = false,
113117
ValueFromPipelineByPropertyName = true,
@@ -144,6 +148,7 @@ public class GetAzureRmEventGridSubscription : AzureEventGridCmdletBase
144148
[ValidateNotNullOrEmpty]
145149
public PSDomainTopic DomainTopicInputObject { get; set; }
146150

151+
[CmdletParameterBreakingChangeWithVersion("IncludeFullEndpointUrl", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
147152
[Parameter(
148153
Mandatory = false,
149154
HelpMessage = EventGridConstants.EventSubscriptionFullUrlHelp,
@@ -162,6 +167,7 @@ public class GetAzureRmEventGridSubscription : AzureEventGridCmdletBase
162167
ParameterSetName = ResourceIdEventSubscriptionParameterSet)]
163168
public SwitchParameter IncludeFullEndpointUrl { get; set; }
164169

170+
[CmdletParameterBreakingChangeWithVersion("ODataQuery", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
165171
[Parameter(
166172
Mandatory = false,
167173
ValueFromPipelineByPropertyName = true,
@@ -238,6 +244,7 @@ public class GetAzureRmEventGridSubscription : AzureEventGridCmdletBase
238244
[ValidateRange(1, 100)]
239245
public int? Top { get; set; }
240246

247+
[CmdletParameterBreakingChangeWithVersion("NextLink", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
241248
[Parameter(
242249
Mandatory = false,
243250
ValueFromPipelineByPropertyName = true,

‎src/EventGrid/EventGrid/EventSubscription/NewAzureEventGridSubscription.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
using Microsoft.Azure.Management.EventGrid.Models;
2121
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
2222
using Microsoft.WindowsAzure.Commands.Utilities.Common;
23+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2324

2425
namespace Microsoft.Azure.Commands.EventGrid
2526
{
@@ -611,6 +612,7 @@ public class NewAzureEventGridSubscription : AzureEventGridCmdletBase
611612
[ValidateNotNullOrEmpty]
612613
public string DeliverySchema { get; set; } = EventDeliverySchema.EventGridSchema;
613614

615+
[CmdletParameterBreakingChangeWithVersion("DeadLetterEndpoint", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
614616
[Parameter(
615617
Mandatory = false,
616618
ValueFromPipelineByPropertyName = true,
@@ -740,6 +742,7 @@ public class NewAzureEventGridSubscription : AzureEventGridCmdletBase
740742
[ValidateNotNullOrEmpty]
741743
public Hashtable[] AdvancedFilter { get; set; }
742744

745+
[CmdletParameterBreakingChangeWithVersion("MaxEventsPerBatch", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
743746
[Parameter(
744747
Mandatory = false,
745748
ValueFromPipelineByPropertyName = true,
@@ -783,6 +786,7 @@ public class NewAzureEventGridSubscription : AzureEventGridCmdletBase
783786
[ValidateRange(1, 5000)]
784787
public int MaxEventsPerBatch { get; set; }
785788

789+
[CmdletParameterBreakingChangeWithVersion("PreferredBatchSizeInKiloByte", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
786790
[Parameter(
787791
Mandatory = false,
788792
ValueFromPipelineByPropertyName = true,
@@ -826,6 +830,7 @@ public class NewAzureEventGridSubscription : AzureEventGridCmdletBase
826830
[ValidateRange(1, 1024)]
827831
public int PreferredBatchSizeInKiloByte { get; set; }
828832

833+
[CmdletParameterBreakingChangeWithVersion("AzureActiveDirectoryTenantId", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
829834
[Parameter(
830835
Mandatory = false,
831836
ValueFromPipelineByPropertyName = true,
@@ -869,6 +874,7 @@ public class NewAzureEventGridSubscription : AzureEventGridCmdletBase
869874
[Alias(AliasAadTenantId)]
870875
public string AzureActiveDirectoryTenantId { get; set; }
871876

877+
[CmdletParameterBreakingChangeWithVersion("AzureActiveDirectoryApplicationIdOrUri", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
872878
[Parameter(
873879
Mandatory = false,
874880
ValueFromPipelineByPropertyName = true,
@@ -954,6 +960,7 @@ public class NewAzureEventGridSubscription : AzureEventGridCmdletBase
954960
ParameterSetName = EventSubscriptionDomainTopicInputObjectParameterSet)]
955961
public SwitchParameter AdvancedFilteringOnArray { get; set; }
956962

963+
[CmdletParameterBreakingChangeWithVersion("DeliveryAttributeMapping", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
957964
[Parameter(
958965
Mandatory = false,
959966
ValueFromPipelineByPropertyName = true,
@@ -996,6 +1003,7 @@ public class NewAzureEventGridSubscription : AzureEventGridCmdletBase
9961003
ParameterSetName = EventSubscriptionDomainTopicInputObjectParameterSet)]
9971004
public Hashtable[] DeliveryAttributeMapping { get; set; }
9981005

1006+
[CmdletParameterBreakingChangeWithVersion("StorageQueueMessageTtl", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
9991007
[Parameter(
10001008
Mandatory = false,
10011009
ValueFromPipelineByPropertyName = true,

‎src/EventGrid/EventGrid/EventSubscription/RemoveAzureEventGridSubscription.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
using Microsoft.Azure.Commands.EventGrid.Models;
1717
using Microsoft.Azure.Commands.EventGrid.Utilities;
1818
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
19+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
1920

2021
namespace Microsoft.Azure.Commands.EventGrid
2122
{
@@ -28,6 +29,7 @@ namespace Microsoft.Azure.Commands.EventGrid
2829

2930
public class RemoveAzureRmEventGridSubscription : AzureEventGridCmdletBase
3031
{
32+
[CmdletParameterBreakingChangeWithVersion("ResourceId", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
3133
[Parameter(
3234
Mandatory = true,
3335
ValueFromPipelineByPropertyName = true,
@@ -46,6 +48,7 @@ public class RemoveAzureRmEventGridSubscription : AzureEventGridCmdletBase
4648
[ValidateNotNullOrEmpty]
4749
public PSTopic InputObject { get; set; }
4850

51+
[CmdletParameterBreakingChangeWithVersion("DomainInputObject", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
4952
[Parameter(
5053
Mandatory = true,
5154
ValueFromPipeline = true,
@@ -55,6 +58,7 @@ public class RemoveAzureRmEventGridSubscription : AzureEventGridCmdletBase
5558
[ValidateNotNullOrEmpty]
5659
public PSDomain DomainInputObject { get; set; }
5760

61+
[CmdletParameterBreakingChangeWithVersion("DomainTopicInputObject", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
5862
[Parameter(
5963
Mandatory = true,
6064
ValueFromPipeline = true,
@@ -122,6 +126,7 @@ public class RemoveAzureRmEventGridSubscription : AzureEventGridCmdletBase
122126
[ValidateNotNullOrEmpty]
123127
public string EventSubscriptionName { get; set; }
124128

129+
[CmdletParameterBreakingChangeWithVersion("ResourceGroupName", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
125130
[Parameter(
126131
Mandatory = true,
127132
ValueFromPipelineByPropertyName = true,
@@ -145,6 +150,7 @@ public class RemoveAzureRmEventGridSubscription : AzureEventGridCmdletBase
145150
[Alias(AliasResourceGroup)]
146151
public string ResourceGroupName { get; set; }
147152

153+
[CmdletParameterBreakingChangeWithVersion("TopicName", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
148154
[Parameter(
149155
Mandatory = true,
150156
ValueFromPipelineByPropertyName = true,
@@ -154,6 +160,7 @@ public class RemoveAzureRmEventGridSubscription : AzureEventGridCmdletBase
154160
[ValidateNotNullOrEmpty]
155161
public string TopicName { get; set; }
156162

163+
[CmdletParameterBreakingChangeWithVersion("DomainName", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
157164
[Parameter(
158165
Mandatory = true,
159166
ValueFromPipelineByPropertyName = true,
@@ -163,6 +170,7 @@ public class RemoveAzureRmEventGridSubscription : AzureEventGridCmdletBase
163170
[ValidateNotNullOrEmpty]
164171
public string DomainName { get; set; }
165172

173+
[CmdletParameterBreakingChangeWithVersion("DomainTopicName", "12.0.0", "2.0.0", ChangeDescription = "This parameter will be deprecated.")]
166174
[Parameter(
167175
Mandatory = false,
168176
ValueFromPipelineByPropertyName = true,

0 commit comments

Comments
 (0)