Set-AzureVNetGatewayDefaultSite

Sets the default site 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

Set-AzureVNetGatewayDefaultSite
   -VNetName <String>
   -DefaultSite <String>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

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

Parameters

-DefaultSite

Specifies the name of the on-premises local network site for forced tunneling traffic.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VNetName

Specifies a virtual network. This cmdlet sets the default route of the VPN gateway for forced tunneling traffic for the virtual network that this parameter specifies.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False