Application Groups - Create Or Update

Create or update an applicationGroup.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}?api-version=2021-01-14-preview

URI Parameters

Name In Required Type Description
applicationGroupName
path True
  • string

The name of the application group

resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

Request Body

Name Required Type Description
properties.applicationGroupType True

Resource Type of ApplicationGroup.

properties.hostPoolArmPath True
  • string

HostPool arm path of ApplicationGroup.

identity
kind
  • string

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.

location
  • string

The geo-location where the resource lives

managedBy
  • string

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.

plan
properties.description
  • string

Description of ApplicationGroup.

properties.friendlyName
  • string

Friendly name of ApplicationGroup.

properties.migrationRequest

The registration info of HostPool.

sku
tags
  • object

Resource tags.

Responses

Name Type Description
200 OK

Successfully updated application group.

201 Created

Successfully created application group.

Other Status Codes

Automation error response describing why the operation failed.

Examples

ApplicationGroup_Create

Sample Request

PUT https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1?api-version=2021-01-14-preview
{
  "location": "centralus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "description": "des1",
    "friendlyName": "friendly",
    "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
    "applicationGroupType": "RemoteApp",
    "migrationRequest": {
      "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}",
      "operation": "Start"
    }
  }
}

Sample Response

{
  "name": "applicationGroup1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
  "type": "Microsoft.DesktopVirtualization/applicationGroups",
  "location": "centralus",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
    "description": "des1",
    "friendlyName": "friendly",
    "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
    "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
    "applicationGroupType": "RemoteApp",
    "cloudPcResource": false,
    "migrationRequest": {
      "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}",
      "operation": "Start"
    }
  }
}
{
  "name": "applicationGroup1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
  "type": "Microsoft.DesktopVirtualization/applicationGroups",
  "location": "centralus",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
    "description": "des1",
    "friendlyName": "friendly",
    "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
    "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
    "applicationGroupType": "RemoteApp",
    "cloudPcResource": false,
    "migrationRequest": {
      "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}",
      "operation": "Start"
    }
  }
}

Definitions

ApplicationGroup

Represents a ApplicationGroup definition.

ApplicationGroupType

Resource Type of ApplicationGroup.

CloudError
CloudErrorProperties
Identity
MigrationRequestProperties

Properties for arm migration.

Operation

The type of operation for migration.

Plan
ResourceIdentityType

The identity type.

Sku
SkuTier

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.

ApplicationGroup

Represents a ApplicationGroup definition.

Name Type Description
etag
  • string

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

id
  • string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity
kind
  • string

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.

location
  • string

The geo-location where the resource lives

managedBy
  • string

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.

name
  • string

The name of the resource

plan
properties.applicationGroupType

Resource Type of ApplicationGroup.

properties.cloudPcResource
  • boolean

Is cloud pc resource.

properties.description
  • string

Description of ApplicationGroup.

properties.friendlyName
  • string

Friendly name of ApplicationGroup.

properties.hostPoolArmPath
  • string

HostPool arm path of ApplicationGroup.

properties.migrationRequest

The registration info of HostPool.

properties.objectId
  • string

ObjectId of ApplicationGroup. (internal use)

properties.workspaceArmPath
  • string

Workspace arm path of ApplicationGroup.

sku
tags
  • object

Resource tags.

type
  • string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ApplicationGroupType

Resource Type of ApplicationGroup.

Name Type Description
Desktop
  • string
RemoteApp
  • string

CloudError

Name Type Description
error

CloudErrorProperties

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.

Identity

Name Type Description
principalId
  • string

The principal ID of resource identity.

tenantId
  • string

The tenant ID of resource.

type

The identity type.

MigrationRequestProperties

Properties for arm migration.

Name Type Description
migrationPath
  • string

The path to the legacy object to migrate.

operation

The type of operation for migration.

Operation

The type of operation for migration.

Name Type Description
Complete
  • string

Complete the migration.

Hide
  • string

Hide the hostpool.

Revoke
  • string

Revoke the migration.

Start
  • string

Start the migration.

Unhide
  • string

Unhide the hostpool.

Plan

Name Type Description
name
  • string

A user defined name of the 3rd Party Artifact that is being procured.

product
  • string

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.

promotionCode
  • string

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

publisher
  • string

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

version
  • string

The version of the desired product/artifact.

ResourceIdentityType

The identity type.

Name Type Description
SystemAssigned
  • string

Sku

Name Type Description
capacity
  • integer

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.

family
  • string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

name
  • string

The name of the SKU. Ex - P3. It is typically a letter+number code

size
  • string

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

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.

SkuTier

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.

Name Type Description
Basic
  • string
Free
  • string
Premium
  • string
Standard
  • string