Bug Fix for Viewing the PSPublicIpAddress & PSDdosProtectionPlan objects (#19981)

mchakka · Manas Chakka · BethanyZhou · web-flow · commit e511b9bf0e5f · 2022-12-15T11:24:42.000+08:00
* bug fixes

* small synatx fix

* fixing indents

* moving change log message

* Update src/Network/Network/Network.format.ps1xml

* Update src/Network/Network/ChangeLog.md

* Update src/Network/Network/Network.format.ps1xml

* adding breaking change file

Co-authored-by: Manas Chakka &lt;manaschakka@microsoft.com&gt;
Co-authored-by: Beisi Zhou &lt;zhoubeisi@gmail.com&gt;
diff --git a/src/Network/Network/ChangeLog.md b/src/Network/Network/ChangeLog.md
@@ -19,6 +19,7 @@
 --->
 
 ## Upcoming Release
+* Fixed a bug that added Ddos related properties when viewing PublicIpAddress and DdosProtectionPlan objects
 
 ## Version 5.2.0
 * Added optional parameters `CustomBlockResponseStatusCode` and `CustomBlockResponseBody` parameter to `AzApplicationGatewayFirewallPolicySettings`
diff --git a/src/Network/Network/Models/PSDdosProtectionPlan.cs b/src/Network/Network/Models/PSDdosProtectionPlan.cs
@@ -26,7 +26,7 @@ public class PSDdosProtectionPlan : PSTopLevelResource
 
         public List<PSResourceId> VirtualNetworks { get; set; }
 
-        public List<PSResourceId> PublicIpAddresses { get; set; }
+        public List<PSResourceId> PublicIPAddresses { get; set; }
 
         [JsonIgnore]
         public string VirtualNetworksText
@@ -35,9 +35,9 @@ public string VirtualNetworksText
         }
 
         [JsonIgnore]
-        public string PublicIpAddressesText
+        public string PublicIPAddressesText
         {
-            get { return JsonConvert.SerializeObject(PublicIpAddresses, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
+            get { return JsonConvert.SerializeObject(PublicIPAddresses, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
         }
     }
 }
diff --git a/src/Network/Network/Models/PSDdosSettings.cs b/src/Network/Network/Models/PSDdosSettings.cs
@@ -12,10 +12,13 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Microsoft.WindowsAzure.Commands.Common.Attributes;
+
 namespace Microsoft.Azure.Commands.Network.Models
 {
     public partial class PSDdosSettings
     {
-        public string ProtectionMode;
+        [Ps1Xml(Target = ViewControl.Table)]
+        public string ProtectionMode { get; set; }
     }
 }
diff --git a/src/Network/Network/Models/PSPublicIpAddress.cs b/src/Network/Network/Models/PSPublicIpAddress.cs
@@ -57,6 +57,12 @@ public string IpConfigurationText
             get { return JsonConvert.SerializeObject(IpConfiguration, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
         }
 
+        [JsonIgnore]
+        public string DdosSettingsText
+        {
+            get { return JsonConvert.SerializeObject(DdosSettings, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
+        }
+
         [JsonIgnore]
         public string DnsSettingsText
         {
diff --git a/src/Network/Network/Network.format.ps1xml b/src/Network/Network/Network.format.ps1xml
@@ -983,15 +983,15 @@
               <ListItem>
                 <Label>CustomRoutes</Label>
                 <PropertyName>CustomRoutesText</PropertyName>
-              </ListItem>			  
+              </ListItem>       
               <ListItem>
                 <Label>NatRules</Label>
                 <PropertyName>NatRulesText</PropertyName>
               </ListItem>
-			  <ListItem>
-				<Label>ExtendedLocation</Label>
-				<PropertyName>ExtendedLocationText</PropertyName>
-			  </ListItem>
+              <ListItem>
+                <Label>ExtendedLocation</Label>
+                <PropertyName>ExtendedLocationText</PropertyName>
+              </ListItem>
               <ListItem>
                 <Label>EnableBgpRouteTranslationForNat</Label>
                 <PropertyName>EnableBgpRouteTranslationForNat</PropertyName>
@@ -1578,6 +1578,10 @@
                 <Label>DnsSettings</Label>
                 <PropertyName>DnsSettingsText</PropertyName>
               </ListItem>
+              <ListItem>
+                <Label>DdosSettings</Label>
+                <PropertyName>DdosSettingsText</PropertyName>
+              </ListItem>
               <ListItem>
                 <Label>Zones</Label>
                 <PropertyName>Zones</PropertyName>
@@ -4089,6 +4093,10 @@
                 <Label>VirtualNetworks</Label>
                 <PropertyName>VirtualNetworksText</PropertyName>
               </ListItem>
+              <ListItem>
+                <Label>PublicIPAddresses</Label>
+                <PropertyName>PublicIPAddressesText</PropertyName>
+              </ListItem>
             </ListItems>
           </ListEntry>
         </ListEntries>
@@ -5361,19 +5369,19 @@
                 <Label>ExtendedLocation</Label>
                 <PropertyName>ExtendedLocationText</PropertyName>
               </ListItem>
-			  <ListItem>
-				<Label>ApplicationSecurityGroups</Label>
-				<PropertyName>ApplicationSecurityGroupsText</PropertyName>
-			  </ListItem>
-			  <ListItem>
-				<Label>IpConfigurations</Label>
-				<PropertyName>IpConfigurationsText</PropertyName>
-			  </ListItem>
-			  <ListItem>
-				<Label>CustomNetworkInterfaceName</Label>
-				<PropertyName>CustomNetworkInterfaceName</PropertyName>
-			  </ListItem>
-			</ListItems>
+              <ListItem>
+                <Label>ApplicationSecurityGroups</Label>
+                <PropertyName>ApplicationSecurityGroupsText</PropertyName>
+              </ListItem>
+              <ListItem>
+                <Label>IpConfigurations</Label>
+                <PropertyName>IpConfigurationsText</PropertyName>
+              </ListItem>
+              <ListItem>
+                <Label>CustomNetworkInterfaceName</Label>
+                <PropertyName>CustomNetworkInterfaceName</PropertyName>
+              </ListItem>
+            </ListItems>
           </ListEntry>
         </ListEntries>
       </ListControl>
diff --git a/tools/StaticAnalysis/Exceptions/Az.Network/BreakingChangeIssues.csv b/tools/StaticAnalysis/Exceptions/Az.Network/BreakingChangeIssues.csv
@@ -0,0 +1,5 @@
+Module,ClassName,Target,Severity,ProblemId,Description,Remediation
+"""Az.Network""",Microsoft.Azure.Commands.Network.Automation.GetAzureRmDdosProtectionPlan,Get-AzDdosProtectionPlan,0,3010,The property 'PublicIpAddresses' of type 'Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan' has been removed.,Add the property 'PublicIpAddresses' back to type 'Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan'.
+"""Az.Network""",Microsoft.Azure.Commands.Network.Automation.GetAzureRmDdosProtectionPlan,Get-AzDdosProtectionPlan,0,3010,The property 'PublicIpAddressesText' of type 'Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan' has been removed.,Add the property 'PublicIpAddressesText' back to type 'Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan'.
+"""Az.Network""",Microsoft.Azure.Commands.Network.NewAzureRmDdosProtectionPlan,New-AzDdosProtectionPlan,0,3010,The property 'PublicIpAddresses' of type 'Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan' has been removed.,Add the property 'PublicIpAddresses' back to type 'Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan'.
+"""Az.Network""",Microsoft.Azure.Commands.Network.NewAzureRmDdosProtectionPlan,New-AzDdosProtectionPlan,0,3010,The property 'PublicIpAddressesText' of type 'Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan' has been removed.,Add the property 'PublicIpAddressesText' back to type 'Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan'.

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public class PSDdosProtectionPlan : PSTopLevelResource`
`26`	`26`
`27`	`27`	`public List<PSResourceId> VirtualNetworks { get; set; }`
`28`	`28`
`29`		`- public List<PSResourceId> PublicIpAddresses { get; set; }`
	`29`	`+ public List<PSResourceId> PublicIPAddresses { get; set; }`
`30`	`30`
`31`	`31`	`[JsonIgnore]`
`32`	`32`	`public string VirtualNetworksText`
`@@ -35,9 +35,9 @@ public string VirtualNetworksText`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`[JsonIgnore]`
`38`		`- public string PublicIpAddressesText`
	`38`	`+ public string PublicIPAddressesText`
`39`	`39`	`{`
`40`		`- get { return JsonConvert.SerializeObject(PublicIpAddresses, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }`
	`40`	`+ get { return JsonConvert.SerializeObject(PublicIPAddresses, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,13 @@`
`12`	`12`	`// limitations under the License.`
`13`	`13`	`// ----------------------------------------------------------------------------------`
`14`	`14`
	`15`	`+using Microsoft.WindowsAzure.Commands.Common.Attributes;`
	`16`	`+`
`15`	`17`	`namespace Microsoft.Azure.Commands.Network.Models`
`16`	`18`	`{`
`17`	`19`	`public partial class PSDdosSettings`
`18`	`20`	`{`
`19`		`- public string ProtectionMode;`
	`21`	`+ [Ps1Xml(Target = ViewControl.Table)]`
	`22`	`+ public string ProtectionMode { get; set; }`
`20`	`23`	`}`
`21`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,12 @@ public string IpConfigurationText`
`57`	`57`	`get { return JsonConvert.SerializeObject(IpConfiguration, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }`
`58`	`58`	`}`
`59`	`59`
	`60`	`+ [JsonIgnore]`
	`61`	`+ public string DdosSettingsText`
	`62`	`+ {`
	`63`	`+ get { return JsonConvert.SerializeObject(DdosSettings, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }`
	`64`	`+ }`
	`65`	`+`
`60`	`66`	`[JsonIgnore]`
`61`	`67`	`public string DnsSettingsText`
`62`	`68`	`{`