Get-AzVirtualNetworkGateway

Reference

Module:: Az.Network

Gets a Virtual Network Gateway

Note

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

Syntax

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.

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

PSVirtualNetworkGateway