Application Groups - Create Or Update

Reference

Service:: Desktop Virtualization

API Version:: 2022-02-10-preview

Create or update an applicationGroup.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}?api-version=2022-02-10-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	ApplicationGroupType	Resource Type of ApplicationGroup.
properties.hostPoolArmPath	True	string	HostPool arm path of ApplicationGroup.
identity		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		Plan
properties.description		string	Description of ApplicationGroup.
properties.friendlyName		string	Friendly name of ApplicationGroup.
properties.migrationRequest		MigrationRequestProperties	The registration info of HostPool.
sku		Sku
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	ApplicationGroup	Successfully updated application group.
201 Created	ApplicationGroup	Successfully created application group.
Other Status Codes	CloudError	Automation error response describing why the operation failed.

Examples

ApplicationGroup_Create

PUT https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1?api-version=2022-02-10-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"
    }
  }
}

package armdesktopvirtualization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/desktopvirtualization/armdesktopvirtualization/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2022-02-10-preview/examples/ApplicationGroup_Create.json
func ExampleApplicationGroupsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdesktopvirtualization.NewApplicationGroupsClient("daefabc0-95b4-48b3-b645-8a753a63c4fa", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"resourceGroup1",
		"applicationGroup1",
		armdesktopvirtualization.ApplicationGroup{
			Location: to.Ptr("centralus"),
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
			Properties: &armdesktopvirtualization.ApplicationGroupProperties{
				Description:          to.Ptr("des1"),
				ApplicationGroupType: to.Ptr(armdesktopvirtualization.ApplicationGroupTypeRemoteApp),
				FriendlyName:         to.Ptr("friendly"),
				HostPoolArmPath:      to.Ptr("/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1"),
				MigrationRequest: &armdesktopvirtualization.MigrationRequestProperties{
					MigrationPath: to.Ptr("TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}"),
					Operation:     to.Ptr(armdesktopvirtualization.OperationStart),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "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"
    }
  }
}

Status code:: 201

{
  "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"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "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

Name	Description
ApplicationGroup	Represents a ApplicationGroup definition.
ApplicationGroupType	Resource Type of ApplicationGroup.
CloudError	Cloud error object.
CloudErrorProperties	Cloud error object properties.
createdByType	The type of identity that created the resource.
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.
systemData	Metadata pertaining to creation and last modification of the resource.

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	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	Plan
properties.applicationGroupType	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	MigrationRequestProperties	The registration info of HostPool.
properties.objectId	string	ObjectId of ApplicationGroup. (internal use)
properties.workspaceArmPath	string	Workspace arm path of ApplicationGroup.
sku	Sku
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
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

Cloud error object.

Name	Type	Description
error	CloudErrorProperties	Cloud error object properties.

CloudErrorProperties

Cloud error object properties.

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Identity

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	ResourceIdentityType	The identity type.

MigrationRequestProperties

Properties for arm migration.

Name	Type	Description
migrationPath	string	The path to the legacy object to migrate.
operation	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	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.

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

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.