Microsoft.LabServices labaccounts/labs/environmentsettings

ARM template resource definition

The labaccounts/labs/environmentsettings resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.LabServices/labaccounts/labs/environmentsettings resource, add the following JSON to your template.

{
  "type": "Microsoft.LabServices/labaccounts/labs/environmentsettings",
  "apiVersion": "2018-10-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "configurationState": "string",
    "description": "string",
    "provisioningState": "string",
    "resourceSettings": {
      "galleryImageResourceId": "string",
      "referenceVm": {
        "password": "string",
        "userName": "string"
      },
      "size": "string"
    },
    "title": "string",
    "uniqueIdentifier": "string"
  }
}

Property values

labaccounts/labs/environmentsettings

Name Description Value
type The resource type 'Microsoft.LabServices/labaccounts/labs/environmentsettings'
apiVersion The resource api version '2018-10-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 Environment Setting resource EnvironmentSettingProperties

EnvironmentSettingProperties

Name Description Value
configurationState Describes the user's progress in configuring their environment setting 'Completed'
'NotApplicable'
description Describes the environment and its resource settings string
provisioningState The provisioning status of the resource. string
resourceSettings The resource specific settings ResourceSettings (required)
title Brief title describing the environment and its resource settings string
uniqueIdentifier The unique immutable identifier of a resource (Guid). string

ResourceSettings

Name Description Value
galleryImageResourceId The resource id of the gallery image used for creating the virtual machine string
referenceVm Details specific to Reference Vm ReferenceVm (required)
size The size of the virtual machine 'Basic'
'Performance'
'Standard'

ReferenceVm

Name Description Value
password The password of the virtual machine. This will be set to null in GET resource API string
userName The username of the virtual machine string (required)