Get-AzVirtualNetworkGatewayConnection
Gets a Virtual Network Gateway Connection
Syntax
Default (Default)
Get-AzVirtualNetworkGatewayConnection
[-Name <String>]
-ResourceGroupName <String>
[-DefaultProfile <IAzureContextContainer>]
[<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-AzVirtualNetworkGatewayConnection cmdlet returns the object of your connection based on Name and Resource Group Name. If the Get-AzVirtualNetworkGatewayConnection cmdlet is issued without specifying the -Name parameter, the output will not show ConnectionStatus and SharedKey details.
Examples
Example 1: Get a Virtual Network Gateway Connection
Get-AzVirtualNetworkGatewayConnection -Name myTunnel -ResourceGroupName myRG
Returns the object of the Virtual Network Gateway Connection with the name "myTunnel" within the resource group "myRG"
Example 2: Get all Virtual Network Gateway Connections using filtering
Get-AzVirtualNetworkGatewayConnection -Name myTunnel* -ResourceGroupName myRG
Returns all Virtual Network Gateway Connections that start with "myTunnel" within the resource group "myRG"
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
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-AzVirtualNetworkGatewayConnection cmdlet returns the object of your connection based on Name and Resource Group Name. If the Get-AzVirtualNetworkGatewayConnection cmdlet is issued without specifying the -Name parameter, the output will not show ConnectionStatus and SharedKey details.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | ResourceName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
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-AzVirtualNetworkGatewayConnection cmdlet returns the object of your connection based on Name and Resource Group Name. If the Get-AzVirtualNetworkGatewayConnection cmdlet is issued without specifying the -Name parameter, the output will not show ConnectionStatus and SharedKey details.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
