Microsoft.DevTestLab labs/users/environments

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' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    armTemplateDisplayName: 'string'
    deploymentProperties: {
      armTemplateId: 'string'
      parameters: [
        {
          name: 'string'
          value: 'string'
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DevTestLab/labs/users/environments

Name Description Value
location The geo-location where the resource lives 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/users
properties The properties of the environment. EnvironmentProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

ArmTemplateParameterProperties

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

DtlEnvironmentTags

Name Description Value

EnvironmentDeploymentProperties

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

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

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",
  "properties": {
    "armTemplateDisplayName": "string",
    "deploymentProperties": {
      "armTemplateId": "string",
      "parameters": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DevTestLab/labs/users/environments

Name Description Value
apiVersion The api version '2018-09-15'
location The geo-location where the resource lives string
name The resource name string (required)
properties The properties of the environment. EnvironmentProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DevTestLab/labs/users/environments'

ArmTemplateParameterProperties

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

DtlEnvironmentTags

Name Description Value

EnvironmentDeploymentProperties

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

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

Usage Examples

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"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      armTemplateDisplayName = "string"
      deploymentProperties = {
        armTemplateId = "string"
        parameters = [
          {
            name = "string"
            value = "string"
          }
        ]
      }
    }
  }
}

Property Values

Microsoft.DevTestLab/labs/users/environments

Name Description Value
location The geo-location where the resource lives 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/users
properties The properties of the environment. EnvironmentProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DevTestLab/labs/users/environments@2018-09-15"

ArmTemplateParameterProperties

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

DtlEnvironmentTags

Name Description Value

EnvironmentDeploymentProperties

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

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
  • Last updated on