Get-AzLocalNetworkGateway

Module:

Az.Network

Gets a Local Network Gateway

Syntax

PowerShell

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

Description

The Local Network Gateway is the object representing your VPN device On-Premises.

The Get-AzLocalNetworkGateway cmdlet returns the object representing your on-prem gateway based on Name and Resource Group Name.

Examples

1: Get a Local Network Gateway

PowerShell

Get-AzLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG

Returns the object of the Local Network Gateway with the name "myLocalGW" within the resource group "myRG"

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:	IAzureContextContainer
Aliases:	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:	False

-ResourceGroupName

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Outputs

PSLocalNetworkGateway