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

Deletes a Virtual Network Gateway Connection

Syntax

Remove-AzureRmVirtualNetworkGatewayConnection
      [-Force]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      -Name <String>
      [-PassThru]
      -ResourceGroupName <String>
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Virtual Network Gateway Connection is the object representing the IPsec tunnel (Site-to-Site or Vnet-to-Vnet) connected to your Virtual Network Gateway in Azure.

The Remove-AzureRmVirtualNetworkGatewayConnection cmdlet deletes the object of your connection based on Name and Resource Group Name.

Examples

1: Delete a Virtual Network Gateway Connection

Remove-AzureRmVirtualNetworkGatewayConnection -Name myTunnel -ResourceGroupName myRG

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

Required Parameters

-Name

Specifies the name of the virtual network gateway connection 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 connection.

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

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
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