Microsoft.Network virtualNetworks/subnets 2018-04-01

Article
10/24/2024

Remarks

For guidance on creating virtual networks and subnets, see Create virtual network resources by using Bicep.

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/virtualNetworks/subnets@2018-04-01' = {
  etag: 'string'
  name: 'string'
  properties: {
    addressPrefix: 'string'
    networkSecurityGroup: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        defaultSecurityRules: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              access: 'string'
              description: 'string'
              destinationAddressPrefix: 'string'
              destinationAddressPrefixes: [
                'string'
              ]
              destinationApplicationSecurityGroups: [
                {
                  id: 'string'
                  location: 'string'
                  properties: {}
                  tags: {
                    {customized property}: 'string'
                  }
                }
              ]
              destinationPortRange: 'string'
              destinationPortRanges: [
                'string'
              ]
              direction: 'string'
              priority: int
              protocol: 'string'
              provisioningState: 'string'
              sourceAddressPrefix: 'string'
              sourceAddressPrefixes: [
                'string'
              ]
              sourceApplicationSecurityGroups: [
                {
                  id: 'string'
                  location: 'string'
                  properties: {}
                  tags: {
                    {customized property}: 'string'
                  }
                }
              ]
              sourcePortRange: 'string'
              sourcePortRanges: [
                'string'
              ]
            }
          }
        ]
        provisioningState: 'string'
        resourceGuid: 'string'
        securityRules: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              access: 'string'
              description: 'string'
              destinationAddressPrefix: 'string'
              destinationAddressPrefixes: [
                'string'
              ]
              destinationApplicationSecurityGroups: [
                {
                  id: 'string'
                  location: 'string'
                  properties: {}
                  tags: {
                    {customized property}: 'string'
                  }
                }
              ]
              destinationPortRange: 'string'
              destinationPortRanges: [
                'string'
              ]
              direction: 'string'
              priority: int
              protocol: 'string'
              provisioningState: 'string'
              sourceAddressPrefix: 'string'
              sourceAddressPrefixes: [
                'string'
              ]
              sourceApplicationSecurityGroups: [
                {
                  id: 'string'
                  location: 'string'
                  properties: {}
                  tags: {
                    {customized property}: 'string'
                  }
                }
              ]
              sourcePortRange: 'string'
              sourcePortRanges: [
                'string'
              ]
            }
          }
        ]
      }
      tags: {
        {customized property}: 'string'
      }
    }
    provisioningState: 'string'
    resourceNavigationLinks: [
      {
        id: 'string'
        name: 'string'
        properties: {
          link: 'string'
          linkedResourceType: 'string'
        }
      }
    ]
    routeTable: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        disableBgpRoutePropagation: bool
        provisioningState: 'string'
        routes: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              addressPrefix: 'string'
              nextHopIpAddress: 'string'
              nextHopType: 'string'
              provisioningState: 'string'
            }
          }
        ]
      }
      tags: {
        {customized property}: 'string'
      }
    }
    serviceEndpoints: [
      {
        locations: [
          'string'
        ]
        provisioningState: 'string'
        service: 'string'
      }
    ]
  }
}

Property values

ApplicationSecurityGroup

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the application security group.	ApplicationSecurityGroupPropertiesFormat
tags	Resource tags.	ResourceTags

ApplicationSecurityGroupPropertiesFormat

Name	Description	Value

Microsoft.Network/virtualNetworks/subnets

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	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: virtualNetworks
properties	Properties of the subnet.	SubnetPropertiesFormat

NetworkSecurityGroup

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the network security group	NetworkSecurityGroupPropertiesFormat
tags	Resource tags.	ResourceTags

NetworkSecurityGroupPropertiesFormat

Name	Description	Value
defaultSecurityRules	The default security rules of network security group.	SecurityRule[]
provisioningState	The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
resourceGuid	The resource GUID property of the network security group resource.	string
securityRules	A collection of security rules of the network security group.	SecurityRule[]

ResourceNavigationLink

Name	Description	Value
id	Resource ID.	string
name	Name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Resource navigation link properties format.	ResourceNavigationLinkFormat

ResourceNavigationLinkFormat

Name	Description	Value
link	Link to the external resource	string
linkedResourceType	Resource type of the linked resource.	string

ResourceTags

Name	Description	Value

ResourceTags

Name	Description	Value

ResourceTags

Name	Description	Value

Route

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the route.	RoutePropertiesFormat

RoutePropertiesFormat

Name	Description	Value
addressPrefix	The destination CIDR to which the route applies.	string
nextHopIpAddress	The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.	string
nextHopType	The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'	'Internet' 'None' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required)
provisioningState	The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string

RouteTable

Name	Description	Value
etag	Gets a unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the route table.	RouteTablePropertiesFormat
tags	Resource tags.	ResourceTags

RouteTablePropertiesFormat

Name	Description	Value
disableBgpRoutePropagation	Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.	bool
provisioningState	The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
routes	Collection of routes contained within a route table.	Route[]

SecurityRule

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the security rule	SecurityRulePropertiesFormat

SecurityRulePropertiesFormat

Name	Description	Value
access	The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.	'Allow' 'Deny' (required)
description	A description for this rule. Restricted to 140 chars.	string
destinationAddressPrefix	The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.	string
destinationAddressPrefixes	The destination address prefixes. CIDR or destination IP ranges.	string[]
destinationApplicationSecurityGroups	The application security group specified as destination.	ApplicationSecurityGroup[]
destinationPortRange	The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
destinationPortRanges	The destination port ranges.	string[]
direction	The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.	'Inbound' 'Outbound' (required)
priority	The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.	int
protocol	Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.	'*' 'Tcp' 'Udp' (required)
provisioningState	The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
sourceAddressPrefix	The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.	string
sourceAddressPrefixes	The CIDR or source IP ranges.	string[]
sourceApplicationSecurityGroups	The application security group specified as source.	ApplicationSecurityGroup[]
sourcePortRange	The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
sourcePortRanges	The source port ranges.	string[]

ServiceEndpointPropertiesFormat

Name	Description	Value
locations	A list of locations.	string[]
provisioningState	The provisioning state of the resource.	string
service	The type of the endpoint service.	string

SubnetPropertiesFormat

Name	Description	Value
addressPrefix	The address prefix for the subnet.	string
networkSecurityGroup	The reference of the NetworkSecurityGroup resource.	NetworkSecurityGroup
provisioningState	The provisioning state of the resource.	string
resourceNavigationLinks	Gets an array of references to the external resources using subnet.	ResourceNavigationLink[]
routeTable	The reference of the RouteTable resource.	RouteTable
serviceEndpoints	An array of service endpoints.	ServiceEndpointPropertiesFormat[]

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Add a subnet to an existing VNET	This template allows you to add a subnet to an existing VNET. Deploy into the resource group of the existing VNET
Azure Bastion as a Service	This template provisions Azure Bastion in a Virtual Network
Azure Bastion as a Service with NSG	This template provisions Azure Bastion in a Virtual Network
Azure Batch pool without public IP addresses	This template creates Azure Batch simplified node communication pool without public IP addresses.
Azure Cloud Shell - VNet	This template deploys Azure Cloud Shell resources into an Azure virtual network.
Azure Container Instances - VNet	Deploy a container instance into an Azure virtual network.
Azure Game Developer Virtual Machine Scale Set	Azure Game Developer Virtual Machine Scale Set includes Licencsed Engines like Unreal.
Azure Machine Learning end-to-end secure setup	This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Azure Machine Learning end-to-end secure setup (legacy)	This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Create a cross-region load balancer	This template creates a cross-region load balancer with a backend pool containing two regional load balancers. Cross-region load balancer is currently available in limited regions. The regional load balancers behind the cross-region load balancer can be in any region.
Create a Route Server in a New Subnet	This template deploys a Route Server into a subnet named RouteServerSubnet.
Create a standard internal load balancer	This template creates a standard internal Azure Load Balancer with a rule load-balancing port 80
Create a standard load-balancer	This template creates an Internet-facing load-balancer, load balancing rules, and three VMs for the backend pool with each VM in a redundant zone.
Create AKS with Prometheus and Grafana with privae link	This will create an Azure grafana, AKS and install Prometheus, an open-source monitoring and alerting toolkit, on an Azure Kubernetes Service (AKS) cluster. Then you use Azure Managed Grafana's managed private endpoint to connect to this Prometheus server and display the Prometheus data in a Grafana dashboard
Create an AppServicePlan and App in an ASEv3	Create an AppServicePlan and App in an ASEv3
Create an Azure Firewall with multiple IP public addresses	This template creates an Azure Firewall with two public IP addresses and two Windows Server 2019 servers to test.
Create an Azure Machine Learning service workspace (legacy)	This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.
Create an Azure Machine Learning service workspace (vnet)	This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.
Create sandbox of Azure Firewall, client VM, and server VM	This template creates a virtual network with 2 subnets (server subnet and AzureFirewall subnet), A server VM, a client VM, a public IP address for each VM, and a route table to send traffic between VMs through the firewall.
Creates a Cross-tenant Private Endpoint resource	This template allows you to create Priavate Endpoint resource within the same or cross-tenant environment and add dns zone configuration.
Creates AVD with Microsoft Entra ID Join	This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, a test session host and its extensions with Microsoft Entra ID join
Deploy a simple Windows VM with tags	This template will deploy a D2_v3 Windows VM, NIC, Storage Account, Virtual Network, Public IP Address, and Network Security Group. The tag object is created in the variables and will be applied on all resources, where applicable.
Deploy Azure Database for MySQL with VNet	This template provides a way to deploy an Azure database for MySQL with VNet integration.
Deploy Azure Database for PostgreSQL (flexible) with VNet	This template provides a way to deploy a Flexible server Azure database for PostgreSQL with VNet integration.
Deploy Azure Database for PostgreSQL with VNet	This template provides a way to deploy an Azure database for PostgreSQL with VNet integration.
Deploy Azure Database Migration Service (DMS)	Azure Database Migration Service is a fully managed service designed to enable seamless migrations from multiple database sources to Azure data platforms with minimal downtime (online migrations).
Deploy MySQL Flexible Server with Private Endpoint	This template provides a way to deploy a Azure Database for MySQL Flexible Server with Private Endpoint.
Deploy MySQL Flexible Server with Vnet Integration	This template provides a way to deploy a Azure database for MySQL Flexible Server with VNet Integration.
GitLab Omnibus	This template simplifies the deployment of GitLab Omnibus on a Virtual Machine with a public DNS, leveraging the public IP's DNS. It utilizes the Standard_F8s_v2 instance size, which aligns with reference architecture and supports up to 1000 users (20 RPS). The instance is pre-configured to use HTTPS with a Let's Encrypt certificate for secure connections.
Private Endpoint example	This template shows how to create a private endpoint pointing to Azure SQL Server
Secured virtual hubs	This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
SharePoint Subscription / 2019 / 2016 fully configured	Create a DC, a SQL Server 2022, and from 1 to 5 server(s) hosting a SharePoint Subscription / 2019 / 2016 farm with an extensive configuration, including trusted authentication, user profiles with personal sites, an OAuth trust (using a certificate), a dedicated IIS site for hosting high-trust add-ins, etc... The latest version of key softwares (including Fiddler, vscode, np++, 7zip, ULS Viewer) is installed. SharePoint machines have additional fine-tuning to make them immediately usable (remote administration tools, custom policies for Edge and Chrome, shortcuts, etc...).
Virtual Network NAT with VM	Deploy a NAT gateway and virtual machine

ARM template resource definition

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

{
  "type": "Microsoft.Network/virtualNetworks/subnets",
  "apiVersion": "2018-04-01",
  "name": "string",
  "etag": "string",
  "properties": {
    "addressPrefix": "string",
    "networkSecurityGroup": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "defaultSecurityRules": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "access": "string",
              "description": "string",
              "destinationAddressPrefix": "string",
              "destinationAddressPrefixes": [ "string" ],
              "destinationApplicationSecurityGroups": [
                {
                  "id": "string",
                  "location": "string",
                  "properties": {
                  },
                  "tags": {
                    "{customized property}": "string"
                  }
                }
              ],
              "destinationPortRange": "string",
              "destinationPortRanges": [ "string" ],
              "direction": "string",
              "priority": "int",
              "protocol": "string",
              "provisioningState": "string",
              "sourceAddressPrefix": "string",
              "sourceAddressPrefixes": [ "string" ],
              "sourceApplicationSecurityGroups": [
                {
                  "id": "string",
                  "location": "string",
                  "properties": {
                  },
                  "tags": {
                    "{customized property}": "string"
                  }
                }
              ],
              "sourcePortRange": "string",
              "sourcePortRanges": [ "string" ]
            }
          }
        ],
        "provisioningState": "string",
        "resourceGuid": "string",
        "securityRules": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "access": "string",
              "description": "string",
              "destinationAddressPrefix": "string",
              "destinationAddressPrefixes": [ "string" ],
              "destinationApplicationSecurityGroups": [
                {
                  "id": "string",
                  "location": "string",
                  "properties": {
                  },
                  "tags": {
                    "{customized property}": "string"
                  }
                }
              ],
              "destinationPortRange": "string",
              "destinationPortRanges": [ "string" ],
              "direction": "string",
              "priority": "int",
              "protocol": "string",
              "provisioningState": "string",
              "sourceAddressPrefix": "string",
              "sourceAddressPrefixes": [ "string" ],
              "sourceApplicationSecurityGroups": [
                {
                  "id": "string",
                  "location": "string",
                  "properties": {
                  },
                  "tags": {
                    "{customized property}": "string"
                  }
                }
              ],
              "sourcePortRange": "string",
              "sourcePortRanges": [ "string" ]
            }
          }
        ]
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "provisioningState": "string",
    "resourceNavigationLinks": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "link": "string",
          "linkedResourceType": "string"
        }
      }
    ],
    "routeTable": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "disableBgpRoutePropagation": "bool",
        "provisioningState": "string",
        "routes": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "addressPrefix": "string",
              "nextHopIpAddress": "string",
              "nextHopType": "string",
              "provisioningState": "string"
            }
          }
        ]
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "serviceEndpoints": [
      {
        "locations": [ "string" ],
        "provisioningState": "string",
        "service": "string"
      }
    ]
  }
}

Property values

ApplicationSecurityGroup

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the application security group.	ApplicationSecurityGroupPropertiesFormat
tags	Resource tags.	ResourceTags

ApplicationSecurityGroupPropertiesFormat

Name	Description	Value

Microsoft.Network/virtualNetworks/subnets

Name	Description	Value
apiVersion	The api version	'2018-04-01'
etag	A unique read-only string that changes whenever the resource is updated.	string
name	The resource name	string (required)
properties	Properties of the subnet.	SubnetPropertiesFormat
type	The resource type	'Microsoft.Network/virtualNetworks/subnets'

NetworkSecurityGroup

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the network security group	NetworkSecurityGroupPropertiesFormat
tags	Resource tags.	ResourceTags

NetworkSecurityGroupPropertiesFormat

Name	Description	Value
defaultSecurityRules	The default security rules of network security group.	SecurityRule[]
provisioningState	The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
resourceGuid	The resource GUID property of the network security group resource.	string
securityRules	A collection of security rules of the network security group.	SecurityRule[]

ResourceNavigationLink

Name	Description	Value
id	Resource ID.	string
name	Name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Resource navigation link properties format.	ResourceNavigationLinkFormat

ResourceNavigationLinkFormat

Name	Description	Value
link	Link to the external resource	string
linkedResourceType	Resource type of the linked resource.	string

ResourceTags

Name	Description	Value

ResourceTags

Name	Description	Value

ResourceTags

Name	Description	Value

Route

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the route.	RoutePropertiesFormat

RoutePropertiesFormat

Name	Description	Value
addressPrefix	The destination CIDR to which the route applies.	string
nextHopIpAddress	The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.	string
nextHopType	The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'	'Internet' 'None' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required)
provisioningState	The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string

RouteTable

Name	Description	Value
etag	Gets a unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the route table.	RouteTablePropertiesFormat
tags	Resource tags.	ResourceTags

RouteTablePropertiesFormat

Name	Description	Value
disableBgpRoutePropagation	Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.	bool
provisioningState	The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
routes	Collection of routes contained within a route table.	Route[]

SecurityRule

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the security rule	SecurityRulePropertiesFormat

SecurityRulePropertiesFormat

Name	Description	Value
access	The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.	'Allow' 'Deny' (required)
description	A description for this rule. Restricted to 140 chars.	string
destinationAddressPrefix	The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.	string
destinationAddressPrefixes	The destination address prefixes. CIDR or destination IP ranges.	string[]
destinationApplicationSecurityGroups	The application security group specified as destination.	ApplicationSecurityGroup[]
destinationPortRange	The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
destinationPortRanges	The destination port ranges.	string[]
direction	The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.	'Inbound' 'Outbound' (required)
priority	The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.	int
protocol	Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.	'*' 'Tcp' 'Udp' (required)
provisioningState	The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
sourceAddressPrefix	The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.	string
sourceAddressPrefixes	The CIDR or source IP ranges.	string[]
sourceApplicationSecurityGroups	The application security group specified as source.	ApplicationSecurityGroup[]
sourcePortRange	The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
sourcePortRanges	The source port ranges.	string[]

ServiceEndpointPropertiesFormat

Name	Description	Value
locations	A list of locations.	string[]
provisioningState	The provisioning state of the resource.	string
service	The type of the endpoint service.	string

SubnetPropertiesFormat

Name	Description	Value
addressPrefix	The address prefix for the subnet.	string
networkSecurityGroup	The reference of the NetworkSecurityGroup resource.	NetworkSecurityGroup
provisioningState	The provisioning state of the resource.	string
resourceNavigationLinks	Gets an array of references to the external resources using subnet.	ResourceNavigationLink[]
routeTable	The reference of the RouteTable resource.	RouteTable
serviceEndpoints	An array of service endpoints.	ServiceEndpointPropertiesFormat[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Add a subnet to an existing VNET	This template allows you to add a subnet to an existing VNET. Deploy into the resource group of the existing VNET
Add an NSG with Redis security rules to an existing subnet	This template allows you to add an NSG with preconfigured Azure Redis Cache security rules to an existing subnet within a VNET. Deploy into the resource group of the existing VNET.
App Service Environment with Azure SQL backend	This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment.
Azure Bastion as a Service	This template provisions Azure Bastion in a Virtual Network
Azure Bastion as a Service with NSG	This template provisions Azure Bastion in a Virtual Network
Azure Batch pool without public IP addresses	This template creates Azure Batch simplified node communication pool without public IP addresses.
Azure Cloud Shell - VNet	This template deploys Azure Cloud Shell resources into an Azure virtual network.
Azure Container Instances - VNet	Deploy a container instance into an Azure virtual network.
Azure Game Developer Virtual Machine Scale Set	Azure Game Developer Virtual Machine Scale Set includes Licencsed Engines like Unreal.
Azure Machine Learning end-to-end secure setup	This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Azure Machine Learning end-to-end secure setup (legacy)	This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Create a cross-region load balancer	This template creates a cross-region load balancer with a backend pool containing two regional load balancers. Cross-region load balancer is currently available in limited regions. The regional load balancers behind the cross-region load balancer can be in any region.
Create a Route Server in a New Subnet	This template deploys a Route Server into a subnet named RouteServerSubnet.
Create a standard internal load balancer	This template creates a standard internal Azure Load Balancer with a rule load-balancing port 80
Create a standard load-balancer	This template creates an Internet-facing load-balancer, load balancing rules, and three VMs for the backend pool with each VM in a redundant zone.
Create AKS with Prometheus and Grafana with privae link	This will create an Azure grafana, AKS and install Prometheus, an open-source monitoring and alerting toolkit, on an Azure Kubernetes Service (AKS) cluster. Then you use Azure Managed Grafana's managed private endpoint to connect to this Prometheus server and display the Prometheus data in a Grafana dashboard
Create an AppServicePlan and App in an ASEv3	Create an AppServicePlan and App in an ASEv3
Create an Azure Firewall with multiple IP public addresses	This template creates an Azure Firewall with two public IP addresses and two Windows Server 2019 servers to test.
Create an Azure Machine Learning service workspace (legacy)	This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.
Create an Azure Machine Learning service workspace (vnet)	This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.
Create an Azure Payment HSM	This template creates an Azure Payment HSM, to provide cryptographic key operations for real-time, critical payment transactions in the Azure cloud.
Create new ANF resource with SMB volume	This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with SMB protocol.
Create sandbox of Azure Firewall, client VM, and server VM	This template creates a virtual network with 2 subnets (server subnet and AzureFirewall subnet), A server VM, a client VM, a public IP address for each VM, and a route table to send traffic between VMs through the firewall.
Creates a Cross-tenant Private Endpoint resource	This template allows you to create Priavate Endpoint resource within the same or cross-tenant environment and add dns zone configuration.
Creates AVD with Microsoft Entra ID Join	This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, a test session host and its extensions with Microsoft Entra ID join
Deploy a Hub and Spoke topology sandbox	This template creates a basic hub-and-spoke topology setup. It creates a Hub VNet with subnets DMZ, Management, Shared and Gateway (optionally), with two Spoke VNets (development and production) containing a workload subnet each. It also deploys a Windows Jump-Host on the Management subnet of the HUB, and establishes VNet peerings between the Hub and the two spokes.
Deploy a simple Windows VM with tags	This template will deploy a D2_v3 Windows VM, NIC, Storage Account, Virtual Network, Public IP Address, and Network Security Group. The tag object is created in the variables and will be applied on all resources, where applicable.
Deploy Azure Database for MySQL with VNet	This template provides a way to deploy an Azure database for MySQL with VNet integration.
Deploy Azure Database for PostgreSQL (flexible) with VNet	This template provides a way to deploy a Flexible server Azure database for PostgreSQL with VNet integration.
Deploy Azure Database for PostgreSQL with VNet	This template provides a way to deploy an Azure database for PostgreSQL with VNet integration.
Deploy Azure Database Migration Service (DMS)	Azure Database Migration Service is a fully managed service designed to enable seamless migrations from multiple database sources to Azure data platforms with minimal downtime (online migrations).
Deploy Darktrace Autoscaling vSensors	This template allows you to deploy an automatically autoscaling deployment of Darktrace vSensors
Deploy MySQL Flexible Server with Private Endpoint	This template provides a way to deploy a Azure Database for MySQL Flexible Server with Private Endpoint.
Deploy MySQL Flexible Server with Vnet Integration	This template provides a way to deploy a Azure database for MySQL Flexible Server with VNet Integration.
eShop Website with ILB ASE	An App Service Environment is a Premium service plan option of Azure App Service that provides a fully isolated and dedicated environment for securely running Azure App Service apps at high scale, including Web Apps, Mobile Apps, and API Apps.
GitLab Omnibus	This template simplifies the deployment of GitLab Omnibus on a Virtual Machine with a public DNS, leveraging the public IP's DNS. It utilizes the Standard_F8s_v2 instance size, which aligns with reference architecture and supports up to 1000 users (20 RPS). The instance is pre-configured to use HTTPS with a Let's Encrypt certificate for secure connections.
GPU Vm with OBS-Studio, Skype, MS-Teams for event streaming	This template creates a GPU Vm with OBS-Studio, Skype, MS-Teams for event streaming. It creates the VM in a new vnet, storage account, nic, and public ip with the new compute stack. All installation process based on Chocolately package manager
JMeter environment for Elasticsearch	This template will deploy a JMeter environment into an existing virtual network. One master node and multiple subordinate nodes are deployed into a new jmeter subnet. This template works in conjunction with the Elasticsearch quickstart template.
Multi-client VNS3 network appliance	VNS3 is a software only virtual appliance that provides the combined features and functions of a Security Appliance, Application Delivery Controller and Unified Threat Management device at the cloud application edge. Key benefits, On top of cloud networking, Always on end to end encryption, Federate data centres, cloud regions, cloud providers, and/or containers, creating one unified address space, Attestable control over encryption keys, Meshed network manageable at scale, Reliable HA in the Cloud, Isolate sensitive applications (fast low cost Network Segmentation), Segmentation within applications, Analysis of all data in motion in the cloud. Key network functions; virtual router, switch, firewall, vpn concentrator, multicast distributor, with plugins for WAF, NIDS, Caching, Proxy Load Balancers and other Layer 4 thru 7 network functions, VNS3 doesn't require new knowledge or training to implement, so you can integrate with existing network equipment.
Private Endpoint example	This template shows how to create a private endpoint pointing to Azure SQL Server
Secured virtual hubs	This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
SharePoint Subscription / 2019 / 2016 fully configured	Create a DC, a SQL Server 2022, and from 1 to 5 server(s) hosting a SharePoint Subscription / 2019 / 2016 farm with an extensive configuration, including trusted authentication, user profiles with personal sites, an OAuth trust (using a certificate), a dedicated IIS site for hosting high-trust add-ins, etc... The latest version of key softwares (including Fiddler, vscode, np++, 7zip, ULS Viewer) is installed. SharePoint machines have additional fine-tuning to make them immediately usable (remote administration tools, custom policies for Edge and Chrome, shortcuts, etc...).
Standard Load Balancer with Backend Pool by IP Addresses	This template is used to demonstrate how ARM Templates can be used to configure the Backend Pool of a Load Balancer by IP Address as outlined in the Backend Pool management document.
Virtual Network NAT with VM	Deploy a NAT gateway and virtual machine
VNS3 network appliance for cloud connectivity and security	VNS3 is a software only virtual appliance that provides the combined features and functions of a security appliance, application delivery controller and unified threat management device at the cloud application edge. Key benefits, on top of cloud networking, always on end to end encryption, federate data centres, cloud regions, cloud providers, and/or containers, creating one unified address space, attestable control over encryption keys, meshed network manageable at scale, reliable HA in the cloud, isolate sensitive applications (fast low cost Network Segmentation), segmentation within applications, Analysis of all data in motion in the cloud. Key network functions; virtual router, switch, firewall, vpn concentrator, multicast distributor, with plugins for WAF, NIDS, caching, proxy, load balancers and other layer 4 thru 7 network functions, VNS3 doesn't require new knowledge or training to implement, so you can integrate with existing network equipment.
Web App with Private Endpoint	This template allows you to create a Web App and expose it through Private Endpoint

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworks/subnets@2018-04-01"
  name = "string"
  etag = "string"
  body = jsonencode({
    properties = {
      addressPrefix = "string"
      networkSecurityGroup = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          defaultSecurityRules = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                access = "string"
                description = "string"
                destinationAddressPrefix = "string"
                destinationAddressPrefixes = [
                  "string"
                ]
                destinationApplicationSecurityGroups = [
                  {
                    id = "string"
                    location = "string"
                    properties = {
                    }
                    tags = {
                      {customized property} = "string"
                    }
                  }
                ]
                destinationPortRange = "string"
                destinationPortRanges = [
                  "string"
                ]
                direction = "string"
                priority = int
                protocol = "string"
                provisioningState = "string"
                sourceAddressPrefix = "string"
                sourceAddressPrefixes = [
                  "string"
                ]
                sourceApplicationSecurityGroups = [
                  {
                    id = "string"
                    location = "string"
                    properties = {
                    }
                    tags = {
                      {customized property} = "string"
                    }
                  }
                ]
                sourcePortRange = "string"
                sourcePortRanges = [
                  "string"
                ]
              }
            }
          ]
          provisioningState = "string"
          resourceGuid = "string"
          securityRules = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                access = "string"
                description = "string"
                destinationAddressPrefix = "string"
                destinationAddressPrefixes = [
                  "string"
                ]
                destinationApplicationSecurityGroups = [
                  {
                    id = "string"
                    location = "string"
                    properties = {
                    }
                    tags = {
                      {customized property} = "string"
                    }
                  }
                ]
                destinationPortRange = "string"
                destinationPortRanges = [
                  "string"
                ]
                direction = "string"
                priority = int
                protocol = "string"
                provisioningState = "string"
                sourceAddressPrefix = "string"
                sourceAddressPrefixes = [
                  "string"
                ]
                sourceApplicationSecurityGroups = [
                  {
                    id = "string"
                    location = "string"
                    properties = {
                    }
                    tags = {
                      {customized property} = "string"
                    }
                  }
                ]
                sourcePortRange = "string"
                sourcePortRanges = [
                  "string"
                ]
              }
            }
          ]
        }
        tags = {
          {customized property} = "string"
        }
      }
      provisioningState = "string"
      resourceNavigationLinks = [
        {
          id = "string"
          name = "string"
          properties = {
            link = "string"
            linkedResourceType = "string"
          }
        }
      ]
      routeTable = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          disableBgpRoutePropagation = bool
          provisioningState = "string"
          routes = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                addressPrefix = "string"
                nextHopIpAddress = "string"
                nextHopType = "string"
                provisioningState = "string"
              }
            }
          ]
        }
        tags = {
          {customized property} = "string"
        }
      }
      serviceEndpoints = [
        {
          locations = [
            "string"
          ]
          provisioningState = "string"
          service = "string"
        }
      ]
    }
  })
}

Property values

ApplicationSecurityGroup

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the application security group.	ApplicationSecurityGroupPropertiesFormat
tags	Resource tags.	ResourceTags

ApplicationSecurityGroupPropertiesFormat

Name	Description	Value

Microsoft.Network/virtualNetworks/subnets

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	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: virtualNetworks
properties	Properties of the subnet.	SubnetPropertiesFormat
type	The resource type	"Microsoft.Network/virtualNetworks/subnets@2018-04-01"

NetworkSecurityGroup

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the network security group	NetworkSecurityGroupPropertiesFormat
tags	Resource tags.	ResourceTags

NetworkSecurityGroupPropertiesFormat

Name	Description	Value
defaultSecurityRules	The default security rules of network security group.	SecurityRule[]
provisioningState	The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
resourceGuid	The resource GUID property of the network security group resource.	string
securityRules	A collection of security rules of the network security group.	SecurityRule[]

ResourceNavigationLink

Name	Description	Value
id	Resource ID.	string
name	Name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Resource navigation link properties format.	ResourceNavigationLinkFormat

ResourceNavigationLinkFormat

Name	Description	Value
link	Link to the external resource	string
linkedResourceType	Resource type of the linked resource.	string

ResourceTags

Name	Description	Value

ResourceTags

Name	Description	Value

ResourceTags

Name	Description	Value

Route

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the route.	RoutePropertiesFormat

RoutePropertiesFormat

Name	Description	Value
addressPrefix	The destination CIDR to which the route applies.	string
nextHopIpAddress	The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.	string
nextHopType	The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'	'Internet' 'None' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required)
provisioningState	The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string

RouteTable

Name	Description	Value
etag	Gets a unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the route table.	RouteTablePropertiesFormat
tags	Resource tags.	ResourceTags

RouteTablePropertiesFormat

Name	Description	Value
disableBgpRoutePropagation	Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.	bool
provisioningState	The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
routes	Collection of routes contained within a route table.	Route[]

SecurityRule

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the security rule	SecurityRulePropertiesFormat

SecurityRulePropertiesFormat

Name	Description	Value
access	The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.	'Allow' 'Deny' (required)
description	A description for this rule. Restricted to 140 chars.	string
destinationAddressPrefix	The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.	string
destinationAddressPrefixes	The destination address prefixes. CIDR or destination IP ranges.	string[]
destinationApplicationSecurityGroups	The application security group specified as destination.	ApplicationSecurityGroup[]
destinationPortRange	The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
destinationPortRanges	The destination port ranges.	string[]
direction	The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.	'Inbound' 'Outbound' (required)
priority	The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.	int
protocol	Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.	'*' 'Tcp' 'Udp' (required)
provisioningState	The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
sourceAddressPrefix	The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.	string
sourceAddressPrefixes	The CIDR or source IP ranges.	string[]
sourceApplicationSecurityGroups	The application security group specified as source.	ApplicationSecurityGroup[]
sourcePortRange	The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
sourcePortRanges	The source port ranges.	string[]

ServiceEndpointPropertiesFormat

Name	Description	Value
locations	A list of locations.	string[]
provisioningState	The provisioning state of the resource.	string
service	The type of the endpoint service.	string

SubnetPropertiesFormat

Name	Description	Value
addressPrefix	The address prefix for the subnet.	string
networkSecurityGroup	The reference of the NetworkSecurityGroup resource.	NetworkSecurityGroup
provisioningState	The provisioning state of the resource.	string
resourceNavigationLinks	Gets an array of references to the external resources using subnet.	ResourceNavigationLink[]
routeTable	The reference of the RouteTable resource.	RouteTable
serviceEndpoints	An array of service endpoints.	ServiceEndpointPropertiesFormat[]

Share via

Microsoft.Network virtualNetworks/subnets 2018-04-01

Remarks

Bicep resource definition

Resource format

Property values

ApplicationSecurityGroup

ApplicationSecurityGroupPropertiesFormat

Microsoft.Network/virtualNetworks/subnets

NetworkSecurityGroup

NetworkSecurityGroupPropertiesFormat

ResourceNavigationLink

ResourceNavigationLinkFormat

ResourceTags

ResourceTags

ResourceTags

Route

RoutePropertiesFormat

RouteTable

RouteTablePropertiesFormat

SecurityRule

SecurityRulePropertiesFormat

ServiceEndpointPropertiesFormat

SubnetPropertiesFormat

Quickstart samples

ARM template resource definition

Resource format

Property values

ApplicationSecurityGroup

ApplicationSecurityGroupPropertiesFormat

Microsoft.Network/virtualNetworks/subnets

NetworkSecurityGroup

NetworkSecurityGroupPropertiesFormat

ResourceNavigationLink

ResourceNavigationLinkFormat

ResourceTags

ResourceTags

ResourceTags

Route

RoutePropertiesFormat

RouteTable

RouteTablePropertiesFormat

SecurityRule

SecurityRulePropertiesFormat

ServiceEndpointPropertiesFormat

SubnetPropertiesFormat

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

ApplicationSecurityGroup

ApplicationSecurityGroupPropertiesFormat

Microsoft.Network/virtualNetworks/subnets

NetworkSecurityGroup

NetworkSecurityGroupPropertiesFormat

ResourceNavigationLink

ResourceNavigationLinkFormat

ResourceTags

ResourceTags

ResourceTags

Route

RoutePropertiesFormat

RouteTable

RouteTablePropertiesFormat

SecurityRule

SecurityRulePropertiesFormat

ServiceEndpointPropertiesFormat

SubnetPropertiesFormat

Feedback

Additional resources