Remove-AzureVNetGateway

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Remove-AzureVNetGateway

This topic is deprecated and will be removed in the future. It describes the cmdlet in the 0.8.7 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.

Syntax

Parameter Set: Default
Remove-AzureVNetGateway [-VNetName] <String> [ <CommonParameters>]

Detailed Description

For a more recent version of the reference, see Azure Management Cmdlets.

The Remove-AzureVNetGateway cmdlet removes the virtual network gateway to the specified Azure virtual network. A virtual network gateway is a VPN endpoint for connecting to a virtual network.

If you remove the virtual network gateway, the underlying virtual network is unaffected and still in place, allowing you to create a new gateway with New-VNetGateway. However, the shared key for the gateway will be different, requiring reconfiguration of the VPN device at the local network site.

Parameters

-VNetName<String>

Specifies the name of the virtual network to remove the gateway from.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

-------------- Example 1 --------------

This command removes the virtual network gateway (VPN endpoint) from the "MyProdNet" virtual network.

C:\PS>Remove-AzureVNetGateway –VNetName "MyProdNet"