Bicep resource definition
The p2svpnGateways resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/p2svpnGateways resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/p2svpnGateways@2019-09-01' = {
location: 'string'
name: 'string'
properties: {
p2SConnectionConfigurations: [
{
id: 'string'
name: 'string'
properties: {
vpnClientAddressPool: {
addressPrefixes: [
'string'
]
}
}
}
]
virtualHub: {
id: 'string'
}
vpnGatewayScaleUnit: int
vpnServerConfiguration: {
id: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Network/p2svpnGateways
Name |
Description |
Value |
location |
Resource location. |
string |
name |
The resource name |
string (required) |
properties |
Properties of the P2SVpnGateway. |
P2SVpnGatewayProperties |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
AddressSpace
Name |
Description |
Value |
addressPrefixes |
A list of address blocks reserved for this virtual network in CIDR notation. |
string[] |
P2SConnectionConfiguration
Name |
Description |
Value |
id |
Resource ID. |
string |
name |
The name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
Properties of the P2S connection configuration. |
P2SConnectionConfigurationProperties |
P2SConnectionConfigurationProperties
Name |
Description |
Value |
vpnClientAddressPool |
The reference of the address space resource which represents Address space for P2S VpnClient. |
AddressSpace |
P2SVpnGatewayProperties
Name |
Description |
Value |
p2SConnectionConfigurations |
List of all p2s connection configurations of the gateway. |
P2SConnectionConfiguration[] |
virtualHub |
The VirtualHub to which the gateway belongs. |
SubResource |
vpnGatewayScaleUnit |
The scale unit for this p2s vpn gateway. |
int |
vpnServerConfiguration |
The VpnServerConfiguration to which the p2sVpnGateway is attached to. |
SubResource |
SubResource
Name |
Description |
Value |
id |
Resource ID. |
string |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
ARM template resource definition
The p2svpnGateways resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/p2svpnGateways resource, add the following JSON to your template.
{
"type": "Microsoft.Network/p2svpnGateways",
"apiVersion": "2019-09-01",
"name": "string",
"location": "string",
"properties": {
"p2SConnectionConfigurations": [
{
"id": "string",
"name": "string",
"properties": {
"vpnClientAddressPool": {
"addressPrefixes": [ "string" ]
}
}
}
],
"virtualHub": {
"id": "string"
},
"vpnGatewayScaleUnit": "int",
"vpnServerConfiguration": {
"id": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Network/p2svpnGateways
Name |
Description |
Value |
apiVersion |
The api version |
'2019-09-01' |
location |
Resource location. |
string |
name |
The resource name |
string (required) |
properties |
Properties of the P2SVpnGateway. |
P2SVpnGatewayProperties |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
type |
The resource type |
'Microsoft.Network/p2svpnGateways' |
AddressSpace
Name |
Description |
Value |
addressPrefixes |
A list of address blocks reserved for this virtual network in CIDR notation. |
string[] |
P2SConnectionConfiguration
Name |
Description |
Value |
id |
Resource ID. |
string |
name |
The name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
Properties of the P2S connection configuration. |
P2SConnectionConfigurationProperties |
P2SConnectionConfigurationProperties
Name |
Description |
Value |
vpnClientAddressPool |
The reference of the address space resource which represents Address space for P2S VpnClient. |
AddressSpace |
P2SVpnGatewayProperties
Name |
Description |
Value |
p2SConnectionConfigurations |
List of all p2s connection configurations of the gateway. |
P2SConnectionConfiguration[] |
virtualHub |
The VirtualHub to which the gateway belongs. |
SubResource |
vpnGatewayScaleUnit |
The scale unit for this p2s vpn gateway. |
int |
vpnServerConfiguration |
The VpnServerConfiguration to which the p2sVpnGateway is attached to. |
SubResource |
SubResource
Name |
Description |
Value |
id |
Resource ID. |
string |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
The p2svpnGateways resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/p2svpnGateways resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/p2svpnGateways@2019-09-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
p2SConnectionConfigurations = [
{
id = "string"
name = "string"
properties = {
vpnClientAddressPool = {
addressPrefixes = [
"string"
]
}
}
}
]
virtualHub = {
id = "string"
}
vpnGatewayScaleUnit = int
vpnServerConfiguration = {
id = "string"
}
}
}
}
Property Values
Microsoft.Network/p2svpnGateways
Name |
Description |
Value |
location |
Resource location. |
string |
name |
The resource name |
string (required) |
properties |
Properties of the P2SVpnGateway. |
P2SVpnGatewayProperties |
tags |
Resource tags |
Dictionary of tag names and values. |
type |
The resource type |
"Microsoft.Network/p2svpnGateways@2019-09-01" |
AddressSpace
Name |
Description |
Value |
addressPrefixes |
A list of address blocks reserved for this virtual network in CIDR notation. |
string[] |
P2SConnectionConfiguration
Name |
Description |
Value |
id |
Resource ID. |
string |
name |
The name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
Properties of the P2S connection configuration. |
P2SConnectionConfigurationProperties |
P2SConnectionConfigurationProperties
Name |
Description |
Value |
vpnClientAddressPool |
The reference of the address space resource which represents Address space for P2S VpnClient. |
AddressSpace |
P2SVpnGatewayProperties
Name |
Description |
Value |
p2SConnectionConfigurations |
List of all p2s connection configurations of the gateway. |
P2SConnectionConfiguration[] |
virtualHub |
The VirtualHub to which the gateway belongs. |
SubResource |
vpnGatewayScaleUnit |
The scale unit for this p2s vpn gateway. |
int |
vpnServerConfiguration |
The VpnServerConfiguration to which the p2sVpnGateway is attached to. |
SubResource |
SubResource
Name |
Description |
Value |
id |
Resource ID. |
string |