Share via

Microsoft.Web sites/virtualNetworkConnections 2016-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@2016-08-01' = {
  kind: 'string'
  name: 'string'
  properties: {
    certBlob: any(Azure.Bicep.Types.Concrete.AnyType)
    dnsServers: 'string'
    vnetResourceId: 'string'
  }
}

Property values

Microsoft.Web/sites/virtualNetworkConnections

Name Description Value
kind Kind of resource. string
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 VnetInfo resource specific properties VnetInfoProperties

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.		 any
dnsServers DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. string
vnetResourceId The Virtual Network's resource ID. 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": "2016-08-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "certBlob": {},
    "dnsServers": "string",
    "vnetResourceId": "string"
  }
}

Property values

Microsoft.Web/sites/virtualNetworkConnections

Name Description Value
apiVersion The api version '2016-08-01'
kind Kind of resource. string
name The resource name string (required)
properties VnetInfo resource specific properties VnetInfoProperties
type The resource type 'Microsoft.Web/sites/virtualNetworkConnections'

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.		 any
dnsServers DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. string
vnetResourceId The Virtual Network's resource ID. 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@2016-08-01"
  name = "string"
  kind = "string"
  body = jsonencode({
    properties = {
      certBlob = ?
      dnsServers = "string"
      vnetResourceId = "string"
    }
  })
}

Property values

Microsoft.Web/sites/virtualNetworkConnections

Name Description Value
kind Kind of resource. string
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 VnetInfo resource specific properties VnetInfoProperties
type The resource type "Microsoft.Web/sites/virtualNetworkConnections@2016-08-01"

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.		 any
dnsServers DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. string
vnetResourceId The Virtual Network's resource ID. string