Edit

Share via

Remove-AzureVNetGatewayDefaultSite

Module:
Azure Module

Removes the default route for forced tunneling traffic.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Default (Default) 

Remove-AzureVNetGatewayDefaultSite
    -VNetName <String>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Remove-AzureVNetGatewayDefaultSite cmdlet removes the default route to the on-premises site for forced tunneling traffic. This cmdlet removes the route from an Azure virtual private network (VPN) gateway for a virtual network.

Examples

Example 1: Remove a route to the default site

PS C:\> Remove-AzureVNetGatewayDefaultSite -VnetName "ContosoVNet01"

This command removes the route to the default site from the VPN of the virtual network named ContosoVNet01.

Parameters

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Parameter properties

Type:AzureSMProfile
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

-VNetName

Specifies a virtual network. This cmdlet removes the default route from the VPN gateway for the virtual network that this parameter specifies.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
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.