Microsoft.DevTestLab labs/virtualnetworks

Article
08/11/2023

Bicep resource definition

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

resource symbolicname 'Microsoft.DevTestLab/labs/virtualnetworks@2018-09-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    allowedSubnets: [
      {
        allowPublicIp: 'string'
        labSubnetName: 'string'
        resourceId: 'string'
      }
    ]
    description: 'string'
    externalProviderResourceId: 'string'
    subnetOverrides: [
      {
        labSubnetName: 'string'
        resourceId: 'string'
        sharedPublicIpAddressConfiguration: {
          allowedPorts: [
            {
              backendPort: int
              transportProtocol: 'string'
            }
          ]
        }
        useInVmCreationPermission: 'string'
        usePublicIpAddressPermission: 'string'
        virtualNetworkPoolName: 'string'
      }
    ]
  }
}

Property values

labs/virtualnetworks

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
location	The location of the resource.	string
tags	The tags of the resource.	Dictionary of tag names and values. See Tags in templates
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: labs
properties	The properties of the resource.	VirtualNetworkProperties

VirtualNetworkProperties

Name	Description	Value
allowedSubnets	The allowed subnets of the virtual network.	Subnet[]
description	The description of the virtual network.	string
externalProviderResourceId	The Microsoft.Network resource identifier of the virtual network.	string
subnetOverrides	The subnet overrides of the virtual network.	SubnetOverride[]

Subnet

Name	Description	Value
allowPublicIp	The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).	'Allow' 'Default' 'Deny'
labSubnetName	The name of the subnet as seen in the lab.	string
resourceId	The resource ID of the subnet.	string

SubnetOverride

Name	Description	Value
labSubnetName	The name given to the subnet within the lab.	string
resourceId	The resource ID of the subnet.	string
sharedPublicIpAddressConfiguration	Properties that virtual machines on this subnet will share.	SubnetSharedPublicIpAddressConfiguration
useInVmCreationPermission	Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).	'Allow' 'Default' 'Deny'
usePublicIpAddressPermission	Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).	'Allow' 'Default' 'Deny'
virtualNetworkPoolName	The virtual network pool associated with this subnet.	string

SubnetSharedPublicIpAddressConfiguration

Name	Description	Value
allowedPorts	Backend ports that virtual machines on this subnet are allowed to expose	Port[]

Port

Name	Description	Value
backendPort	Backend port of the target virtual machine.	int
transportProtocol	Protocol type of the port.	'Tcp' 'Udp'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Creates a lab in Azure DevTest Labs with a Windows Server VM	This template creates a new DevTest Lab / DTL instance with a Windows Server 2019 Datacenter VM in it. More Azure Resource Manager Quickstart Templates for Azure DevTest Labs available at https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates
Creates a lab in Azure DevTest Labs with a claimed VM	This template creates a new DevTest Lab / DTL instance with a claimed Windows Server 2019 Datacenter VM in it. More Azure Resource Manager Quickstart Templates for Azure DevTest Labs available at https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

ARM template resource definition

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

{
  "type": "Microsoft.DevTestLab/labs/virtualnetworks",
  "apiVersion": "2018-09-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "allowedSubnets": [
      {
        "allowPublicIp": "string",
        "labSubnetName": "string",
        "resourceId": "string"
      }
    ],
    "description": "string",
    "externalProviderResourceId": "string",
    "subnetOverrides": [
      {
        "labSubnetName": "string",
        "resourceId": "string",
        "sharedPublicIpAddressConfiguration": {
          "allowedPorts": [
            {
              "backendPort": "int",
              "transportProtocol": "string"
            }
          ]
        },
        "useInVmCreationPermission": "string",
        "usePublicIpAddressPermission": "string",
        "virtualNetworkPoolName": "string"
      }
    ]
  }
}

Property values

labs/virtualnetworks

Name	Description	Value
type	The resource type	'Microsoft.DevTestLab/labs/virtualnetworks'
apiVersion	The resource api version	'2018-09-15'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
location	The location of the resource.	string
tags	The tags of the resource.	Dictionary of tag names and values. See Tags in templates
properties	The properties of the resource.	VirtualNetworkProperties

VirtualNetworkProperties

Name	Description	Value
allowedSubnets	The allowed subnets of the virtual network.	Subnet[]
description	The description of the virtual network.	string
externalProviderResourceId	The Microsoft.Network resource identifier of the virtual network.	string
subnetOverrides	The subnet overrides of the virtual network.	SubnetOverride[]

Subnet

Name	Description	Value
allowPublicIp	The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).	'Allow' 'Default' 'Deny'
labSubnetName	The name of the subnet as seen in the lab.	string
resourceId	The resource ID of the subnet.	string

SubnetOverride

Name	Description	Value
labSubnetName	The name given to the subnet within the lab.	string
resourceId	The resource ID of the subnet.	string
sharedPublicIpAddressConfiguration	Properties that virtual machines on this subnet will share.	SubnetSharedPublicIpAddressConfiguration
useInVmCreationPermission	Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).	'Allow' 'Default' 'Deny'
usePublicIpAddressPermission	Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).	'Allow' 'Default' 'Deny'
virtualNetworkPoolName	The virtual network pool associated with this subnet.	string

SubnetSharedPublicIpAddressConfiguration

Name	Description	Value
allowedPorts	Backend ports that virtual machines on this subnet are allowed to expose	Port[]

Port

Name	Description	Value
backendPort	Backend port of the target virtual machine.	int
transportProtocol	Protocol type of the port.	'Tcp' 'Udp'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Creates a lab in Azure DevTest Labs with a Windows Server VM	This template creates a new DevTest Lab / DTL instance with a Windows Server 2019 Datacenter VM in it. More Azure Resource Manager Quickstart Templates for Azure DevTest Labs available at https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates
Creates a lab in Azure DevTest Labs with a claimed VM	This template creates a new DevTest Lab / DTL instance with a claimed Windows Server 2019 Datacenter VM in it. More Azure Resource Manager Quickstart Templates for Azure DevTest Labs available at https://github.com/Azure/azure-devtestlab/tree/master/ARMTemplates

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/virtualnetworks@2018-09-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allowedSubnets = [
        {
          allowPublicIp = "string"
          labSubnetName = "string"
          resourceId = "string"
        }
      ]
      description = "string"
      externalProviderResourceId = "string"
      subnetOverrides = [
        {
          labSubnetName = "string"
          resourceId = "string"
          sharedPublicIpAddressConfiguration = {
            allowedPorts = [
              {
                backendPort = int
                transportProtocol = "string"
              }
            ]
          }
          useInVmCreationPermission = "string"
          usePublicIpAddressPermission = "string"
          virtualNetworkPoolName = "string"
        }
      ]
    }
  })
}

Property values

labs/virtualnetworks

Name	Description	Value
type	The resource type	"Microsoft.DevTestLab/labs/virtualnetworks@2018-09-15"
name	The resource name	string (required)
location	The location of the resource.	string
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: labs
tags	The tags of the resource.	Dictionary of tag names and values.
properties	The properties of the resource.	VirtualNetworkProperties

VirtualNetworkProperties

Name	Description	Value
allowedSubnets	The allowed subnets of the virtual network.	Subnet[]
description	The description of the virtual network.	string
externalProviderResourceId	The Microsoft.Network resource identifier of the virtual network.	string
subnetOverrides	The subnet overrides of the virtual network.	SubnetOverride[]

Subnet

Name	Description	Value
allowPublicIp	The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).	"Allow" "Default" "Deny"
labSubnetName	The name of the subnet as seen in the lab.	string
resourceId	The resource ID of the subnet.	string

SubnetOverride

Name	Description	Value
labSubnetName	The name given to the subnet within the lab.	string
resourceId	The resource ID of the subnet.	string
sharedPublicIpAddressConfiguration	Properties that virtual machines on this subnet will share.	SubnetSharedPublicIpAddressConfiguration
useInVmCreationPermission	Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).	"Allow" "Default" "Deny"
usePublicIpAddressPermission	Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).	"Allow" "Default" "Deny"
virtualNetworkPoolName	The virtual network pool associated with this subnet.	string

SubnetSharedPublicIpAddressConfiguration

Name	Description	Value
allowedPorts	Backend ports that virtual machines on this subnet are allowed to expose	Port[]

Port

Name	Description	Value
backendPort	Backend port of the target virtual machine.	int
transportProtocol	Protocol type of the port.	"Tcp" "Udp"

Share via

Microsoft.DevTestLab labs/virtualnetworks

Bicep resource definition

Resource format

Property values

labs/virtualnetworks

VirtualNetworkProperties

Subnet

SubnetOverride

SubnetSharedPublicIpAddressConfiguration

Port

Quickstart templates

ARM template resource definition

Resource format

Property values

labs/virtualnetworks

VirtualNetworkProperties

Subnet

SubnetOverride

SubnetSharedPublicIpAddressConfiguration

Port

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

labs/virtualnetworks

VirtualNetworkProperties

Subnet

SubnetOverride

SubnetSharedPublicIpAddressConfiguration

Port

Feedback

Additional resources