Added Support for Network Profile in Virtual Appliance (#24866)

* Added Support for Network Profile in Virtual Appliance

* Added online version in md files

* Minor fixes in md files and splitting the cmdlets in separate files

* Added network profile in test

* Fixed CI Signature Issues

* Minor fix in example

---------

Co-authored-by: Yan Xu <[email protected]>

Author: vimalcha

src/Network/Network.Test/ScenarioTests/NetworkVirtualApplianceTests.ps1

@@ -51,7 +51,17 @@ function Test-NetworkVirtualApplianceCRUD
 
         $wan = New-AzVirtualWan -ResourceGroupName $rgname -Name $wanname -Location $location
         $hub = New-AzVirtualHub -ResourceGroupName $rgname -Name $hubname -Location $location -VirtualWan $wan -AddressPrefix $prefix
-        $nva = New-AzNetworkVirtualAppliance -ResourceGroupName $rgname -Name $nvaname -Location $location -VirtualApplianceAsn $asn -VirtualHubId $hub.Id -Sku $sku -CloudInitConfiguration "echo hi" 
+
+        $ipConfig1 = New-AzVirtualApplianceIpConfiguration -Name "publicnicipconfig" -Primary $true
+        $ipConfig2 = New-AzVirtualApplianceIpConfiguration -Name "publicnicipconfig-2" -Primary $false
+        $nicConfig1 = New-AzVirtualApplianceNetworkInterfaceConfiguration -NicType "PublicNic" -IpConfiguration $ipConfig1, $ipConfig2
+        $ipConfig3 = New-AzVirtualApplianceIpConfiguration -Name "privatenicipconfig" -Primary $true
+        $ipConfig4 = New-AzVirtualApplianceIpConfiguration -Name "privatenicipconfig-2" -Primary $false
+        $nicConfig2 = New-AzVirtualApplianceNetworkInterfaceConfiguration -NicType "PrivateNic" -IpConfiguration $ipConfig3, $ipConfig4
+        $networkProfile = New-AzVirtualApplianceNetworkProfile -NetworkInterfaceConfiguration $nicConfig1, $nicConfig2
+
+        $nva = New-AzNetworkVirtualAppliance -ResourceGroupName $rgname -Name $nvaname -Location $location -VirtualApplianceAsn $asn -VirtualHubId $hub.Id -Sku $sku -CloudInitConfiguration "echo hi" -NetworkProfile $networkProfile
+
         Assert-NotNull $nva
 
         $getnva = Get-AzNetworkVirtualAppliance -ResourceGroupName $rgname -Name $nvaname

src/Network/Network/Az.Network.psd1

@@ -638,7 +638,10 @@ CmdletsToExport = 'Add-AzApplicationGatewayAuthenticationCertificate',
                'Test-AzPrivateIPAddressAvailability', 
                'Test-AzPrivateLinkServiceVisibility', 'Update-AzCustomIpPrefix', 
                'Update-AzNetworkVirtualApplianceConnection', 
-               'New-AzVirtualApplianceInternetIngressIpsProperty', 
+               'New-AzVirtualApplianceInternetIngressIpsProperty',
+               'New-AzVirtualApplianceNetworkProfile',
+               'New-AzVirtualApplianceNetworkInterfaceConfiguration',
+               'New-AzVirtualApplianceIpConfiguration',
                'New-AzVirtualApplianceInboundSecurityRulesProperty', 
                'Update-AzVirtualApplianceInboundSecurityRule', 
                'New-AzFirewallPacketCaptureRule', 

src/Network/Network/ChangeLog.md

@@ -19,6 +19,8 @@
 --->
 
 ## Upcoming Release
+* Added cmdlet `New-AzVirtualApplianceNetworkProfile` to build network profile for network virtual appliance and pass as a parameter.
+* Added cmdlet `New-AzVirtualApplianceNetworkInterfaceConfiguration` and `New-AzVirtualApplianceIpConfiguration` to build `New-AzVirtualApplianceNetworkProfile`.
 * Added support for ApplicationGatewaySkuFamily 
 * Updated cmdlet to add the property of JSChallengeCookieExpirationInMins
     - `New-AzApplicationGatewayFirewallPolicySetting`

src/Network/Network/Common/NetworkResourceManagerProfile.cs

@@ -2222,6 +2222,7 @@ private static void Initialize()
                 cfg.CreateMap<CNM.PSInboundSecurityRulesProperty, MNM.InboundSecurityRules>();
                 cfg.CreateMap<CNM.PSNetworkVirtualApplianceConnection, MNM.NetworkVirtualApplianceConnection>();
                 cfg.CreateMap<CNM.PSVirtualApplianceInternetIngressIpsProperties, MNM.InternetIngressPublicIpsProperties>();
+                cfg.CreateMap<CNM.PSVirtualApplianceNetworkProfile, MNM.NetworkVirtualAppliancePropertiesFormatNetworkProfile>();
                 cfg.CreateMap<CNM.PSNetworkVirtualApplianceDelegationProperties, MNM.DelegationProperties>();
 
                 // MNM to CNM
@@ -2247,6 +2248,7 @@ private static void Initialize()
                 cfg.CreateMap<MNM.InboundSecurityRules, CNM.PSInboundSecurityRulesProperty>();
                 cfg.CreateMap<MNM.VirtualApplianceAdditionalNicProperties, CNM.PSVirtualApplianceAdditionalNicProperties>();
                 cfg.CreateMap<MNM.InternetIngressPublicIpsProperties, CNM.PSVirtualApplianceInternetIngressIpsProperties>();
+                cfg.CreateMap<MNM.NetworkVirtualAppliancePropertiesFormatNetworkProfile, CNM.PSVirtualApplianceNetworkProfile>();
                 cfg.CreateMap<MNM.NetworkVirtualApplianceConnection,CNM.PSNetworkVirtualApplianceConnection>();
                 cfg.CreateMap<MNM.DelegationProperties, CNM.PSNetworkVirtualApplianceDelegationProperties>();
 

src/Network/Network/Models/PSNetworkVirtualAppliance.cs

@@ -50,5 +50,7 @@ public class PSNetworkVirtualAppliance : PSTopLevelResource
         public PSNetworkVirtualApplianceDelegationProperties Delegation { get; set; }
 
         public IList<PSVirtualApplianceInternetIngressIpsProperties> InternetIngressPublicIps { get; set; }
+
+        public PSVirtualApplianceNetworkProfile NetworkProfile { get; set; }
     }
 }

src/Network/Network/Models/PSVirtualApplianceNetworkProfile.cs

@@ -0,0 +1,49 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.Text;
+
+namespace Microsoft.Azure.Commands.Network.Models
+{
+    public class PSVirtualApplianceNetworkProfile
+    {
+        public List<PSVirtualApplianceNetworkInterfaceConfiguration> NetworkInterfaceConfigurations { get; set; }
+    }
+
+    public class PSVirtualApplianceNetworkInterfaceConfiguration
+    {
+        public string NicType { get; set; }
+        public PSVirtualApplianceNetworkInterfaceConfigurationProperties Properties { get; set; }
+    }
+
+    public class PSVirtualApplianceNetworkInterfaceConfigurationProperties
+    {
+        public List<PSVirtualApplianceIpConfiguration> IpConfigurations { get; set; }
+    }
+
+    public class PSVirtualApplianceIpConfiguration
+    {
+        public string Name { get; set; }
+        public PSVirtualApplianceIpConfigurationProperties Properties { get; set; }
+    }
+
+    public class PSVirtualApplianceIpConfigurationProperties
+    {
+        public bool Primary { get; set; }
+    }
+}

src/Network/Network/NetworkVirtualAppliance/NetworkProfile/NewVirtualApplianceIpConfigurationCommand.cs

@@ -0,0 +1,57 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using System;
+using System.Collections.Generic;
+using System.Management.Automation;
+using System.Text;
+using System.Linq;
+using Microsoft.Azure.Commands.Network.Models;
+
+namespace Microsoft.Azure.Commands.Network
+{
+    [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VirtualApplianceIpConfiguration",
+        SupportsShouldProcess = true),
+        OutputType(typeof(PSVirtualApplianceIpConfiguration))]
+    public class NewVirtualApplianceIpConfigurationCommand : VirtualApplianceNetworkProfileBaseCmdlet
+    {
+        [Parameter(
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = false,
+            HelpMessage = "The name of the IP configuration.")]
+        [ValidateNotNullOrEmpty]
+        public string Name { get; set; }
+
+        [Parameter(
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = false,
+            HelpMessage = "Indicates whether this IP configuration is the primary one.")]
+        [ValidateNotNullOrEmpty]
+        public bool Primary { get; set; }
+
+        public override void ExecuteCmdlet()
+        {
+            var ipConfiguration = new PSVirtualApplianceIpConfiguration
+            {
+                Name = this.Name,
+                Properties = new PSVirtualApplianceIpConfigurationProperties
+                {
+                    Primary = this.Primary
+                }
+            };
+
+            WriteObject(ipConfiguration);
+        }
+    }
+}

src/Network/Network/NetworkVirtualAppliance/NetworkProfile/NewVirtualApplianceNetworkInterfaceConfigurationCommand.cs

@@ -0,0 +1,57 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using System;
+using System.Collections.Generic;
+using System.Management.Automation;
+using System.Text;
+using System.Linq;
+using Microsoft.Azure.Commands.Network.Models;
+
+namespace Microsoft.Azure.Commands.Network
+{
+    [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VirtualApplianceNetworkInterfaceConfiguration",
+        SupportsShouldProcess = true),
+        OutputType(typeof(PSVirtualApplianceNetworkInterfaceConfiguration))]
+    public class NewVirtualApplianceNetworkInterfaceConfigurationCommand : VirtualApplianceNetworkProfileBaseCmdlet
+    {
+        [Parameter(
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = false,
+            HelpMessage = "The type of the network interface e.g., PublicNic or PrivateNic")]
+        [ValidateNotNullOrEmpty]
+        public string NicType { get; set; }
+
+        [Parameter(
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = false,
+            HelpMessage = "The IP configurations of the network interface configuration.")]
+        [ValidateNotNullOrEmpty]
+        public PSVirtualApplianceIpConfiguration[] IpConfiguration { get; set; }
+
+        public override void ExecuteCmdlet()
+        {
+            var networkInterfaceConfiguration = new PSVirtualApplianceNetworkInterfaceConfiguration
+            {
+                NicType = this.NicType,
+                Properties = new PSVirtualApplianceNetworkInterfaceConfigurationProperties
+                {
+                    IpConfigurations = this.IpConfiguration.ToList()
+                }
+            };
+
+            WriteObject(networkInterfaceConfiguration);
+        }
+    }
+}

src/Network/Network/NetworkVirtualAppliance/NetworkProfile/NewVirtualApplianceNetworkProfileCommand.cs

@@ -0,0 +1,46 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using System;
+using System.Collections.Generic;
+using System.Management.Automation;
+using System.Text;
+using System.Linq;
+using Microsoft.Azure.Commands.Network.Models;
+
+namespace Microsoft.Azure.Commands.Network
+{
+    [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VirtualApplianceNetworkProfile",
+        SupportsShouldProcess = true),
+        OutputType(typeof(PSVirtualApplianceNetworkProfile))]
+    public class NewVirtualApplianceNetworkProfileCommand : VirtualApplianceNetworkProfileBaseCmdlet
+    {
+        [Parameter(
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = false,
+            HelpMessage = "The network interface configurations of the network profile.")]
+        [ValidateNotNullOrEmpty]
+        public PSVirtualApplianceNetworkInterfaceConfiguration[] NetworkInterfaceConfiguration { get; set; }
+
+        public override void ExecuteCmdlet()
+        {
+            var networkProfile = new PSVirtualApplianceNetworkProfile
+            {
+                NetworkInterfaceConfigurations = this.NetworkInterfaceConfiguration.ToList()
+            };
+
+            WriteObject(networkProfile);
+        }
+    }
+}

src/Network/Network/NetworkVirtualAppliance/NetworkProfile/VirtualApplianceNetworkProfileBaseCmdlet.cs

@@ -0,0 +1,26 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Microsoft.Azure.Commands.Network
+{
+    public class VirtualApplianceNetworkProfileBaseCmdlet : NetworkBaseCmdlet
+    {
+        // Empty class for future development of Get/Set/Update commands.
+    }
+}