Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2024-11-01-preview
- 2024-08-08-preview
- 2024-04-08-preview
- 2024-04-03
- 2024-03-06-preview
- 2024-01-16-preview
- 2023-11-01-preview
- 2023-10-04-preview
- 2023-09-05
- 2022-10-14-preview
- 2022-09-09
- 2022-04-01-preview
- 2022-02-10-preview
- 2021-09-03-preview
- 2021-07-12
- 2021-04-01-preview
- 2021-03-09-preview
- 2021-02-01-preview
- 2021-01-14-preview
- 2020-11-10-preview
- 2020-11-02-preview
- 2020-10-19-preview
- 2020-09-21-preview
- 2019-12-10-preview
- 2019-09-24-preview
- 2019-01-23-preview
Bicep resource definition
The applicationGroups 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.DesktopVirtualization/applicationGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DesktopVirtualization/applicationGroups@2023-09-05' = {
identity: {
type: 'SystemAssigned'
}
kind: 'string'
location: 'string'
managedBy: 'string'
name: 'string'
plan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
version: 'string'
}
properties: {
applicationGroupType: 'string'
description: 'string'
friendlyName: 'string'
hostPoolArmPath: 'string'
showInFeed: bool
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
ApplicationGroupProperties
| Name | Description | Value |
|---|---|---|
| applicationGroupType | Resource Type of ApplicationGroup. | 'Desktop' 'RemoteApp' (required) |
| description | Description of ApplicationGroup. | string |
| friendlyName | Friendly name of ApplicationGroup. | string |
| hostPoolArmPath | HostPool arm path of ApplicationGroup. | string (required) |
| showInFeed | Boolean representing whether the applicationGroup is show in the feed. | bool |
Microsoft.DesktopVirtualization/applicationGroups
| Name | Description | Value |
|---|---|---|
| identity | ResourceModelWithAllowedPropertySetIdentity | |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| location | The geo-location where the resource lives | string |
| managedBy | The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| plan | ResourceModelWithAllowedPropertySetPlan | |
| properties | Detailed properties for ApplicationGroup | ApplicationGroupProperties (required) |
| sku | ResourceModelWithAllowedPropertySetSku | |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ResourceModelWithAllowedPropertySetIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
ResourceModelWithAllowedPropertySetPlan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
ResourceModelWithAllowedPropertySetSku
| Name | Description | Value |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | 'Basic' 'Free' 'Premium' 'Standard' |
ResourceModelWithAllowedPropertySetTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Virtual Desktop (AVD) Application Group | AVM Resource Module for Azure Virtual Desktop (AVD) Application Group |
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 applicationGroups 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.DesktopVirtualization/applicationGroups resource, add the following JSON to your template.
{
"type": "Microsoft.DesktopVirtualization/applicationGroups",
"apiVersion": "2023-09-05",
"name": "string",
"identity": {
"type": "SystemAssigned"
},
"kind": "string",
"location": "string",
"managedBy": "string",
"plan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string",
"version": "string"
},
"properties": {
"applicationGroupType": "string",
"description": "string",
"friendlyName": "string",
"hostPoolArmPath": "string",
"showInFeed": "bool"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
ApplicationGroupProperties
| Name | Description | Value |
|---|---|---|
| applicationGroupType | Resource Type of ApplicationGroup. | 'Desktop' 'RemoteApp' (required) |
| description | Description of ApplicationGroup. | string |
| friendlyName | Friendly name of ApplicationGroup. | string |
| hostPoolArmPath | HostPool arm path of ApplicationGroup. | string (required) |
| showInFeed | Boolean representing whether the applicationGroup is show in the feed. | bool |
Microsoft.DesktopVirtualization/applicationGroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-09-05' |
| identity | ResourceModelWithAllowedPropertySetIdentity | |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| location | The geo-location where the resource lives | string |
| managedBy | The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| plan | ResourceModelWithAllowedPropertySetPlan | |
| properties | Detailed properties for ApplicationGroup | ApplicationGroupProperties (required) |
| sku | ResourceModelWithAllowedPropertySetSku | |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DesktopVirtualization/applicationGroups' |
ResourceModelWithAllowedPropertySetIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
ResourceModelWithAllowedPropertySetPlan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
ResourceModelWithAllowedPropertySetSku
| Name | Description | Value |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | 'Basic' 'Free' 'Premium' 'Standard' |
ResourceModelWithAllowedPropertySetTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | 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 |
Terraform (AzAPI provider) resource definition
The applicationGroups 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/applicationGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DesktopVirtualization/applicationGroups@2023-09-05"
name = "string"
identity = {
type = "SystemAssigned"
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
managedBy = "string"
plan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
version = "string"
}
properties = {
applicationGroupType = "string"
description = "string"
friendlyName = "string"
hostPoolArmPath = "string"
showInFeed = bool
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
}
}
Property Values
ApplicationGroupProperties
| Name | Description | Value |
|---|---|---|
| applicationGroupType | Resource Type of ApplicationGroup. | 'Desktop' 'RemoteApp' (required) |
| description | Description of ApplicationGroup. | string |
| friendlyName | Friendly name of ApplicationGroup. | string |
| hostPoolArmPath | HostPool arm path of ApplicationGroup. | string (required) |
| showInFeed | Boolean representing whether the applicationGroup is show in the feed. | bool |
Microsoft.DesktopVirtualization/applicationGroups
| Name | Description | Value |
|---|---|---|
| identity | ResourceModelWithAllowedPropertySetIdentity | |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| location | The geo-location where the resource lives | string |
| managedBy | The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| plan | ResourceModelWithAllowedPropertySetPlan | |
| properties | Detailed properties for ApplicationGroup | ApplicationGroupProperties (required) |
| sku | ResourceModelWithAllowedPropertySetSku | |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DesktopVirtualization/applicationGroups@2023-09-05" |
ResourceModelWithAllowedPropertySetIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
ResourceModelWithAllowedPropertySetPlan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
ResourceModelWithAllowedPropertySetSku
| Name | Description | Value |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | 'Basic' 'Free' 'Premium' 'Standard' |
ResourceModelWithAllowedPropertySetTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Virtual Desktop (AVD) Application Group | AVM Resource Module for Azure Virtual Desktop (AVD) Application Group |