Applications - Create Or Update

Reference

Service:: Desktop Virtualization

API Version:: 2022-02-10-preview

Create or update an application.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}?api-version=2022-02-10-preview

URI Parameters

Name	In	Required	Type	Description
applicationGroupName	path	True	string	The name of the application group
applicationName	path	True	string	The name of the application within the specified 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.commandLineSetting	True	CommandLineSetting	Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.
properties.applicationType		RemoteApplicationType	Resource Type of Application.
properties.commandLineArguments		string	Command Line Arguments for Application.
properties.description		string	Description of Application.
properties.filePath		string	Specifies a path for the executable file for the application.
properties.friendlyName		string	Friendly name of Application.
properties.iconIndex		integer	Index of the icon.
properties.iconPath		string	Path to icon.
properties.msixPackageApplicationId		string	Specifies the package application Id for MSIX applications
properties.msixPackageFamilyName		string	Specifies the package family name for MSIX applications
properties.showInPortal		boolean	Specifies whether to show the RemoteApp program in the RD Web Access server.

Responses

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

Examples

Application_Create

PUT https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1?api-version=2022-02-10-preview

{
  "properties": {
    "description": "des1",
    "friendlyName": "friendly",
    "filePath": "path",
    "commandLineSetting": "Allow",
    "commandLineArguments": "arguments",
    "showInPortal": true,
    "iconPath": "icon",
    "iconIndex": 1
  }
}

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/Application_Create.json
func ExampleApplicationsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdesktopvirtualization.NewApplicationsClient("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",
		"application1",
		armdesktopvirtualization.Application{
			Properties: &armdesktopvirtualization.ApplicationProperties{
				Description:          to.Ptr("des1"),
				CommandLineArguments: to.Ptr("arguments"),
				CommandLineSetting:   to.Ptr(armdesktopvirtualization.CommandLineSettingAllow),
				FilePath:             to.Ptr("path"),
				FriendlyName:         to.Ptr("friendly"),
				IconIndex:            to.Ptr[int32](1),
				IconPath:             to.Ptr("icon"),
				ShowInPortal:         to.Ptr(true),
			},
		},
		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/application1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1",
  "type": "Microsoft.DesktopVirtualization/applicationGroups/applications",
  "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",
    "filePath": "path",
    "commandLineSetting": "Allow",
    "commandLineArguments": "arguments",
    "showInPortal": true,
    "iconPath": "icon",
    "iconIndex": 1,
    "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc",
    "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...",
    "applicationType": "InBuilt",
    "msixPackageFamilyName": null,
    "msixPackageApplicationId": null
  }
}

Status code:: 201

{
  "name": "applicationGroup1/application1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1",
  "type": "Microsoft.DesktopVirtualization/applicationGroups/applications",
  "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",
    "filePath": "path",
    "commandLineSetting": "Allow",
    "commandLineArguments": "arguments",
    "showInPortal": true,
    "iconPath": "icon",
    "iconIndex": 1,
    "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc",
    "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...",
    "applicationType": "InBuilt",
    "msixPackageFamilyName": null,
    "msixPackageApplicationId": null
  }
}

Definitions

Name	Description
Application	Schema for Application properties.
CloudError	Cloud error object.
CloudErrorProperties	Cloud error object properties.
CommandLineSetting	Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.
createdByType	The type of identity that created the resource.
RemoteApplicationType	Resource Type of Application.
systemData	Metadata pertaining to creation and last modification of the resource.

Application

Schema for Application properties.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.applicationType	RemoteApplicationType	Resource Type of Application.
properties.commandLineArguments	string	Command Line Arguments for Application.
properties.commandLineSetting	CommandLineSetting	Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.
properties.description	string	Description of Application.
properties.filePath	string	Specifies a path for the executable file for the application.
properties.friendlyName	string	Friendly name of Application.
properties.iconContent	string	the icon a 64 bit string as a byte array.
properties.iconHash	string	Hash of the icon.
properties.iconIndex	integer	Index of the icon.
properties.iconPath	string	Path to icon.
properties.msixPackageApplicationId	string	Specifies the package application Id for MSIX applications
properties.msixPackageFamilyName	string	Specifies the package family name for MSIX applications
properties.objectId	string	ObjectId of Application. (internal use)
properties.showInPortal	boolean	Specifies whether to show the RemoteApp program in the RD Web Access server.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

CommandLineSetting

Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.

Name	Type	Description
Allow	string
DoNotAllow	string
Require	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

RemoteApplicationType

Resource Type of Application.

Name	Type	Description
InBuilt	string
MsixApplication	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.

Share via