Update-AzRouteServer
Update an Azure RouteServer.
Syntax
RouteServerNameParameterSet (Default)
Update-AzRouteServer
-ResourceGroupName <String>
-RouteServerName <String>
[-AllowBranchToBranchTraffic <Boolean>]
[-HubRoutingPreference <String>]
[-VirtualRouterAutoScaleConfiguration <PSVirtualRouterAutoScaleConfiguration>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RouteServerResourceIdParameterSet
Update-AzRouteServer
-ResourceId <String>
[-AllowBranchToBranchTraffic <Boolean>]
[-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.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-HubRoutingPreference
Routing Preference to route traffic
Parameter properties
Type: String
Default value: None Accepted values: ExpressRoute, VpnGateway, ASPath Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The resource group name of the route server.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False
Parameter sets
RouteServerNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
ResourceId of the route server.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RouteServerResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RouteServerName
The name of the route server.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False Aliases: ResourceName
Parameter sets
RouteServerNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-VirtualRouterAutoScaleConfiguration
Autoscale configuration for route server.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
