Share via

Microsoft.DesktopVirtualization workspaces 2020-11-02-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@2020-11-02-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    applicationGroupReferences: [
      'string'
    ]
    description: 'string'
    friendlyName: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DesktopVirtualization/workspaces

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 64 (required)
properties Detailed properties for Workspace WorkspaceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

TrackedResourceTags

Name Description Value

WorkspaceProperties

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

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Azure Virtual Desktop (AVD) Workspace AVM Resource Module for Azure Virtual Desktop (AVD) Workspace

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Creates AVD with Microsoft Entra ID Join This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, a test session host and its extensions with Microsoft Entra ID join

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": "2020-11-02-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "applicationGroupReferences": [ "string" ],
    "description": "string",
    "friendlyName": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DesktopVirtualization/workspaces

Name Description Value
apiVersion The api version '2020-11-02-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 64 (required)
properties Detailed properties for Workspace WorkspaceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DesktopVirtualization/workspaces'

TrackedResourceTags

Name Description Value

WorkspaceProperties

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

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Creates AVD with Microsoft Entra ID Join

Deploy to Azure		 This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, a test session host and its extensions with Microsoft Entra ID join

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@2020-11-02-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      applicationGroupReferences = [
        "string"
      ]
      description = "string"
      friendlyName = "string"
    }
  }
}

Property Values

Microsoft.DesktopVirtualization/workspaces

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 64 (required)
properties Detailed properties for Workspace WorkspaceProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DesktopVirtualization/workspaces@2020-11-02-preview"

TrackedResourceTags

Name Description Value

WorkspaceProperties

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

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Azure Virtual Desktop (AVD) Workspace AVM Resource Module for Azure Virtual Desktop (AVD) Workspace