Microsoft.LabServices labaccounts/labs/environmentsettings

• Latest
• 2018-10-15

Bicep resource definition

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

resource symbolicname 'Microsoft.LabServices/labaccounts/labs/environmentsettings@2018-10-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    configurationState: 'string'
    description: 'string'
    provisioningState: 'string'
    resourceSettings: {
      galleryImageResourceId: 'string'
      referenceVm: {
        password: 'string'
        userName: 'string'
      }
      size: 'string'
    }
    title: 'string'
    uniqueIdentifier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.LabServices/labaccounts/labs/environmentsettings

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: labaccounts/labs
properties	The properties of the Environment Setting resource	EnvironmentSettingProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

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

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)

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'

ResourceTags

Name	Description	Value

ARM template resource definition

The labaccounts/labs/environmentsettings 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.

Usage Examples

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",
  "properties": {
    "configurationState": "string",
    "description": "string",
    "provisioningState": "string",
    "resourceSettings": {
      "galleryImageResourceId": "string",
      "referenceVm": {
        "password": "string",
        "userName": "string"
      },
      "size": "string"
    },
    "title": "string",
    "uniqueIdentifier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.LabServices/labaccounts/labs/environmentsettings

Name	Description	Value
apiVersion	The api version	'2018-10-15'
location	The location of the resource.	string
name	The resource name	string (required)
properties	The properties of the Environment Setting resource	EnvironmentSettingProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.LabServices/labaccounts/labs/environmentsettings'

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

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)

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'

ResourceTags

Name	Description	Value

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.LabServices/labaccounts/labs/environmentsettings@2018-10-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      configurationState = "string"
      description = "string"
      provisioningState = "string"
      resourceSettings = {
        galleryImageResourceId = "string"
        referenceVm = {
          password = "string"
          userName = "string"
        }
        size = "string"
      }
      title = "string"
      uniqueIdentifier = "string"
    }
  }
}

Property Values

Microsoft.LabServices/labaccounts/labs/environmentsettings

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: labaccounts/labs
properties	The properties of the Environment Setting resource	EnvironmentSettingProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.LabServices/labaccounts/labs/environmentsettings@2018-10-15"

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

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)

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'

ResourceTags

Name	Description	Value