Get-AzureRmLocalNetworkGateway

Reference

Module:: AzureRM.Network

Gets a Local Network Gateway

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

The Local Network Gateway is the object representing your VPN device On-Premises. The Get-AzureRmLocalNetworkGateway cmdlet returns the object representing your on-prem gateway based on Name and Resource Group Name.

Examples

1: Get a Local Network Gateway

Get-AzureRmLocalNetworkGateway -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

Inputs

String

Outputs

PSLocalNetworkGateway

Share via