Get-​Azure​Rm​Local​Network​Gateway

Gets a Local Network Gateway

Syntax

Get-AzureRmLocalNetworkGateway
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-Name <String>]
   -ResourceGroupName <String>
   [<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"

Required Parameters

-ResourceGroupName
Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
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 (ByPropertyName)
Accept wildcard characters:False