你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Get-AzVirtualNetworkGatewayConnection
Gets a Virtual Network Gateway Connection
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
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.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Type: | String |
Aliases: | ResourceName |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-ResourceGroupName
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
Inputs
Outputs
PSVirtualNetworkGatewayConnection