Update-AzRouteServer
Update an Azure RouteServer.
Syntax
Update-AzRouteServer
-ResourceGroupName <String>
-RouteServerName <String>
[-AllowBranchToBranchTraffic <Boolean>]
[-HubRoutingPreference <String>]
[-VirtualRouterAutoScaleConfiguration <PSVirtualRouterAutoScaleConfiguration>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzRouteServer
[-AllowBranchToBranchTraffic <Boolean>]
-ResourceId <String>
[-HubRoutingPreference <String>]
[-VirtualRouterAutoScaleConfiguration <PSVirtualRouterAutoScaleConfiguration>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-AzRouteServer cmdlet switches the branch-to-branch traffic to an Azure RouteServer.
Examples
Example 1
Update-AzRouteServer -ResourceGroupName $rgname -RouteServerName $routeServerName -AllowBranchToBranchTraffic 1
To enable branch to branch traffic for route server.
Example 2
Update-AzRouteServer -ResourceGroupName $rgname -RouteServerName $routeServerName -AllowBranchToBranchTraffic 0
To disable branch to branch traffic for route server.
Example 3
Update-AzRouteServer -ResourceGroupName $rgname -RouteServerName $routeServerName -HubRoutingPreference "AsPath"
To change routing preference for route server.
Example 4
$autoscale = New-AzVirtualRouterAutoScaleConfiguration -MinCapacity 3
Update-AzRouteServer -ResourceGroupName $rgname -RouteServerName $routeServerName -VirtualRouterAutoScaleConfiguration $autoscale
To update the Routing Infrastructure Units to 3.
Parameters
-AllowBranchToBranchTraffic
Flag to allow branch to branch traffic for route server.
| Type: | Nullable<T>[Boolean] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HubRoutingPreference
Routing Preference to route traffic
| Type: | String |
| Accepted values: | ExpressRoute, VpnGateway, ASPath |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource group name of the route server.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-ResourceId
ResourceId of the route server.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RouteServerName
The name of the route server.
| Type: | String |
| Aliases: | ResourceName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-VirtualRouterAutoScaleConfiguration
Autoscale configuration for route server.
| Type: | PSVirtualRouterAutoScaleConfiguration |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |