< Back

Remove-AzureRmVirtualNetworkGatewayConnection

Tue Jan 29, 2019 9:57 pm

NAME Remove-AzureRmVirtualNetworkGatewayConnection



SYNOPSIS

Deletes a Virtual Network Gateway Connection





SYNTAX

Remove-AzureRmVirtualNetworkGatewayConnection [-DefaultProfile <IAzureContextContainer>] [-Force] -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.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS



NOTES









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"







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... connection

Get-AzureRmVirtualNetworkGatewayConnection

New-AzureRmVirtualNetworkGatewayConnection

Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey