Remove-​Azure​Rm​Virtual​Network​Gateway

Deletes a Virtual Network Gateway

Syntax

Remove-AzureRmVirtualNetworkGateway
      [-Force]
      -Name <String>
      [-PassThru]
      -ResourceGroupName <String>
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Virtual Network Gateway is the object representing your gateway in Azure.

The Get-AzureRmVirtualNetworkGateway cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name.

Examples

1: Delete a Virtual Network Gateway

Remove-AzureRmVirtualNetworkGateway -Name myGateway -ResourceGroupName myRG

Deletes the object of the Virtual Network Gateway with the name "myGateway" within the resource group "myRG"

Note: You must first delete all connections to the Virtual Network Gateway using the Remove-AzureRmVirtualNetworkGatewayConnection cmdlet.

Required Parameters

-Name

Specifies the name of the virtual network gateway that this cmdlet removes.

Type:String
Aliases:ResourceName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group that contains the virtual network gateway.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False