New-AzureVNetGateway

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

New-AzureVNetGateway

This topic is deprecated and will be removed in the future. It describes the cmdlet in the 0.8.7 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.

Syntax

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

Detailed Description

For a more recent version of the reference, see Azure Management Cmdlets.

The New-AzureVNetGateway cmdlet creates a new virtual network gateway for the specified Azure virtual network. A virtual network gateway is a VPN endpoint for connecting to an Azure virtual network.

After the virtual network gateway has been created, you can get the shared key to allow you to configure the VPN device at the local network site to authenticate to the gateway with the Get-AzureVNetGatewayKey cmdlet.

Parameters

-GatewayType<GatewayType>

Aliases	none
Required?	false
Position?	2
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VNetName<String>

Specifies the name of the virtual network for which the gateway is created.

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.

Examples

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

This command creates a new VPN endpoint for the "MyProdNet" network.

C:\PS>New-AzureVNetGateway –VNetName "MyProdNet"