Microsoft.DesktopVirtualization workspaces 2019-09-24-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.DesktopVirtualization/workspaces@2019-09-24-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    applicationGroupReferences: [
      'string'
    ]
    description: 'string'
    friendlyName: 'string'
  }
}

Property values

workspaces

Name Description Value
name The resource name string (required)

Character limit: 3-64

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with letter or number. End with letter, number, or underscore.
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Detailed properties for Workspace WorkspaceProperties

WorkspaceProperties

Name Description Value
applicationGroupReferences List of applicationGroup resource Ids. string[]
description Description of Workspace. string
friendlyName Friendly name of Workspace. string

ARM template resource definition

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

{
  "type": "Microsoft.DesktopVirtualization/workspaces",
  "apiVersion": "2019-09-24-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "applicationGroupReferences": [ "string" ],
    "description": "string",
    "friendlyName": "string"
  }
}

Property values

workspaces

Name Description Value
type The resource type 'Microsoft.DesktopVirtualization/workspaces'
apiVersion The resource api version '2019-09-24-preview'
name The resource name string (required)

Character limit: 3-64

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with letter or number. End with letter, number, or underscore.
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Detailed properties for Workspace WorkspaceProperties

WorkspaceProperties

Name Description Value
applicationGroupReferences List of applicationGroup resource Ids. string[]
description Description of Workspace. string
friendlyName Friendly name of Workspace. string

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/workspaces@2019-09-24-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      applicationGroupReferences = [
        "string"
      ]
      description = "string"
      friendlyName = "string"
    }
  })
}

Property values

workspaces

Name Description Value
type The resource type "Microsoft.DesktopVirtualization/workspaces@2019-09-24-preview"
name The resource name string (required)

Character limit: 3-64

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with letter or number. End with letter, number, or underscore.
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
properties Detailed properties for Workspace WorkspaceProperties

WorkspaceProperties

Name Description Value
applicationGroupReferences List of applicationGroup resource Ids. string[]
description Description of Workspace. string
friendlyName Friendly name of Workspace. string