Share via

Microsoft.Web sites/privateAccess 2021-02-01

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Web/sites/privateAccess@2021-02-01' = {
  kind: 'string'
  name: 'virtualNetworks'
  properties: {
    enabled: bool
    virtualNetworks: [
      {
        key: int
        name: 'string'
        resourceId: 'string'
        subnets: [
          {
            key: int
            name: 'string'
          }
        ]
      }
    ]
  }
}

Property values

Microsoft.Web/sites/privateAccess

Name Description Value
kind Kind of resource. string
name The resource name 'virtualNetworks' (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 PrivateAccess resource specific properties PrivateAccessProperties

PrivateAccessProperties

Name Description Value
enabled Whether private access is enabled or not. bool
virtualNetworks The Virtual Networks (and subnets) allowed to access the site privately. PrivateAccessVirtualNetwork[]

PrivateAccessSubnet

Name Description Value
key The key (ID) of the subnet. int
name The name of the subnet. string

PrivateAccessVirtualNetwork

Name Description Value
key The key (ID) of the Virtual Network. int
name The name of the Virtual Network. string
resourceId The ARM uri of the Virtual Network string
subnets A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. PrivateAccessSubnet[]

ARM template resource definition

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

{
  "type": "Microsoft.Web/sites/privateAccess",
  "apiVersion": "2021-02-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "enabled": "bool",
    "virtualNetworks": [
      {
        "key": "int",
        "name": "string",
        "resourceId": "string",
        "subnets": [
          {
            "key": "int",
            "name": "string"
          }
        ]
      }
    ]
  }
}

Property values

Microsoft.Web/sites/privateAccess

Name Description Value
apiVersion The api version '2021-02-01'
kind Kind of resource. string
name The resource name 'virtualNetworks' (required)
properties PrivateAccess resource specific properties PrivateAccessProperties
type The resource type 'Microsoft.Web/sites/privateAccess'

PrivateAccessProperties

Name Description Value
enabled Whether private access is enabled or not. bool
virtualNetworks The Virtual Networks (and subnets) allowed to access the site privately. PrivateAccessVirtualNetwork[]

PrivateAccessSubnet

Name Description Value
key The key (ID) of the subnet. int
name The name of the subnet. string

PrivateAccessVirtualNetwork

Name Description Value
key The key (ID) of the Virtual Network. int
name The name of the Virtual Network. string
resourceId The ARM uri of the Virtual Network string
subnets A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. PrivateAccessSubnet[]

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/privateAccess@2021-02-01"
  name = "string"
  kind = "string"
  body = jsonencode({
    properties = {
      enabled = bool
      virtualNetworks = [
        {
          key = int
          name = "string"
          resourceId = "string"
          subnets = [
            {
              key = int
              name = "string"
            }
          ]
        }
      ]
    }
  })
}

Property values

Microsoft.Web/sites/privateAccess

Name Description Value
kind Kind of resource. string
name The resource name 'virtualNetworks' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites
properties PrivateAccess resource specific properties PrivateAccessProperties
type The resource type "Microsoft.Web/sites/privateAccess@2021-02-01"

PrivateAccessProperties

Name Description Value
enabled Whether private access is enabled or not. bool
virtualNetworks The Virtual Networks (and subnets) allowed to access the site privately. PrivateAccessVirtualNetwork[]

PrivateAccessSubnet

Name Description Value
key The key (ID) of the subnet. int
name The name of the subnet. string

PrivateAccessVirtualNetwork

Name Description Value
key The key (ID) of the Virtual Network. int
name The name of the Virtual Network. string
resourceId The ARM uri of the Virtual Network string
subnets A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. PrivateAccessSubnet[]