Share via

Microsoft.DevTestLab labs/virtualnetworks 2015-05-21-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.DevTestLab/labs/virtualnetworks@2015-05-21-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    allowedSubnets: [
      {
        allowPublicIp: 'string'
        labSubnetName: 'string'
        resourceId: 'string'
      }
    ]
    description: 'string'
    externalProviderResourceId: 'string'
    provisioningState: 'string'
    subnetOverrides: [
      {
        labSubnetName: 'string'
        resourceId: 'string'
        useInVmCreationPermission: 'string'
        usePublicIpAddressPermission: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DevTestLab/labs/virtualnetworks

Name Description Value
location The location of the 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: labs
properties The properties of the resource. VirtualNetworkProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

Subnet

Name Description Value
allowPublicIp 'Allow'
'Default'
'Deny'
labSubnetName string
resourceId string

SubnetOverride

Name Description Value
labSubnetName The name given to the subnet within the lab. string
resourceId The resource identifier of the subnet. string
useInVmCreationPermission Indicates whether this subnet can be used during virtual machine creation. 'Allow'
'Default'
'Deny'
usePublicIpAddressPermission Indicates whether public IP addresses can be assigned to virtual machines on this subnet. 'Allow'
'Default'
'Deny'

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
provisioningState The provisioning status of the resource. string
subnetOverrides The subnet overrides of the virtual network. SubnetOverride[]

VirtualNetworkTags

Name Description Value

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
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:

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": "2015-05-21-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "allowedSubnets": [
      {
        "allowPublicIp": "string",
        "labSubnetName": "string",
        "resourceId": "string"
      }
    ],
    "description": "string",
    "externalProviderResourceId": "string",
    "provisioningState": "string",
    "subnetOverrides": [
      {
        "labSubnetName": "string",
        "resourceId": "string",
        "useInVmCreationPermission": "string",
        "usePublicIpAddressPermission": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DevTestLab/labs/virtualnetworks

Name Description Value
apiVersion The api version '2015-05-21-preview'
location The location of the resource. string
name The resource name string (required)
properties The properties of the resource. VirtualNetworkProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DevTestLab/labs/virtualnetworks'

Subnet

Name Description Value
allowPublicIp 'Allow'
'Default'
'Deny'
labSubnetName string
resourceId string

SubnetOverride

Name Description Value
labSubnetName The name given to the subnet within the lab. string
resourceId The resource identifier of the subnet. string
useInVmCreationPermission Indicates whether this subnet can be used during virtual machine creation. 'Allow'
'Default'
'Deny'
usePublicIpAddressPermission Indicates whether public IP addresses can be assigned to virtual machines on this subnet. 'Allow'
'Default'
'Deny'

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
provisioningState The provisioning status of the resource. string
subnetOverrides The subnet overrides of the virtual network. SubnetOverride[]

VirtualNetworkTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Creates a lab in Azure DevTest Labs with a claimed VM

Deploy to Azure		 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@2015-05-21-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allowedSubnets = [
        {
          allowPublicIp = "string"
          labSubnetName = "string"
          resourceId = "string"
        }
      ]
      description = "string"
      externalProviderResourceId = "string"
      provisioningState = "string"
      subnetOverrides = [
        {
          labSubnetName = "string"
          resourceId = "string"
          useInVmCreationPermission = "string"
          usePublicIpAddressPermission = "string"
        }
      ]
    }
  })
}

Property Values

Microsoft.DevTestLab/labs/virtualnetworks

Name Description Value
location The location of the 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: labs
properties The properties of the resource. VirtualNetworkProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DevTestLab/labs/virtualnetworks@2015-05-21-preview"

Subnet

Name Description Value
allowPublicIp 'Allow'
'Default'
'Deny'
labSubnetName string
resourceId string

SubnetOverride

Name Description Value
labSubnetName The name given to the subnet within the lab. string
resourceId The resource identifier of the subnet. string
useInVmCreationPermission Indicates whether this subnet can be used during virtual machine creation. 'Allow'
'Default'
'Deny'
usePublicIpAddressPermission Indicates whether public IP addresses can be assigned to virtual machines on this subnet. 'Allow'
'Default'
'Deny'

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
provisioningState The provisioning status of the resource. string
subnetOverrides The subnet overrides of the virtual network. SubnetOverride[]

VirtualNetworkTags

Name Description Value