Microsoft.DevTestLab labs/users/environments

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.DevTestLab/labs/users/environments@2018-09-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    armTemplateDisplayName: 'string'
    deploymentProperties: {
      armTemplateId: 'string'
      parameters: [
        {
          name: 'string'
          value: 'string'
        }
      ]
    }
  }
}

Property values

labs/users/environments

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: users
properties The properties of the resource. EnvironmentProperties (required)

EnvironmentProperties

Name Description Value
armTemplateDisplayName The display name of the Azure Resource Manager template that produced the environment. string
deploymentProperties The deployment properties of the environment. EnvironmentDeploymentProperties

EnvironmentDeploymentProperties

Name Description Value
armTemplateId The Azure Resource Manager template's identifier. string
parameters The parameters of the Azure Resource Manager template. ArmTemplateParameterProperties[]

ArmTemplateParameterProperties

Name Description Value
name The name of the template parameter. string
value The value of the template parameter. string

ARM template resource definition

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

{
  "type": "Microsoft.DevTestLab/labs/users/environments",
  "apiVersion": "2018-09-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "armTemplateDisplayName": "string",
    "deploymentProperties": {
      "armTemplateId": "string",
      "parameters": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  }
}

Property values

labs/users/environments

Name Description Value
type The resource type 'Microsoft.DevTestLab/labs/users/environments'
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. EnvironmentProperties (required)

EnvironmentProperties

Name Description Value
armTemplateDisplayName The display name of the Azure Resource Manager template that produced the environment. string
deploymentProperties The deployment properties of the environment. EnvironmentDeploymentProperties

EnvironmentDeploymentProperties

Name Description Value
armTemplateId The Azure Resource Manager template's identifier. string
parameters The parameters of the Azure Resource Manager template. ArmTemplateParameterProperties[]

ArmTemplateParameterProperties

Name Description Value
name The name of the template parameter. string
value The value of the template parameter. string

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/users/environments@2018-09-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      armTemplateDisplayName = "string"
      deploymentProperties = {
        armTemplateId = "string"
        parameters = [
          {
            name = "string"
            value = "string"
          }
        ]
      }
    }
  })
}

Property values

labs/users/environments

Name Description Value
type The resource type "Microsoft.DevTestLab/labs/users/environments@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: users
tags The tags of the resource. Dictionary of tag names and values.
properties The properties of the resource. EnvironmentProperties (required)

EnvironmentProperties

Name Description Value
armTemplateDisplayName The display name of the Azure Resource Manager template that produced the environment. string
deploymentProperties The deployment properties of the environment. EnvironmentDeploymentProperties

EnvironmentDeploymentProperties

Name Description Value
armTemplateId The Azure Resource Manager template's identifier. string
parameters The parameters of the Azure Resource Manager template. ArmTemplateParameterProperties[]

ArmTemplateParameterProperties

Name Description Value
name The name of the template parameter. string
value The value of the template parameter. string