Microsoft.Web sites/privateAccess 2021-02-01
Bicep resource definition
The sites/privateAccess 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.Web/sites/privateAccess resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/sites/privateAccess@2021-02-01' = {
name: 'virtualNetworks'
kind: 'string'
parent: resourceSymbolicName
properties: {
enabled: bool
virtualNetworks: [
{
key: int
name: 'string'
resourceId: 'string'
subnets: [
{
key: int
name: 'string'
}
]
}
]
}
}
Property values
sites/privateAccess
Name | Description | Value |
---|---|---|
name | The resource name See how to set names and types for child resources in Bicep. |
'virtualNetworks' |
kind | Kind of resource. | string |
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[] |
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[] |
PrivateAccessSubnet
Name | Description | Value |
---|---|---|
key | The key (ID) of the subnet. | int |
name | The name of the subnet. | string |
ARM template resource definition
The sites/privateAccess 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.Web/sites/privateAccess resource, add the following JSON to your template.
{
"type": "Microsoft.Web/sites/privateAccess",
"apiVersion": "2021-02-01",
"name": "virtualNetworks",
"kind": "string",
"properties": {
"enabled": "bool",
"virtualNetworks": [
{
"key": "int",
"name": "string",
"resourceId": "string",
"subnets": [
{
"key": "int",
"name": "string"
}
]
}
]
}
}
Property values
sites/privateAccess
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Web/sites/privateAccess' |
apiVersion | The resource api version | '2021-02-01' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
'virtualNetworks' |
kind | Kind of resource. | string |
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[] |
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[] |
PrivateAccessSubnet
Name | Description | Value |
---|---|---|
key | The key (ID) of the subnet. | int |
name | The name of the subnet. | string |
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 = "virtualNetworks"
parent_id = "string"
body = jsonencode({
properties = {
enabled = bool
virtualNetworks = [
{
key = int
name = "string"
resourceId = "string"
subnets = [
{
key = int
name = "string"
}
]
}
]
}
kind = "string"
})
}
Property values
sites/privateAccess
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.Web/sites/privateAccess@2021-02-01" |
name | The resource name | "virtualNetworks" |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: sites |
kind | Kind of resource. | string |
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[] |
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[] |
PrivateAccessSubnet
Name | Description | Value |
---|---|---|
key | The key (ID) of the subnet. | int |
name | The name of the subnet. | string |