Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2024-07-01
- 2024-05-01
- 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
- 2018-07-01
- 2018-06-01
- 2018-04-01
Bicep resource definition
The vpnSites 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/vpnSites resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/vpnSites@2018-06-01' = {
location: 'string'
name: 'string'
properties: {
addressSpace: {
addressPrefixes: [
'string'
]
}
bgpProperties: {
asn: int
bgpPeeringAddress: 'string'
peerWeight: int
}
deviceProperties: {
deviceModel: 'string'
deviceVendor: 'string'
linkSpeedInMbps: int
}
ipAddress: 'string'
provisioningState: 'string'
siteKey: 'string'
virtualWAN: {
id: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Network/vpnSites
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | Parameters for VpnSite | VpnSiteProperties |
| 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[] |
BgpSettings
| Name | Description | Value |
|---|---|---|
| asn | The BGP speaker's ASN. | int |
| bgpPeeringAddress | The BGP peering address and BGP identifier of this BGP speaker. | string |
| peerWeight | The weight added to routes learned from this BGP speaker. | int |
DeviceProperties
| Name | Description | Value |
|---|---|---|
| deviceModel | Model of the device. | string |
| deviceVendor | Name of the device Vendor. | string |
| linkSpeedInMbps | Link speed. | int |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VpnSiteProperties
| Name | Description | Value |
|---|---|---|
| addressSpace | The AddressSpace that contains an array of IP address ranges. | AddressSpace |
| bgpProperties | The set of bgp properties. | BgpSettings |
| deviceProperties | The device properties | DeviceProperties |
| ipAddress | The ip-address for the vpn-site. | string |
| provisioningState | The provisioning state of the resource. | 'Deleting' 'Failed' 'Succeeded' 'Updating' |
| siteKey | The key for vpn-site that can be used for connections. | string |
| virtualWAN | The VirtualWAN to which the vpnSite belongs | SubResource |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| VPN Site | AVM Resource Module for VPN Site |
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Creates Virtual WAN resources | This template allows you to create virtual WAN resources including Virtual WAN, Virtual Hub, VPN Gateway, VPN Site and a VPN Connecton. |
ARM template resource definition
The vpnSites 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/vpnSites resource, add the following JSON to your template.
{
"type": "Microsoft.Network/vpnSites",
"apiVersion": "2018-06-01",
"name": "string",
"location": "string",
"properties": {
"addressSpace": {
"addressPrefixes": [ "string" ]
},
"bgpProperties": {
"asn": "int",
"bgpPeeringAddress": "string",
"peerWeight": "int"
},
"deviceProperties": {
"deviceModel": "string",
"deviceVendor": "string",
"linkSpeedInMbps": "int"
},
"ipAddress": "string",
"provisioningState": "string",
"siteKey": "string",
"virtualWAN": {
"id": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Network/vpnSites
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-06-01' |
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | Parameters for VpnSite | VpnSiteProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Network/vpnSites' |
AddressSpace
| Name | Description | Value |
|---|---|---|
| addressPrefixes | A list of address blocks reserved for this virtual network in CIDR notation. | string[] |
BgpSettings
| Name | Description | Value |
|---|---|---|
| asn | The BGP speaker's ASN. | int |
| bgpPeeringAddress | The BGP peering address and BGP identifier of this BGP speaker. | string |
| peerWeight | The weight added to routes learned from this BGP speaker. | int |
DeviceProperties
| Name | Description | Value |
|---|---|---|
| deviceModel | Model of the device. | string |
| deviceVendor | Name of the device Vendor. | string |
| linkSpeedInMbps | Link speed. | int |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VpnSiteProperties
| Name | Description | Value |
|---|---|---|
| addressSpace | The AddressSpace that contains an array of IP address ranges. | AddressSpace |
| bgpProperties | The set of bgp properties. | BgpSettings |
| deviceProperties | The device properties | DeviceProperties |
| ipAddress | The ip-address for the vpn-site. | string |
| provisioningState | The provisioning state of the resource. | 'Deleting' 'Failed' 'Succeeded' 'Updating' |
| siteKey | The key for vpn-site that can be used for connections. | string |
| virtualWAN | The VirtualWAN to which the vpnSite belongs | SubResource |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Creates Virtual WAN resources |
This template allows you to create virtual WAN resources including Virtual WAN, Virtual Hub, VPN Gateway, VPN Site and a VPN Connecton. |
Terraform (AzAPI provider) resource definition
The vpnSites 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/vpnSites resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnSites@2018-06-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
addressSpace = {
addressPrefixes = [
"string"
]
}
bgpProperties = {
asn = int
bgpPeeringAddress = "string"
peerWeight = int
}
deviceProperties = {
deviceModel = "string"
deviceVendor = "string"
linkSpeedInMbps = int
}
ipAddress = "string"
provisioningState = "string"
siteKey = "string"
virtualWAN = {
id = "string"
}
}
}
}
Property Values
Microsoft.Network/vpnSites
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | Parameters for VpnSite | VpnSiteProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Network/vpnSites@2018-06-01" |
AddressSpace
| Name | Description | Value |
|---|---|---|
| addressPrefixes | A list of address blocks reserved for this virtual network in CIDR notation. | string[] |
BgpSettings
| Name | Description | Value |
|---|---|---|
| asn | The BGP speaker's ASN. | int |
| bgpPeeringAddress | The BGP peering address and BGP identifier of this BGP speaker. | string |
| peerWeight | The weight added to routes learned from this BGP speaker. | int |
DeviceProperties
| Name | Description | Value |
|---|---|---|
| deviceModel | Model of the device. | string |
| deviceVendor | Name of the device Vendor. | string |
| linkSpeedInMbps | Link speed. | int |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VpnSiteProperties
| Name | Description | Value |
|---|---|---|
| addressSpace | The AddressSpace that contains an array of IP address ranges. | AddressSpace |
| bgpProperties | The set of bgp properties. | BgpSettings |
| deviceProperties | The device properties | DeviceProperties |
| ipAddress | The ip-address for the vpn-site. | string |
| provisioningState | The provisioning state of the resource. | 'Deleting' 'Failed' 'Succeeded' 'Updating' |
| siteKey | The key for vpn-site that can be used for connections. | string |
| virtualWAN | The VirtualWAN to which the vpnSite belongs | SubResource |