Share via

Microsoft.Web sites/virtualNetworkConnections 2015-08-01

  • Article

Bicep resource definition

The sites/virtualNetworkConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/virtualNetworkConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/sites/virtualNetworkConnections@2015-08-01' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    certBlob: 'string'
    certThumbprint: 'string'
    dnsServers: 'string'
    resyncRequired: bool
    routes: [
      {
        id: 'string'
        kind: 'string'
        location: 'string'
        name: 'string'
        properties: {
          endAddress: 'string'
          name: 'string'
          routeType: 'string'
          startAddress: 'string'
        }
        tags: {
          {customized property}: 'string'
        }
        type: 'string'
      }
    ]
    vnetResourceId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.Web/sites/virtualNetworkConnections

Name Description Value
kind Kind of resource string
location Resource Location string (required)
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: sites
properties VnetInfoProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

ResourceTags

Name Description Value

VnetInfoProperties

Name Description Value
certBlob A certificate file (.cer) blob containing the public key of the private key used to authenticate a
Point-To-Site VPN connection.		 string
certThumbprint The client certificate thumbprint string
dnsServers Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. string
resyncRequired Flag to determine if a resync is required bool
routes The routes that this virtual network connection uses. VnetRoute[]
vnetResourceId The vnet resource id string

VnetRoute

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties VnetRouteProperties
tags Resource tags ResourceTags
type Resource type string

VnetRouteProperties

Name Description Value
endAddress The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. string
name The name of this route. This is only returned by the server and does not need to be set by the client. string
routeType The type of route this is:
DEFAULT - By default, every web app has routes to the local address ranges specified by RFC1918
INHERITED - Routes inherited from the real Virtual Network routes
STATIC - Static route set on the web app only

These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them
with new INHERITED routes.		 string
startAddress The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. string

ARM template resource definition

The sites/virtualNetworkConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/virtualNetworkConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/sites/virtualNetworkConnections",
  "apiVersion": "2015-08-01",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "certBlob": "string",
    "certThumbprint": "string",
    "dnsServers": "string",
    "resyncRequired": "bool",
    "routes": [
      {
        "id": "string",
        "kind": "string",
        "location": "string",
        "name": "string",
        "properties": {
          "endAddress": "string",
          "name": "string",
          "routeType": "string",
          "startAddress": "string"
        },
        "tags": {
          "{customized property}": "string"
        },
        "type": "string"
      }
    ],
    "vnetResourceId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.Web/sites/virtualNetworkConnections

Name Description Value
apiVersion The api version '2015-08-01'
kind Kind of resource string
location Resource Location string (required)
name The resource name string (required)
properties VnetInfoProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Web/sites/virtualNetworkConnections'

ResourceTags

Name Description Value

ResourceTags

Name Description Value

VnetInfoProperties

Name Description Value
certBlob A certificate file (.cer) blob containing the public key of the private key used to authenticate a
Point-To-Site VPN connection.		 string
certThumbprint The client certificate thumbprint string
dnsServers Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. string
resyncRequired Flag to determine if a resync is required bool
routes The routes that this virtual network connection uses. VnetRoute[]
vnetResourceId The vnet resource id string

VnetRoute

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties VnetRouteProperties
tags Resource tags ResourceTags
type Resource type string

VnetRouteProperties

Name Description Value
endAddress The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. string
name The name of this route. This is only returned by the server and does not need to be set by the client. string
routeType The type of route this is:
DEFAULT - By default, every web app has routes to the local address ranges specified by RFC1918
INHERITED - Routes inherited from the real Virtual Network routes
STATIC - Static route set on the web app only

These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them
with new INHERITED routes.		 string
startAddress The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. string

Terraform (AzAPI provider) resource definition

The sites/virtualNetworkConnections 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.Web/sites/virtualNetworkConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/virtualNetworkConnections@2015-08-01"
  name = "string"
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      certBlob = "string"
      certThumbprint = "string"
      dnsServers = "string"
      resyncRequired = bool
      routes = [
        {
          id = "string"
          kind = "string"
          location = "string"
          name = "string"
          properties = {
            endAddress = "string"
            name = "string"
            routeType = "string"
            startAddress = "string"
          }
          tags = {
            {customized property} = "string"
          }
          type = "string"
        }
      ]
      vnetResourceId = "string"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

Microsoft.Web/sites/virtualNetworkConnections

Name Description Value
kind Kind of resource string
location Resource Location string (required)
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites
properties VnetInfoProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Web/sites/virtualNetworkConnections@2015-08-01"

ResourceTags

Name Description Value

ResourceTags

Name Description Value

VnetInfoProperties

Name Description Value
certBlob A certificate file (.cer) blob containing the public key of the private key used to authenticate a
Point-To-Site VPN connection.		 string
certThumbprint The client certificate thumbprint string
dnsServers Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. string
resyncRequired Flag to determine if a resync is required bool
routes The routes that this virtual network connection uses. VnetRoute[]
vnetResourceId The vnet resource id string

VnetRoute

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties VnetRouteProperties
tags Resource tags ResourceTags
type Resource type string

VnetRouteProperties

Name Description Value
endAddress The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. string
name The name of this route. This is only returned by the server and does not need to be set by the client. string
routeType The type of route this is:
DEFAULT - By default, every web app has routes to the local address ranges specified by RFC1918
INHERITED - Routes inherited from the real Virtual Network routes
STATIC - Static route set on the web app only

These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them
with new INHERITED routes.		 string
startAddress The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. string