Edit

Share via


New-AzureVNetGateway

Creates a VPN gateway in a virtual network.

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

Default (Default)

New-AzureVNetGateway
    -VNetName <String>
    [-GatewayType <String>]
    [-GatewaySKU <String>]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The New-AzureVNetGateway cmdlet creates a virtual private network (VPN) gateway in a virtual network. You can also specify the SKU of the gateway, either Default, Standard, or HighPerformance. You can specify the type, either StaticRouting or DynamicRouting.

Examples

Example 1: Create a virtual network gateway

PS C:\> New-AzureVNetGateway -VNetName "ContosoVN07" -GatewayType "DynamicRouting" -GatewaySKU "Default"

This command creates a virtual network gateway for the virtual network named ContosoVN07. The gateway is the Default SKU and uses dynamic routing.

Parameters

-GatewaySKU

Specifies the SKU of the virtual network gateway that this cmdlet creates. Valid values are:

  • Default
  • Standard
  • HighPerformance

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GatewayType

Specifies the type of gateway that this cmdlet creates. Valid values are:

  • StaticRouting
  • DynamicRouting

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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.

Parameter properties

Type:AzureSMProfile
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VNetName

Specifies the virtual network in which this cmdlet adds a virtual network gateway.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.