Update-AzVirtualRouter
Updates a Virtual Router.
Syntax
VirtualRouterNameParameterSet (Default)
Update-AzVirtualRouter
-ResourceGroupName <String>
-RouterName <String>
[-AllowBranchToBranchTraffic]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
VirtualRouterResourceIdParameterSet
Update-AzVirtualRouter
-ResourceId <String>
[-AllowBranchToBranchTraffic]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Updates Virtual Router to enable or disable branch to branch traffic.
Examples
Example 1
Update-AzVirtualRouter -ResourceGroupName $rgname -RouterName $virtualRouterName -AllowBranchToBranchTraffic
Updates the Virtual Router to allow branch to branch traffic
Example 2
Update-AzVirtualRouter -ResourceGroupName $rgname -RouterName $virtualRouterName
Updates the Virtual Router to block branch to branch traffic
Parameters
-AllowBranchToBranchTraffic
Flag to allow branch to branch traffic for virtual router.
Parameter properties
Type: SwitchParameter
Default value: None 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
-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
-ResourceGroupName
The resource group name of the virtual router.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False
Parameter sets
VirtualRouterNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
ResourceId of the virtual router.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
VirtualRouterResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RouterName
The name of the virtual router.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False Aliases: ResourceName
Parameter sets
VirtualRouterNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True 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
