Skip to content

Latest commit

 

History

History
90 lines (67 loc) · 2.25 KB

Get-AzureRmLocalNetworkGateway.md

File metadata and controls

90 lines (67 loc) · 2.25 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.Commands.Network.dll-Help.xml
AzureRM.Network
F8756DA1-7BB9-4CD5-9D81-E11FF7A26125
2.0.0

Get-AzureRmLocalNetworkGateway

SYNOPSIS

Gets a Local Network Gateway

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: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

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

-Name

Type: System.String
Parameter Sets: (All)
Aliases: ResourceName

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceGroupName

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

OUTPUTS

Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway

NOTES

RELATED LINKS