Edit

Remove-AzVirtualNetworkGatewayDefaultSite

  • Reference
Module:
Az.Network

Removes the default site from a virtual network gateway.

Syntax

Remove-AzVirtualNetworkGatewayDefaultSite
      -VirtualNetworkGateway <PSVirtualNetworkGateway>
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

The Remove-AzVirtualNetworkGatewayDefaultSite cmdlet removes the forced tunneling default site from a virtual network gateway. Forced tunneling provides a way for you to redirect Internet-bound traffic from Azure virtual machines to your on-premises network; this enables you to inspect and audit traffic before releasing it. Forced tunneling is carried out by using a virtual private network (VPN) tunnel; this tunnel requires a default site, a local gateway where all the Azure Internet-bound traffic is redirected. Remove-AzVirtualNetworkGatewayDefaultSite removes the default site assigned to a gateway. If you do this you will need to use Set-AzVirtualNetworkGatewayDefaultSite to assign a new default site before the gateway can be used for forced tunneling.

Examples

Example 1: Remove the default site assigned to a virtual network gateway

$Gateway = Get-AzVirtualNetworkGateway -Name "ContosoVirtualGateway"
Remove-AzVirtualNetworkGatewayDefaultSite -VirtualNetworkGateway $Gateway

This example removes the default site currently assigned to a virtual network gateway named ContosoVirtualGateway. The first command uses Get-AzVirtualNetworkGateway to create an object reference to the gateway; this object reference is stored in a variable named $Gateway. The second command then uses Remove-AzVirtualNetworkGatewayDefaultSite to remove the default site assigned to that gateway.

Parameters

-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

-VirtualNetworkGateway

Specifies an object reference to the virtual network gateway containing the default site to be removed. You can create an object reference to a virtual network gateway by using the Get-AzVirtualNetworkGateway and specifying the name of the gateway.

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

Inputs

PSVirtualNetworkGateway

Outputs

PSVirtualNetworkGateway