Edit

Share via

Get-AzureVNetGateway

  • Reference
Module:
Azure

Gets the status of a virtual network gateway.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Get-AzureVNetGateway
   -VNetName <String>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Get-AzureVNetGateway cmdlet gets the status of an existing virtual network gateway.

Examples

Example 1: Get the status of a virtual network gateway

PS C:\> Get-AzureVNetGateway -VNetName "ContosoVN07"

This command gets that status of the virtual network gateway for the virtual network named ContosoVN07.

Parameters

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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

-VNetName

Specifies the virtual network that contains the virtual network gateway for which this cmdlet gets status.

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