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

Gets a Virtual Network Gateway Connection

Syntax

Get-AzureRmVirtualNetworkGatewayConnection
   [-Name <String>]
   -ResourceGroupName <String>
   [<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 Get-AzureRmVirtualNetworkGatewayConnection cmdlet returns the object of your connection based on Name and Resource Group Name.

Examples

1: Get a Virtual Network Gateway Connection

Get-AzureRmVirtualNetworkGatewayConnection -Name myTunnel -ResourceGroupName myRG

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

Required Parameters

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

Optional Parameters

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