Skip to content

Latest commit

 

History

History
90 lines (67 loc) · 2.25 KB

Get-AzureRmVirtualNetworkGateway.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
9CBF592E-734B-4A0C-A45D-358C226D08C7
2.0.0

Get-AzureRmVirtualNetworkGateway

SYNOPSIS

Gets a Virtual Network Gateway

SYNTAX

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

DESCRIPTION

The Virtual Network Gateway is the object representing your gateway in Azure. The Get-AzureRmVirtualNetworkGateway cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name.

EXAMPLES

1: Get a Virtual Network Gateway

Get-AzureRmVirtualNetworkGateway -Name myGateway -ResourceGroupName myRG

Returns the object of the Virtual Network Gateway with the name "myGateway" 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.PSVirtualNetworkGateway

NOTES

RELATED LINKS