تحرير

Get-AzVirtualNetworkGatewayConnection

  • Reference
Module:
Az.Network

Gets a Virtual Network Gateway Connection

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

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

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"

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.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name
Type:String
Aliases:ResourceName
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:True
-ResourceGroupName
Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:True

Inputs

String

Outputs

PSVirtualNetworkGatewayConnection