Adding Autoscaling Capabilities to Virtual Network Gateway

src/Network/Network.Management.Sdk/Generated/Models/VirtualNetworkGatewaySkuTier.cs

@@ -33,5 +33,6 @@ public static class VirtualNetworkGatewaySkuTier
         public const string ErGw1AZ = "ErGw1AZ";
         public const string ErGw2AZ = "ErGw2AZ";
         public const string ErGw3AZ = "ErGw3AZ";
+        public const string ErGwScale = "ErGwScale";
     }
 }

src/Network/Network/ChangeLog.md

@@ -27,7 +27,7 @@
 
 ## Version 6.1.1
 * Onboarded `Microsoft.ElasticSan/elasticSans` to private link cmdlets
-
+* Added new changes to support autoscale for Virtual Network gateways
 ## Version 6.1.0
 * Added new cmdlets to get Connection child resource of Network Virtual Appliance.
     -`Get-AzNetworkVirtualApplianceConnection`

src/Network/Network/Models/PSVirtualNetworkGateway.cs

@@ -48,8 +48,11 @@ public class PSVirtualNetworkGateway : PSTopLevelResource
         [Ps1Xml(Label = "Sku Name", Target = ViewControl.Table, ScriptBlock = "$_.Sku.Name")]
         public PSVirtualNetworkGatewaySku Sku { get; set; }
 
-        public List<PSVirtualNetworkGatewayPolicyGroup> VirtualNetworkGatewayPolicyGroups { get; set; }
+        [Ps1Xml(Label = "AutoScaleConfiguration", Target = ViewControl.Table)]
+        public PSVirtualNetworkGatewayAutoscaleConfiguration AutoScaleConfiguration { get; set; }
 
+        public List<PSVirtualNetworkGatewayPolicyGroup> VirtualNetworkGatewayPolicyGroups { get; set; }
+
         public PSVpnClientConfiguration VpnClientConfiguration { get; set; }
 
         public PSBgpSettings BgpSettings { get; set; }

src/Network/Network/Models/PSVirtualNetworkGatewayAutoscaleConfiguration.cs

@@ -0,0 +1,32 @@
+//
+// Copyright (c) Microsoft.  All rights reserved.
+//
+// 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 Microsoft.WindowsAzure.Commands.Common.Attributes;
+using Newtonsoft.Json;
+
+namespace Microsoft.Azure.Commands.Network.Models
+{
+    public class PSVirtualNetworkGatewayAutoscaleConfiguration
+    {
+        [Ps1Xml(Target = ViewControl.Table)]
+        public PSVirtualNetworkGatewayPropertiesAutoScaleConfigurationBounds Bounds { get; set; }
+
+        [JsonIgnore]
+        public string BoundsText
+        {
+            get { return JsonConvert.SerializeObject(Bounds, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
+        }
+    }
+}

src/Network/Network/Models/PSVirtualNetworkGatewayPropertiesAutoScaleConfigurationBounds.cs

@@ -0,0 +1,14 @@
+
+using Microsoft.WindowsAzure.Commands.Common.Attributes;
+
+namespace Microsoft.Azure.Commands.Network.Models
+{
+    public class PSVirtualNetworkGatewayPropertiesAutoScaleConfigurationBounds
+    {
+        [Ps1Xml(Target = ViewControl.Table)]
+        public int Min { get; set; }
+
+        [Ps1Xml(Target = ViewControl.Table)]
+        public int Max { get; set; }
+    }
+}

src/Network/Network/Network.format.ps1xml

@@ -976,6 +976,10 @@
                 <Label>Sku</Label>
                 <PropertyName>SkuText</PropertyName>
               </ListItem>
+              <ListItem>
+                <Label>AutoScaleConfiguration</Label>
+                <PropertyName>AutoScaleConfigurationText</PropertyName>
+              </ListItem>
               <ListItem>
                 <Label>VpnClientConfiguration</Label>
                 <PropertyName>VpnClientConfigurationText</PropertyName>
@@ -6130,6 +6134,46 @@
         </ListEntries>
       </ListControl>
     </View>
+    <View>
+      <Name>Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayAutoscaleConfiguration</Name>
+      <ViewSelectedBy>
+        <TypeName>Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayAutoscaleConfiguration</TypeName>
+      </ViewSelectedBy>
+      <ListControl>
+        <ListEntries>
+          <ListEntry>
+            <ListItems>
+              <ListItem>
+                <Label>Bounds</Label>
+                <PropertyName>BoundsText</PropertyName>
+              </ListItem>
+            </ListItems>
+          </ListEntry>
+        </ListEntries>
+      </ListControl>
+    </View>
+    <View>
+      <Name>Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPropertiesAutoScaleConfigurationBounds</Name>
+      <ViewSelectedBy>
+        <TypeName>Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPropertiesAutoScaleConfigurationBounds</TypeName>
+      </ViewSelectedBy>
+      <ListControl>
+        <ListEntries>
+          <ListEntry>
+            <ListItems>
+              <ListItem>
+                <Label>Min</Label>
+                <PropertyName>Min</PropertyName>
+              </ListItem>
+              <ListItem>
+                <Label>Max</Label>
+                <PropertyName>Max</PropertyName>
+              </ListItem>
+            </ListItems>
+          </ListEntry>
+        </ListEntries>
+      </ListControl>
+    </View>
     <View>
       <Name>Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnectionIkeSaQuickModeSa</Name>
       <ViewSelectedBy>

src/Network/Network/VirtualNetworkGateway/NewAzureVirtualNetworkGatewayCommand.cs

@@ -29,7 +29,7 @@
 
 namespace Microsoft.Azure.Commands.Network
 {
-    [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VirtualNetworkGateway",SupportsShouldProcess = true,DefaultParameterSetName = VirtualNetworkGatewayParameterSets.Default),OutputType(typeof(PSVirtualNetworkGateway))]
+    [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VirtualNetworkGateway", SupportsShouldProcess = true, DefaultParameterSetName = VirtualNetworkGatewayParameterSets.Default), OutputType(typeof(PSVirtualNetworkGateway))]
     public class NewAzureVirtualNetworkGatewayCommand : VirtualNetworkGatewayBaseCmdlet
     {
         [Alias("ResourceName")]
@@ -144,6 +144,7 @@ public class NewAzureVirtualNetworkGatewayCommand : VirtualNetworkGatewayBaseCmd
             MNM.VirtualNetworkGatewaySkuTier.ErGw1AZ,
             MNM.VirtualNetworkGatewaySkuTier.ErGw2AZ,
             MNM.VirtualNetworkGatewaySkuTier.ErGw3AZ,
+            MNM.VirtualNetworkGatewaySkuTier.ErGwScale,
             IgnoreCase = true)]
         public string GatewaySku { get; set; }
 
@@ -313,6 +314,12 @@ public class NewAzureVirtualNetworkGatewayCommand : VirtualNetworkGatewayBaseCmd
         [Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]
         public SwitchParameter AsJob { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "Set min scale units for scalable gateways")]
+        public Int32 MinScaleUnit { get; set; }
+
+        [Parameter(Mandatory = false, HelpMessage = "Set max scale units for scalable gateways")]
+        public Int32 MaxScaleUnit { get; set; }
+
         [Parameter(
             Mandatory = false,
             ValueFromPipelineByPropertyName = true,
@@ -324,7 +331,7 @@ public class NewAzureVirtualNetworkGatewayCommand : VirtualNetworkGatewayBaseCmd
         [PSArgumentCompleter(
             "Enabled",
             "Disabled")]
-        public string AdminState  { get; set; }
+        public string AdminState { get; set; }
 
         public override void Execute()
         {
@@ -337,7 +344,7 @@ public override void Execute()
             var isCertConfigured = (this.VpnClientRootCertificates != null && this.VpnClientRootCertificates.Count() > 0) || (this.VpnClientRevokedCertificates != null && this.VpnClientRevokedCertificates.Count() > 0);
             var isRadiusConfigured = !string.IsNullOrEmpty(this.RadiusServerAddress) && this.RadiusServerSecret != null && !string.IsNullOrEmpty(SecureStringExtensions.ConvertToString(this.RadiusServerSecret));
             var isAadConfigured = this.AadTenantUri != null && this.AadAudienceId != null && this.AadIssuerUri != null;
-            
+
             if (!string.IsNullOrEmpty(GatewaySku)
                 && GatewaySku.Equals(MNM.VirtualNetworkGatewaySkuTier.UltraPerformance, StringComparison.InvariantCultureIgnoreCase))
             {
@@ -502,7 +509,7 @@ private PSVirtualNetworkGateway CreateVirtualNetworkGateway()
                     vnetGateway.VpnClientConfiguration.RadiusServerAddress = this.RadiusServerAddress;
                     vnetGateway.VpnClientConfiguration.RadiusServerSecret = SecureStringExtensions.ConvertToString(this.RadiusServerSecret);
                 }
-                
+
                 if (this.RadiusServerList != null && this.RadiusServerList.Any())
                 {
                     vnetGateway.VpnClientConfiguration.RadiusServers = this.RadiusServerList?.ToList();
@@ -543,12 +550,12 @@ private PSVirtualNetworkGateway CreateVirtualNetworkGateway()
 
                 if (this.ClientConnectionConfiguration != null && this.ClientConnectionConfiguration.Any())
                 {
-                    foreach( var config in this.ClientConnectionConfiguration)
+                    foreach (var config in this.ClientConnectionConfiguration)
                     {
-                        foreach (var policyGroup  in config.VirtualNetworkGatewayPolicyGroups)
+                        foreach (var policyGroup in config.VirtualNetworkGatewayPolicyGroups)
                         {
                             policyGroup.Id = string.Format("/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.Network/virtualNetworkGateways/{2}/virtualNetworkGatewayPolicyGroups/{3}", this.NetworkClient.NetworkManagementClient.SubscriptionId, vnetGateway.ResourceGroupName, Name, policyGroup.Id);
-                         }
+                        }
                     }
                     vnetGateway.VpnClientConfiguration.ClientConnectionConfigurations = this.ClientConnectionConfiguration.ToList();
                 }
@@ -580,12 +587,12 @@ private PSVirtualNetworkGateway CreateVirtualNetworkGateway()
 
             if (this.IpConfigurationBgpPeeringAddresses != null)
             {
-                if(vnetGateway.BgpSettings == null)
+                if (vnetGateway.BgpSettings == null)
                 {
                     vnetGateway.BgpSettings = new PSBgpSettings();
                 }
 
-                if(this.IpConfigurationBgpPeeringAddresses.Any(address => address.CustomBgpIpAddresses == null || !address.CustomBgpIpAddresses.Any()))
+                if (this.IpConfigurationBgpPeeringAddresses.Any(address => address.CustomBgpIpAddresses == null || !address.CustomBgpIpAddresses.Any()))
                 {
                     throw new ArgumentException("if IpConfigurationBgpPeeringAddresses are provided, CustomBgpIpAddresses must be a provided in create gateway");
                 }
@@ -598,7 +605,7 @@ private PSVirtualNetworkGateway CreateVirtualNetworkGateway()
                     vnetGateway.BgpSettings.BgpPeeringAddresses.Add(address);
                 }
             }
-            else if(vnetGateway.BgpSettings != null)
+            else if (vnetGateway.BgpSettings != null)
             {
                 vnetGateway.BgpSettings.BgpPeeringAddresses = null;
             }
@@ -639,7 +646,20 @@ private PSVirtualNetworkGateway CreateVirtualNetworkGateway()
 
                 vnetGateway.AdminState = this.AdminState;
             }
-
+
+            // set the min scale units and the max scale units
+            if (!string.IsNullOrEmpty(this.GatewaySku) && this.GatewaySku.Equals(MNM.VirtualNetworkGatewaySkuTier.ErGwScale))
+            {
+                if (this.MaxScaleUnit > 0 && this.MinScaleUnit > this.MaxScaleUnit)
+                {
+                   throw new PSArgumentException(string.Format(Properties.Resources.InvalidAutoScaleConfiguration, this.MinScaleUnit, this.MaxScaleUnit));
+                }
+
+                vnetGateway.AutoScaleConfiguration = new PSVirtualNetworkGatewayAutoscaleConfiguration();
+                vnetGateway.AutoScaleConfiguration.Bounds = new PSVirtualNetworkGatewayPropertiesAutoScaleConfigurationBounds();
+                vnetGateway.AutoScaleConfiguration.Bounds.Min = Convert.ToInt32(this.MinScaleUnit);
+                vnetGateway.AutoScaleConfiguration.Bounds.Max = (this.MaxScaleUnit > 0) ? Convert.ToInt32(this.MaxScaleUnit) : Convert.ToInt32(this.MinScaleUnit);    
+            }
             // Set the EnableBgpRouteTranslationForNat, if it is specified by customer.
             vnetGateway.EnableBgpRouteTranslationForNat = EnableBgpRouteTranslationForNat.IsPresent;
 
@@ -655,4 +675,4 @@ private PSVirtualNetworkGateway CreateVirtualNetworkGateway()
             return getVirtualNetworkGateway;
         }
     }
-}
+}

src/Network/Network/VirtualNetworkGateway/UpdateAzureVirtualNetworkGatewayCommand.cs

@@ -60,6 +60,7 @@ public class SetAzureVirtualNetworkGatewayCommand : VirtualNetworkGatewayBaseCmd
             MNM.VirtualNetworkGatewaySkuTier.ErGw1AZ,
             MNM.VirtualNetworkGatewaySkuTier.ErGw2AZ,
             MNM.VirtualNetworkGatewaySkuTier.ErGw3AZ,
+            MNM.VirtualNetworkGatewaySkuTier.ErGwScale,
             IgnoreCase = true)]
         public string GatewaySku { get; set; }
 
@@ -213,6 +214,11 @@ public class SetAzureVirtualNetworkGatewayCommand : VirtualNetworkGatewayBaseCmd
             HelpMessage = "This will enable and disable BgpRouteTranslationForNat on this VirtualNetworkGateway.")]
         public bool? BgpRouteTranslationForNat { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "Set min scale units for scalable gateways")]
+        public Int32 MinScaleUnit { get; set; }
+
+        [Parameter(Mandatory = false, HelpMessage = "Set max scale units for scalable gateways")]
+        public Int32 MaxScaleUnit { get; set; }
 
         [Parameter(
             Mandatory = false,
@@ -531,6 +537,19 @@ public override void Execute()
                 this.VirtualNetworkGateway.AdminState = AdminState;
             }
 
+            if (!string.IsNullOrEmpty(this.VirtualNetworkGateway.Sku.Name) && (this.VirtualNetworkGateway.Sku.Name.Equals(MNM.VirtualNetworkGatewaySkuTier.ErGwScale) && (this.MinScaleUnit > 0 || this.MaxScaleUnit > 0)))
+            {
+                if (this.MinScaleUnit > this.MaxScaleUnit)
+                {
+                    throw new PSArgumentException(string.Format(Properties.Resources.InvalidAutoScaleConfiguration, this.MinScaleUnit, this.MaxScaleUnit));
+                }
+
+                this.VirtualNetworkGateway.AutoScaleConfiguration = new PSVirtualNetworkGatewayAutoscaleConfiguration();
+                this.VirtualNetworkGateway.AutoScaleConfiguration.Bounds = new PSVirtualNetworkGatewayPropertiesAutoScaleConfigurationBounds();
+                this.VirtualNetworkGateway.AutoScaleConfiguration.Bounds.Min = Convert.ToInt32(this.MinScaleUnit);
+                this.VirtualNetworkGateway.AutoScaleConfiguration.Bounds.Max = Convert.ToInt32(this.MaxScaleUnit);
+            }
+
             // Map to the sdk object
             MNM.VirtualNetworkGateway sdkVirtualNetworkGateway = NetworkResourceManagerProfile.Mapper.Map<MNM.VirtualNetworkGateway>(this.VirtualNetworkGateway);
             sdkVirtualNetworkGateway.Tags =

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

@@ -18,6 +18,7 @@ New-AzVirtualNetworkGateway -Name <String> -ResourceGroupName <String> -Location
  [-IpConfigurations <PSVirtualNetworkGatewayIpConfiguration[]>] [-GatewayType <String>]
  [-ExtendedLocation <String>] [-VNetExtendedLocationResourceId <String>] [-VpnType <String>]
  [-EnableBgp <Boolean>] [-DisableIPsecProtection <Boolean>] [-EnableActiveActiveFeature]
+ [-MinScaleUnit <Int32>] [-MaxScaleUnit <Int32>]
  [-EnablePrivateIpAddress] [-GatewaySku <String>] [-GatewayDefaultSite <PSLocalNetworkGateway>]
  [-VpnClientAddressPool <String[]>] [-VpnClientProtocol <String[]>] [-VpnAuthenticationType <String[]>]
  [-VpnClientRootCertificates <PSVpnClientRootCertificate[]>]

src/Network/Network/help/Set-AzVirtualNetworkGateway.md

@@ -20,7 +20,7 @@ Set-AzVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> [-G
  [-VpnClientProtocol <String[]>] [-VpnAuthenticationType <String[]>]
  [-VpnClientRootCertificates <PSVpnClientRootCertificate[]>]
  [-VpnClientRevokedCertificates <PSVpnClientRevokedCertificate[]>] [-VpnClientIpsecPolicy <PSIpsecPolicy[]>]
- [-Asn <UInt32>] [-PeerWeight <Int32>]
+ [-Asn <UInt32>] [-PeerWeight <Int32>] [-MinScaleUnit <Int32>] [-MaxScaleUnit <Int32>]
  [-IpConfigurationBgpPeeringAddresses <PSIpConfigurationBgpPeeringAddress[]>] [-EnableActiveActiveFeature]
  [-EnablePrivateIpAddress <Boolean>] [-DisableActiveActiveFeature] [-RadiusServerAddress <String>]
  [-RadiusServerSecret <SecureString>] [-RadiusServerList <PSRadiusServer[]>] [-AadTenantUri <String>]