New-AzVpnConnection

Creates a IPSec connection that connects a VpnGateway to a remote customer branch represented in RM as a VpnSite.

Syntax

New-AzVpnConnection
   -ResourceGroupName <String>
   -ParentResourceName <String>
   -Name <String>
   -VpnSite <PSVpnSite>
   [-SharedKey <SecureString>]
   [-ConnectionBandwidthInMbps <UInt32>]
   [-IpSecPolicy <PSIpsecPolicy>]
   [-VpnConnectionProtocolType <String>]
   [-EnableBgp]
   [-UseLocalAzureIpAddress]
   [-UsePolicyBasedTrafficSelectors]
   [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzVpnConnection
   -ResourceGroupName <String>
   -ParentResourceName <String>
   -Name <String>
   -VpnSiteId <String>
   [-SharedKey <SecureString>]
   [-ConnectionBandwidthInMbps <UInt32>]
   [-IpSecPolicy <PSIpsecPolicy>]
   [-VpnConnectionProtocolType <String>]
   [-EnableBgp]
   [-UseLocalAzureIpAddress]
   [-UsePolicyBasedTrafficSelectors]
   [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzVpnConnection
   -ParentObject <PSVpnGateway>
   -Name <String>
   -VpnSite <PSVpnSite>
   [-SharedKey <SecureString>]
   [-ConnectionBandwidthInMbps <UInt32>]
   [-IpSecPolicy <PSIpsecPolicy>]
   [-VpnConnectionProtocolType <String>]
   [-EnableBgp]
   [-UseLocalAzureIpAddress]
   [-UsePolicyBasedTrafficSelectors]
   [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzVpnConnection
   -ParentObject <PSVpnGateway>
   -Name <String>
   -VpnSiteId <String>
   [-SharedKey <SecureString>]
   [-ConnectionBandwidthInMbps <UInt32>]
   [-IpSecPolicy <PSIpsecPolicy>]
   [-VpnConnectionProtocolType <String>]
   [-EnableBgp]
   [-UseLocalAzureIpAddress]
   [-UsePolicyBasedTrafficSelectors]
   [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzVpnConnection
   -ParentResourceId <String>
   -Name <String>
   -VpnSite <PSVpnSite>
   [-SharedKey <SecureString>]
   [-ConnectionBandwidthInMbps <UInt32>]
   [-IpSecPolicy <PSIpsecPolicy>]
   [-VpnConnectionProtocolType <String>]
   [-EnableBgp]
   [-UseLocalAzureIpAddress]
   [-UsePolicyBasedTrafficSelectors]
   [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzVpnConnection
   -ParentResourceId <String>
   -Name <String>
   -VpnSiteId <String>
   [-SharedKey <SecureString>]
   [-ConnectionBandwidthInMbps <UInt32>]
   [-IpSecPolicy <PSIpsecPolicy>]
   [-VpnConnectionProtocolType <String>]
   [-EnableBgp]
   [-UseLocalAzureIpAddress]
   [-UsePolicyBasedTrafficSelectors]
   [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Creates a IPSec connection that connects a VpnGateway to a remote customer branch represented in RM as a VpnSite.

Examples

Example 1

PS C:\> New-AzResourceGroup -Location "West US" -Name "testRG"
PS C:\> $virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US"
PS C:\> $virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24"
PS C:\> New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2
PS C:\> $vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw"
PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2
PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24"
PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24"
PS C:\> $vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10"

PS C:\> New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -ConnectionBandwidth 20

RemoteVpnSite             : Microsoft.Azure.Commands.Network.Models.PSResourceId
SharedKey                 :
VpnConnectionProtocolType : IKEv2
ConnectionStatus          :
EgressBytesTransferred    : 0
IngressBytesTransferred   : 0
IpsecPolicies             : {}
ConnectionBandwidth       : 20
EnableBgp                 : False
UseLocalAzureIpAddress    : False
ProvisioningState         : testConnection
Name                      : ps9709
Etag                      : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8"
Id                        : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection

The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units.

Once the gateway has been created, it is connected to the VpnSite using the New-AzVpnConnection command.

Example 2

PS C:\> New-AzResourceGroup -Location "West US" -Name "testRG"
PS C:\> $virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US"
PS C:\> $virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24"
PS C:\> New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2
PS C:\> $vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw"

PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2
PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24"
PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24"

PS C:\> $vpnSiteLink1 = New-AzVpnSiteLink -Name "testVpnSiteLink1" -IpAddress "15.25.35.45" -LinkProviderName "SomeTelecomProvider" -LinkSpeedInMbps "10"
PS C:\> $vpnSiteLink2 = New-AzVpnSiteLink -Name "testVpnSiteLink2" -IpAddress "15.25.35.55" -LinkProviderName "SomeTelecomProvider2" -LinkSpeedInMbps "100"
PS C:\> $vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -VpnSiteLink @($vpnSiteLink1, $vpnSiteLink2)


PS C:\> $vpnSiteLinkConnection1 = New-AzVpnSiteLinkConnection -Name "testLinkConnection1" -VpnSiteLink $vpnSite.VpnSiteLinks[0] -ConnectionBandwidth 100
PS C:\> $vpnSiteLinkConnection2 = New-AzVpnSiteLinkConnection -Name "testLinkConnection2" -VpnSiteLink $vpnSite.VpnSiteLinks[1] -ConnectionBandwidth 10

PS C:\> New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -VpnSiteLinkConnection @($vpnSiteLinkConnection1, $vpnSiteLinkConnection2)

The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite with 1 VpnSiteLinks in West US in "testRG" resource group in Azure. A VPN gateway will be created thereafter in the Virtual Hub. Once the gateway has been created, it is connected to the VpnSite using the New-AzVpnConnection command with 1 VpnSiteLinkConnections to the VpnSiteLink of the VpnSite.

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ConnectionBandwidthInMbps

The bandwidth that needs to be handled by this connection in mbps.

Type:UInt32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EnableBgp

Enable BGP for this connection

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IpSecPolicy

The bandwidth that needs to be handled by this connection in mbps.

Type:PSIpsecPolicy
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

The resource name.

Type:String
Aliases:ResourceName, VpnConnectionName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ParentObject

The parent VpnGateway for this connection.

Type:Microsoft.Azure.Commands.Network.Models.PSVpnGateway
Aliases:ParentVpnGateway, VpnGateway
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-ParentResourceId

The resource id of the parent VpnGateway for this connection.

Type:String
Aliases:ParentVpnGatewayId, VpnGatewayId
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ParentResourceName

The resource group name.

Type:String
Aliases:ParentVpnGatewayName, VpnGatewayName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

The resource group name.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SharedKey

The shared key required to set this connection up.

Type:SecureString
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UseLocalAzureIpAddress

Use local azure ip address as source address while initiating connection.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UsePolicyBasedTrafficSelectors

Use policy based traffic selectors for this connection.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VpnConnectionProtocolType

Gateway connection protocol:IKEv1/IKEv2

Type:String
Accepted values:IKEv1, IKEv2
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VpnSite

The remote vpn site to which this hub virtual network connection is connected.

Type:Microsoft.Azure.Commands.Network.Models.PSVpnSite
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VpnSiteId

The remote vpn site to which this hub virtual network connection is connected.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VpnSiteLinkConnection

The list of VpnSiteLinkConnections that this VpnConnection have.

Type:Microsoft.Azure.Commands.Network.Models.PSVpnSiteLinkConnection[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Azure.Commands.Network.Models.PSVpnGateway

String

Outputs

Microsoft.Azure.Commands.Network.Models.PSVpnConnection