powershell command for internet ingress property (#24000)

Author: amansahotra-ms

src/Network/Network/Common/NetworkResourceManagerProfile.cs

@@ -2216,6 +2216,7 @@ private static void Initialize()
                 cfg.CreateMap<CNM.PSVirtualApplianceSite, MNM.VirtualApplianceSite>();
                 cfg.CreateMap<CNM.PSVirtualApplianceSkuProperties, MNM.VirtualApplianceSkuProperties>();
                 cfg.CreateMap<CNM.PSNetworkVirtualApplianceConnection, MNM.NetworkVirtualApplianceConnection>();
+                cfg.CreateMap<CNM.PSVirtualApplianceInternetIngressIpsProperties, MNM.InternetIngressPublicIpsProperties>();
                 cfg.CreateMap<CNM.PSNetworkVirtualApplianceDelegationProperties, MNM.DelegationProperties>();
 
                 // MNM to CNM
@@ -2238,6 +2239,7 @@ private static void Initialize()
                 cfg.CreateMap<MNM.VirtualApplianceSite, CNM.PSVirtualApplianceSite>();
                 cfg.CreateMap<MNM.VirtualApplianceSkuProperties, CNM.PSVirtualApplianceSkuProperties>();
                 cfg.CreateMap<MNM.VirtualApplianceAdditionalNicProperties, CNM.PSVirtualApplianceAdditionalNicProperties>();
+                cfg.CreateMap<MNM.InternetIngressPublicIpsProperties, CNM.PSVirtualApplianceInternetIngressIpsProperties>();
                 cfg.CreateMap<MNM.NetworkVirtualApplianceConnection,CNM.PSNetworkVirtualApplianceConnection>();
                 cfg.CreateMap<MNM.DelegationProperties, CNM.PSNetworkVirtualApplianceDelegationProperties>();
 

src/Network/Network/Models/PSNetworkVirtualAppliance.cs

@@ -48,5 +48,7 @@ public class PSNetworkVirtualAppliance : PSTopLevelResource
         public IList<PSVirtualApplianceAdditionalNicProperties> AdditionalNics { get; set; }
 
         public PSNetworkVirtualApplianceDelegationProperties Delegation { get; set; }
+
+        public IList<PSVirtualApplianceInternetIngressIpsProperties> InternetIngressPublicIps { get; set; }
     }
 }

src/Network/Network/Models/PSVirtualApplianceInternetIngressIpsProperties.cs

@@ -0,0 +1,27 @@
+// ----------------------------------------------------------------------------------
+//
+// 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 PSVirtualApplianceInternetIngressIpsProperties
+    {
+        public string Id { get; set; }
+    }
+}

src/Network/Network/NetworkVirtualAppliance/InternetIngressProperties/NewVirtualApplianceInternetIngressIpsProperties.cs

@@ -0,0 +1,54 @@
+// ----------------------------------------------------------------------------------
+//
+// 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 + "VirtualApplianceInternetIngressIpsProperty",
+        SupportsShouldProcess = true),
+        OutputType(typeof(PSVirtualApplianceInternetIngressIpsProperties))]
+    public class NewVirtualApplianceInternetIngressIpsPropertyCommand : VirtualApplianceInternetIngressIpsPropertiesBaseCmdlet
+    {
+        [Parameter(
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = false,
+            HelpMessage = "The Public IPs for Internet Ingress.")]
+        [ValidateNotNullOrEmpty]
+        public string[] InternetIngressPublicIpId { get; set; }
+
+        public override void Execute()
+        {
+            base.Execute();
+
+            int elements = InternetIngressPublicIpId.Length;
+            var InternetIngressIpsList = new List<PSVirtualApplianceInternetIngressIpsProperties>();
+
+            for (int i = 0; i < elements; i++)
+            {
+                var currentelement = new PSVirtualApplianceInternetIngressIpsProperties();
+                currentelement.Id = InternetIngressPublicIpId[i];
+                InternetIngressIpsList.Add(currentelement);
+            }
+
+            WriteObject(InternetIngressIpsList, true);
+
+        }
+    }
+}

src/Network/Network/NetworkVirtualAppliance/InternetIngressProperties/VirtualApplianceInternetIngressPropertiesIpsBaseCmdlet.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 VirtualApplianceInternetIngressIpsPropertiesBaseCmdlet : NetworkBaseCmdlet
+    {
+        // Empty class for future development of Get/Set/Update commands.
+    }
+}

src/Network/Network/NetworkVirtualAppliance/NewNetworkVirtualApplianceCommand.cs

@@ -137,6 +137,13 @@ public class NewNetworkVirtualApplianceCommand : NetworkVirtualApplianceBaseCmdl
         [ValidateNotNullOrEmpty]
         public PSVirtualApplianceAdditionalNicProperties[] AdditionalNic { get; set; }
 
+        [Parameter(
+          Mandatory = false,
+          ValueFromPipelineByPropertyName = true,
+          HelpMessage = "The Internet Ingress IPs Properties of the Virtual Appliance.")]
+        [ValidateNotNullOrEmpty]
+        public PSVirtualApplianceInternetIngressIpsProperties[] InternetIngressIp { get; set; }
+
         public override void Execute()
         {
             base.Execute();
@@ -182,6 +189,11 @@ private PSNetworkVirtualAppliance CreateNetworkVirtualAppliance()
                 networkVirtualAppliance.AdditionalNics = AdditionalNic;
             }
 
+            if (InternetIngressIp != null)
+            {
+                networkVirtualAppliance.InternetIngressPublicIps = InternetIngressIp;
+            }
+
             var networkVirtualApplianceModel = NetworkResourceManagerProfile.Mapper.Map<MNM.NetworkVirtualAppliance>(networkVirtualAppliance);
 
             networkVirtualApplianceModel.Tags = TagsConversionHelper.CreateTagDictionary(this.Tag, validate: true);

src/Network/Network/help/New-AzNetworkVirtualAppliance.md

@@ -18,7 +18,7 @@ New-AzNetworkVirtualAppliance -Name <String> -ResourceGroupName <String> -Locati
  -VirtualHubId <String> -Sku <PSVirtualApplianceSkuProperties> -VirtualApplianceAsn <Int32>
  [-Identity <PSManagedServiceIdentity>] [-BootStrapConfigurationBlob <String[]>]
  [-CloudInitConfigurationBlob <String[]>] [-CloudInitConfiguration <String>] [-Tag <Hashtable>] [-Force]
- [-AsJob] [-AdditionalNic <PSVirtualApplianceAdditionalNicProperties[]>]
+ [-AsJob] [-AdditionalNic <PSVirtualApplianceAdditionalNicProperties[]>] [-InternetIngressIp <PSVirtualApplianceInternetIngressIpsProperties[]>]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -28,7 +28,7 @@ New-AzNetworkVirtualAppliance -ResourceId <String> -Location <String> -VirtualHu
  -Sku <PSVirtualApplianceSkuProperties> -VirtualApplianceAsn <Int32> [-Identity <PSManagedServiceIdentity>]
  [-BootStrapConfigurationBlob <String[]>] [-CloudInitConfigurationBlob <String[]>]
  [-CloudInitConfiguration <String>] [-Tag <Hashtable>] [-Force] [-AsJob]
- [-AdditionalNic <PSVirtualApplianceAdditionalNicProperties[]>] [-DefaultProfile <IAzureContextContainer>]
+ [-AdditionalNic <PSVirtualApplianceAdditionalNicProperties[]>] [-InternetIngressIp <PSVirtualApplianceInternetIngressIpsProperties[]>] [-DefaultProfile <IAzureContextContainer>]
  [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -61,6 +61,19 @@ $nva=New-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva -Location
 
 Creates a new Network Virtual Appliance resource in resource group: testrg with additional nic "sdwan" and a public IP attached to "sdwan" nic.
 
+### Example 3
+```powershell
+$sku=New-AzVirtualApplianceSkuProperty -VendorName "ciscosdwantest" -BundledScaleUnit 4 -MarketPlaceVersion '17.6.03'
+$hub=Get-AzVirtualHub -ResourceGroupName testrg -Name hub
+$id1 = "/subscriptions/{subscriptionid}/resourceGroups/testrg/providers/Microsoft.Network/publicIPAddresses/{publicip1name}"
+$pip2 = Get-AzPublicIpAddress -Name publicip2name
+$id2 = $pip2.Id
+$IngressIps=New-AzVirtualApplianceInternetIngressIpsProperty -InternetIngressPublicIpId $id1, $id2
+$nva=New-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva -Location eastus2 -VirtualApplianceAsn 65222 -VirtualHubId $hub.Id -Sku $sku -CloudInitConfiguration "echo Hello World!" -InternetIngressIp $IngressIps
+```
+
+Creates a new Network Virtual Appliance resource in resource group: testrg with 2 Internet Ingress Public IPs attached to it.
+
 ## PARAMETERS
 
 ### -AdditionalNic
@@ -183,6 +196,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -InternetIngressIp
+The Internet Ingress IPs to be attached to the Virtual Appliance.
+
+```yaml
+Type: Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceInternetIngressIpsProperties[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -Location
 The public IP address location.
 

src/Network/Network/help/New-AzVirtualApplianceInternetIngressIpsProperty.md

@@ -0,0 +1,114 @@
+---
+external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
+Module Name: Az.Network
+online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualapplianceinternetingressipsproperty
+schema: 2.0.0
+---
+
+# New-AzVirtualApplianceInternetIngressIpsProperty
+
+## SYNOPSIS
+Define a Network Virtual Appliance Internet Ingress IPs Property for the resource.
+
+## SYNTAX
+
+```
+New-AzVirtualApplianceInternetIngressIpsProperty -InternetIngressPublicIpId <String> 
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+The New-AzVirtualApplianceInternetIngressIpsProperty command defines Public IPs which can be attached for Internet Ingress with Network Virtual Appliance resource.
+
+## EXAMPLES
+
+### Example 1
+```powershell
+$IngressIps=New-AzVirtualApplianceInternetIngressIpsProperty -InternetIngressPublicIpId "/subscriptions/{subscriptionid}/resourceGroups/{rgname}/providers/Microsoft.Network/publicIPAddresses/{publicipname}"
+```
+
+Create an Internet Ingress Property object to be used with New-AzNetworkVirtualAppliance command.
+
+### Example 2
+```powershell
+$IngressIps=New-AzVirtualApplianceInternetIngressIpsProperty -InternetIngressPublicIpId "/subscriptions/{subscriptionid}/resourceGroups/{rgname}/providers/Microsoft.Network/publicIPAddresses/{publicipname}", "/subscriptions/{subscriptionid}/resourceGroups/{rgname}/providers/Microsoft.Network/publicIPAddresses/{publicipname}"
+```
+
+Creates a list of Internet Ingress Property object which has 2 Public IPs which can be attached to the Network Virtual Appliance resource.
+
+## PARAMETERS
+
+### -DefaultProfile
+The credentials, account, tenant, and subscription used for communication with Azure.
+
+```yaml
+Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
+Parameter Sets: (All)
+Aliases: AzContext, AzureRmContext, AzureCredential
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -InternetIngressPublicIpId
+The IDs of the Public IPs which can be given as comma separated input.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceInternetIngressIpsProperties
+
+## NOTES
+
+## RELATED LINKS