Get-AzureVNetGateway

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Get-AzureVNetGateway

Retrieves an object with information about a Windows Azure virtual network gateway.

Parameter Set: Default
Get-AzureVNetGateway [-VNetName] <String> [ <CommonParameters>]

This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.

The Get-AzureVNetGateway cmdlet retrieves an object with information about a Windows Azure virtual network gateway from the current Windows Azure subscription. A virtual network gateway is a connection between a local network site with a VPN device and a Windows Azure virtual network.

-VNetName<String>

Specifies the virtual network name whose virtual network gateway object will be retrieved.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

-------------- Example 1 --------------

This command gets a Windows Azure virtual network gateway object from the "MyVNet01" virtual network.

C:\PS>Get-VNetGateway –VnetName "MyVNet01"