Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzVirtualNetworkGateway

Gets a Virtual Network Gateway

Syntax

Default (Default) 

Get-AzVirtualNetworkGateway
 [-Name <String>]
 -ResourceGroupName <String>
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Description

The Virtual Network Gateway is the object representing your gateway in Azure. The Get-AzVirtualNetworkGateway cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name.

Examples

Example 1: Get a Virtual Network Gateway

Get-AzVirtualNetworkGateway -Name myGateway1 -ResourceGroupName myRG

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

Example 2: Get a Virtual Network Gateway

Get-AzVirtualNetworkGateway -Name myGateway* -ResourceGroupName myRG

Returns all Virtual Network Gateways that start with "myGateway" 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

-Name

The Virtual Network Gateway is the object representing your gateway in Azure. The Get-AzVirtualNetworkGateway cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
DontShow:False
Aliases:ResourceName

Parameter sets

-ResourceGroupName

The Virtual Network Gateway is the object representing your gateway in Azure. The Get-AzVirtualNetworkGateway cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
DontShow:False

Parameter sets

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.

Inputs

String

Outputs

PSVirtualNetworkGateway

Related Links

Feedback

Was this page helpful?