Add hub routing preference in virtual hub, deprecated PreferredRoutingGateway

src/Network/Network.Test/ScenarioTests/CortexTests.ps1

@@ -68,7 +68,7 @@ function Test-CortexCRUD
 		Assert-NotNull $virtualWansAll
 
 		# Create the Virtual Hub
-		$createdVirtualHub = New-AzVirtualHub -ResourceGroupName $rgName -Name $virtualHubName -Location $rglocation -AddressPrefix "192.168.1.0/24" -VirtualWan $virtualWan
+		$createdVirtualHub = New-AzVirtualHub -ResourceGroupName $rgName -Name $virtualHubName -Location $rglocation -AddressPrefix "192.168.1.0/24" -VirtualWan $virtualWan -HubRoutingPreference "ASPath"
 		$virtualHub = Get-AzVirtualHub -ResourceGroupName $rgName -Name $virtualHubName
 		Assert-AreEqual $rgName $virtualHub.ResourceGroupName
 		Assert-AreEqual $virtualHubName $virtualHub.Name
@@ -94,7 +94,7 @@ function Test-CortexCRUD
 		$route1 = New-AzVirtualHubRoute -AddressPrefix @("10.0.0.0/16", "11.0.0.0/16") -NextHopIpAddress "12.0.0.5"
 		$route2 = New-AzVirtualHubRoute -AddressPrefix @("13.0.0.0/16") -NextHopIpAddress "14.0.0.5"
 		$routeTable = New-AzVirtualHubRouteTable -Route @($route1, $route2)
-		Update-AzVirtualHub -ResourceGroupName $rgName -Name $virtualHubName -RouteTable $routeTable
+		Update-AzVirtualHub -ResourceGroupName $rgName -Name $virtualHubName -RouteTable $routeTable -HubRoutingPreference "ExpressRoute"
 		$virtualHub = Get-AzVirtualHub -ResourceGroupName $rgName -Name $virtualHubName
 		Assert-AreEqual $rgName $virtualHub.ResourceGroupName
 		Assert-AreEqual $virtualHubName $virtualHub.Name

src/Network/Network/ChangeLog.md

@@ -26,6 +26,9 @@
 * Added option parameter `AuthorizationKey` to cmdlet `New-AzExpressRouteCircuit` to allow creating ExpressRoute Circuit on a ExpressRoutePort with a different owner.
 * Fixed `ArgumentNullException` in `Add-AzureRmRouteConfig` when `RouteTable.Routes` is null.
 * Fix bug that can't display CustomIpPrefix in PublicIpPrefix.
+* Updated cmdlets to add new property of `HubRoutingPreference` in VirtualHub and set property of `PreferredRoutingGateway` deprecated .
+    - `New-AzVirtualHub`
+    - `Update-AzVirtualHub`
 
 ## Version 4.16.0
 * Added support for retrieving the state of packet capture even when the provisioning state of the packet capture was failure

src/Network/Network/Cortex/CortexParameterSetNames.cs

@@ -84,5 +84,5 @@ internal static class CortexParameterSetNames
         internal const string ByHubBgpConnectionObject = "ByHubBgpConnectionObject";
         internal const string ByHubBgpConnectionResourceId = "ByHubBgpConnectionResourceId";
 
-    }
+  }
 }

src/Network/Network/Cortex/VirtualHub/NewAzureRmVirtualHubCommand.cs

@@ -98,6 +98,8 @@ public class NewAzureRmVirtualHubCommand : VirtualHubBaseCmdlet
         [PSArgumentCompleter("Basic", "Standard")]
         public string Sku { get; set; }
 
+        public const String PreferredGWChangeDesc = "PreferredRoutingGateway parameter is deprecated. Use *HubRoutingPreference* property";
+        [CmdletParameterBreakingChange("PreferredRoutingGateway", ChangeDescription = PreferredGWChangeDesc)]
         [Parameter(
             Mandatory = false,
             HelpMessage = "Preferred Routing Gateway to Route On-Prem traffic from VNET")]
@@ -107,6 +109,16 @@ public class NewAzureRmVirtualHubCommand : VirtualHubBaseCmdlet
             IgnoreCase = true)]
         public string PreferredRoutingGateway { get; set; }
 
+        [Parameter(
+            Mandatory = false,
+            HelpMessage = "Virtual Hub Routing Preference to route traffic")]
+        [ValidateSet(
+            MNM.HubRoutingPreference.ExpressRoute,
+            MNM.HubRoutingPreference.VpnGateway,
+            MNM.HubRoutingPreference.ASPath,
+            IgnoreCase = true)]
+        public string HubRoutingPreference { get; set; }
+
         [Parameter(
             Mandatory = false,
             HelpMessage = "Run cmdlet in the background")]
@@ -183,6 +195,15 @@ public override void Execute()
                         virtualHub.PreferredRoutingGateway = this.PreferredRoutingGateway;
                     }
 
+                    if (string.IsNullOrWhiteSpace(this.HubRoutingPreference))
+                    {
+                        virtualHub.HubRoutingPreference = "ExpressRoute";
+                    }
+                    else
+                    {
+                        virtualHub.HubRoutingPreference = this.HubRoutingPreference;
+                    }
+
                     WriteObject(CreateOrUpdateVirtualHub(
                         this.ResourceGroupName,
                         this.Name,

src/Network/Network/Cortex/VirtualHub/UpdateAzureRmVirtualHubCommand.cs

@@ -103,6 +103,8 @@ public class UpdateAzureRmVirtualHubCommand : VirtualHubBaseCmdlet
         [PSArgumentCompleter("Basic", "Standard")]
         public string Sku { get; set; }
 
+        public const String PreferredGWChangeDesc = "PreferredRoutingGateway parameter will be deprecated. Use *HubRoutingPreference* parameter";
+        [CmdletParameterBreakingChange("PreferredRoutingGateway", ChangeDescription = PreferredGWChangeDesc)]
         [Parameter(
             Mandatory = false,
             HelpMessage = "Preferred Routing Gateway to Route On-Prem traffic from VNET")]
@@ -112,6 +114,16 @@ public class UpdateAzureRmVirtualHubCommand : VirtualHubBaseCmdlet
             IgnoreCase = true)]
         public string PreferredRoutingGateway { get; set; }
 
+        [Parameter(
+            Mandatory = false,
+            HelpMessage = "Virtual Hub Routing Preference to route traffic")]
+        [ValidateSet(
+            MNM.HubRoutingPreference.ExpressRoute,
+            MNM.HubRoutingPreference.VpnGateway,
+            MNM.HubRoutingPreference.ASPath,
+            IgnoreCase = true)]
+        public string HubRoutingPreference { get; set; }
+
         [Parameter(
             Mandatory = false,
             HelpMessage = "Run cmdlet in the background")]
@@ -194,6 +206,11 @@ public override void Execute()
                 virtualHubToUpdate.PreferredRoutingGateway = this.PreferredRoutingGateway;
             }
 
+            if (!string.IsNullOrWhiteSpace(this.HubRoutingPreference))
+            {
+                virtualHubToUpdate.HubRoutingPreference = this.HubRoutingPreference;
+            }
+
             //// Update the virtual hub
             ConfirmAction(
                     Properties.Resources.SettingResourceMessage,

src/Network/Network/Cortex/VirtualHub/VirtualHubBaseCmdlet.cs

@@ -51,7 +51,7 @@ public IVirtualHubsOperations VirtualHubClient
         public PSVirtualHub ToPsVirtualHub(Management.Network.Models.VirtualHub virtualHub)
         {
             var psVirtualHub = NetworkResourceManagerProfile.Mapper.Map<PSVirtualHub>(virtualHub);
-
+            
             psVirtualHub.Tag = TagsConversionHelper.CreateTagHashtable(virtualHub.Tags);
 
             return psVirtualHub;

src/Network/Network/Cortex/VpnConnection/UpdateAzureRmVpnConnectionCommand.cs

@@ -240,7 +240,7 @@ public override void Execute()
                     throw new PSArgumentException(Properties.Resources.StaticRoutesNotSupportedForThisRoutingConfiguration);
                 }
 
-                vpnConnectionToModify.RoutingConfiguration = RoutingConfiguration;
+                vpnConnectionToModify.RoutingConfiguration = this.RoutingConfiguration;
             }
 
             if(!String.IsNullOrEmpty(this.VpnLinkConnectionMode))

src/Network/Network/Models/Cortex/PSVirtualHub.cs

@@ -63,5 +63,8 @@ public class PSVirtualHub : PSTopLevelResource
 
         [Ps1Xml(Label = "Preferred Routing Gateway", Target = ViewControl.Table)]
         public string PreferredRoutingGateway { get; set; }
+
+        [Ps1Xml(Label = "Hub Routing Preference", Target = ViewControl.Table)]
+        public string HubRoutingPreference { get; set; }
     }
 }

src/Network/Network/Network.format.ps1xml

@@ -4491,6 +4491,10 @@
                 <Label>PreferredRoutingGateway</Label>
                 <PropertyName>PreferredRoutingGateway</PropertyName>
               </ListItem>
+              <ListItem>
+                <Label>HubRoutingPreference</Label>
+                <PropertyName>HubRoutingPreference</PropertyName>
+              </ListItem>
               <ListItem>
                 <Label>ProvisioningState</Label>
                 <PropertyName>ProvisioningState</PropertyName>

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

@@ -17,15 +17,15 @@ Creates an Azure VirtualHub resource.
 New-AzVirtualHub -ResourceGroupName <String> -Name <String> -VirtualWan <PSVirtualWan> -AddressPrefix <String>
  -Location <String> [-HubVnetConnection <PSHubVirtualNetworkConnection[]>]
  [-RouteTable <PSVirtualHubRouteTable[]>] [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>]
- [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-HubRoutingPreference <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ByVirtualWanResourceId
 ```
 New-AzVirtualHub -ResourceGroupName <String> -Name <String> -VirtualWanId <String> -AddressPrefix <String>
  -Location <String> [-HubVnetConnection <PSHubVirtualNetworkConnection[]>]
  [-RouteTable <PSVirtualHubRouteTable[]>] [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>]
- [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-HubRoutingPreference <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -53,6 +53,7 @@ RouteTables                           : {}
 Location                  : West US
 Sku                  : Standard
 PreferredRoutingGateway   : ExpressRoute
+HubRoutingPreference      : ExpressRoute
 Type                      : Microsoft.Network/virtualHubs
 ProvisioningState         : Succeeded
 ```
@@ -79,6 +80,7 @@ RouteTables                           : {}
 Location                  : West US
 Sku                  : Standard
 PreferredRoutingGateway   : ExpressRoute
+HubRoutingPreference      : ExpressRoute
 Type                      : Microsoft.Network/virtualHubs
 ProvisioningState         : Succeeded
 ```
@@ -110,6 +112,7 @@ RouteTables                           : {}
 Location                  : West US
 Sku                  : Standard
 PreferredRoutingGateway   : ExpressRoute
+HubRoutingPreference      : ExpressRoute
 Type                      : Microsoft.Network/virtualHubs
 ProvisioningState         : Succeeded
 ```
@@ -123,9 +126,10 @@ This example is similar to Example 2, but also attaches a route table to the vir
 ```powershell
 New-AzResourceGroup -Location "West US" -Name "testRG"
 $virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US"
-New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PreferredRoutingGateway "VpnGateway"    
+New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -HubRoutingPreference "VpnGateway"    
 ```
 
+
 ```output
 VirtualWan                : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN
 ResourceGroupName         : testRG
@@ -135,7 +139,7 @@ AddressPrefix             : 10.0.1.0/24
 RouteTable                :
 Location                  : West US
 Sku                  : Standard 
-PreferredRoutingGateway   : VpnGateway
+HubRoutingPreference      : VpnGateway
 VirtualNetworkConnections : {}
 Location                  : West US
 Type                      : Microsoft.Network/virtualHubs
@@ -237,7 +241,7 @@ Accept wildcard characters: False
 ```
 
 ### -PreferredRoutingGateway
-Preferred Routing Gateway to Route On-Prem traffic from VNET
+Preferred Routing Gateway to Route On-Prem traffic from VNET (Deprecated, please use HubRoutingPreference)
 
 ```yaml
 Type: System.String
@@ -252,6 +256,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -HubRoutingPreference
+Virtual Hub Routing Preference to route traffic
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+Accepted values: ExpressRoute, VpnGateway, ASPath
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ResourceGroupName
 The resource group name.
 

src/Network/Network/help/Update-AzVirtualHub.md

@@ -16,24 +16,24 @@ Updates a virtual hub.
 ```
 Update-AzVirtualHub -ResourceGroupName <String> -Name <String> [-AddressPrefix <String>]
  [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] [-RouteTable <PSVirtualHubRouteTable>]
- [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] [-AsJob]
- [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] [-HubRoutingPreference <String>]
+ [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ByVirtualHubResourceId
 ```
 Update-AzVirtualHub -ResourceId <String> [-AddressPrefix <String>]
  [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] [-RouteTable <PSVirtualHubRouteTable>]
- [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] [-AsJob]
- [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] [-HubRoutingPreference <String>]
+ [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ByVirtualHubObject
 ```
 Update-AzVirtualHub -InputObject <PSVirtualHub> [-AddressPrefix <String>]
  [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] [-RouteTable <PSVirtualHubRouteTable>]
- [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] [-AsJob]
- [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] [-HubRoutingPreference <String>]
+ [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -101,7 +101,7 @@ This example is similar to Example 1, but also attaches a route table to the vir
 New-AzResourceGroup -Location "West US" -Name "testRG"
 $virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US"
 New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24"
-Update-AzVirtualHub -ResourceGroupName "testRG" -Name "westushub" -PreferredRoutingGateway "VpnGateway"    
+Update-AzVirtualHub -ResourceGroupName "testRG" -Name "westushub" -HubRoutingPreference "VpnGateway"    
 ```
 
 ```output
@@ -113,7 +113,7 @@ AddressPrefix             : 10.0.1.0/24
 RouteTable                :
 Location                  : West US
 Sku                  : Standard 
-PreferredRoutingGateway   : VpnGateway
+HubRoutingPreference      : VpnGateway
 VirtualNetworkConnections : {}
 Location                  : West US
 Type                      : Microsoft.Network/virtualHubs
@@ -215,7 +215,7 @@ Accept wildcard characters: False
 ```
 
 ### -PreferredRoutingGateway
-Preferred Routing Gateway to Route On-Prem traffic from VNET
+Preferred Routing Gateway to Route On-Prem traffic from VNET (Deprecated, please use HubRoutingPreference)
 
 ```yaml
 Type: System.String
@@ -230,6 +230,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -HubRoutingPreference
+Virtual Hub Routing Preference to route traffic
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+Accepted values: ExpressRoute, VpnGateway, ASPath
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ResourceGroupName
 The resource group name.