Get-AzureRmVirtualNetworkGatewayConnection

NAME Get-AzureRmVirtualNetworkGatewayConnection



SYNOPSIS

Gets a Virtual Network Gateway Connection





SYNTAX

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





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



-Name <String>





Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>





Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

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

Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection







NOTES









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"







RELATED LINKS

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