Microsoft.Network p2svpnGateways 2018-11-01
- Latest
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
- 2019-11-01
- 2019-09-01
- 2019-08-01
- 2019-07-01
- 2019-06-01
- 2019-04-01
- 2019-02-01
- 2018-12-01
- 2018-11-01
- 2018-10-01
- 2018-08-01
Bicep resource definition
The p2svpnGateways resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/p2svpnGateways resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/p2svpnGateways@2018-11-01' = {
location: 'string'
name: 'string'
properties: {
p2SVpnServerConfiguration: {
id: 'string'
}
provisioningState: 'string'
virtualHub: {
id: 'string'
}
vpnClientAddressPool: {
addressPrefixes: [
'string'
]
}
vpnGatewayScaleUnit: int
}
tags: {
{customized property}: 'string'
}
}
Property values
AddressSpace
| Name | Description | Value |
|---|---|---|
| addressPrefixes | A list of address blocks reserved for this virtual network in CIDR notation. | string[] |
Microsoft.Network/p2svpnGateways
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | Parameters for P2SVpnGateway | P2SVpnGatewayProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
P2SVpnGatewayProperties
| Name | Description | Value |
|---|---|---|
| p2SVpnServerConfiguration | The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to. | SubResource |
| provisioningState | The provisioning state of the resource. | 'Deleting' 'Failed' 'Succeeded' 'Updating' |
| virtualHub | The VirtualHub to which the gateway belongs | SubResource |
| vpnClientAddressPool | The reference of the address space resource which represents Address space for P2S VpnClient. | AddressSpace |
| vpnGatewayScaleUnit | The scale unit for this p2s vpn gateway. | int |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
ARM template resource definition
The p2svpnGateways resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/p2svpnGateways resource, add the following JSON to your template.
{
"type": "Microsoft.Network/p2svpnGateways",
"apiVersion": "2018-11-01",
"name": "string",
"location": "string",
"properties": {
"p2SVpnServerConfiguration": {
"id": "string"
},
"provisioningState": "string",
"virtualHub": {
"id": "string"
},
"vpnClientAddressPool": {
"addressPrefixes": [ "string" ]
},
"vpnGatewayScaleUnit": "int"
},
"tags": {
"{customized property}": "string"
}
}
Property values
AddressSpace
| Name | Description | Value |
|---|---|---|
| addressPrefixes | A list of address blocks reserved for this virtual network in CIDR notation. | string[] |
Microsoft.Network/p2svpnGateways
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-11-01' |
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | Parameters for P2SVpnGateway | P2SVpnGatewayProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Network/p2svpnGateways' |
P2SVpnGatewayProperties
| Name | Description | Value |
|---|---|---|
| p2SVpnServerConfiguration | The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to. | SubResource |
| provisioningState | The provisioning state of the resource. | 'Deleting' 'Failed' 'Succeeded' 'Updating' |
| virtualHub | The VirtualHub to which the gateway belongs | SubResource |
| vpnClientAddressPool | The reference of the address space resource which represents Address space for P2S VpnClient. | AddressSpace |
| vpnGatewayScaleUnit | The scale unit for this p2s vpn gateway. | int |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Azure Virtual WAN (vWAN) Multi-Hub Deployment |
This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment including all gateways and VNET connections. |
| Azure vWAN Multi-Hub Deployment with Custom Routing Tables |
This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment, including all gateways and VNET connections, and demonstrate the usage of Route Tables for custom routing. |
| vWAN P2S deployment with multi address pool and user groups |
This template deploys Azure Virtual WAN (vWAN) with a P2S configured with multiple address pool and user groups |
Terraform (AzAPI provider) resource definition
The p2svpnGateways resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/p2svpnGateways resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/p2svpnGateways@2018-11-01"
name = "string"
location = "string"
body = jsonencode({
properties = {
p2SVpnServerConfiguration = {
id = "string"
}
provisioningState = "string"
virtualHub = {
id = "string"
}
vpnClientAddressPool = {
addressPrefixes = [
"string"
]
}
vpnGatewayScaleUnit = int
}
})
tags = {
{customized property} = "string"
}
}
Property values
AddressSpace
| Name | Description | Value |
|---|---|---|
| addressPrefixes | A list of address blocks reserved for this virtual network in CIDR notation. | string[] |
Microsoft.Network/p2svpnGateways
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | Parameters for P2SVpnGateway | P2SVpnGatewayProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Network/p2svpnGateways@2018-11-01" |
P2SVpnGatewayProperties
| Name | Description | Value |
|---|---|---|
| p2SVpnServerConfiguration | The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to. | SubResource |
| provisioningState | The provisioning state of the resource. | 'Deleting' 'Failed' 'Succeeded' 'Updating' |
| virtualHub | The VirtualHub to which the gateway belongs | SubResource |
| vpnClientAddressPool | The reference of the address space resource which represents Address space for P2S VpnClient. | AddressSpace |
| vpnGatewayScaleUnit | The scale unit for this p2s vpn gateway. | int |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |