MSIX Packages - Update

Reference

Service:: Desktop Virtualization

API Version:: 2022-02-10-preview

Update an MSIX Package.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}?api-version=2022-02-10-preview

URI Parameters

Name	In	Required	Type	Description
hostPoolName	path	True	string	The name of the host pool within the specified resource group
msixPackageFullName	path	True	string	The version specific package full name of the MSIX package within specified hostpool
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	Type	Description
properties.displayName	string	Display name for MSIX Package.
properties.isActive	boolean	Set a version of the package to be active across hostpool.
properties.isRegularRegistration	boolean	Set Registration mode. Regular or Delayed.

Responses

Name	Type	Description
200 OK	MSIXPackage	Successfully updated MSIX Package.
Other Status Codes	CloudError	Automation error response describing why the operation failed.

Examples

MSIXPackage_Update

PATCH https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostpool1/msixPackages/msixpackagefullname?api-version=2022-02-10-preview

{
  "properties": {
    "displayName": "displayname",
    "isActive": true,
    "isRegularRegistration": false
  }
}

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/MsixPackage_Update.json
func ExampleMSIXPackagesClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdesktopvirtualization.NewMSIXPackagesClient("daefabc0-95b4-48b3-b645-8a753a63c4fa", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"resourceGroup1",
		"hostpool1",
		"msixpackagefullname",
		&armdesktopvirtualization.MSIXPackagesClientUpdateOptions{MsixPackage: &armdesktopvirtualization.MSIXPackagePatch{
			Properties: &armdesktopvirtualization.MSIXPackagePatchProperties{
				DisplayName:           to.Ptr("displayname"),
				IsActive:              to.Ptr(true),
				IsRegularRegistration: to.Ptr(false),
			},
		},
		})
	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": "hostpool1/MsixPackageFullName",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName",
  "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "imagePath": "imagepath",
    "packageName": "MsixPackage_Name",
    "packageFamilyName": "MsixPackage_FamilyName",
    "displayName": "dis",
    "packageRelativePath": "MsixPackage_RelativePackageRoot",
    "isRegularRegistration": false,
    "isActive": true,
    "packageDependencies": [
      {
        "dependencyName": "MsixPackage_Dependency_Name",
        "publisher": "MsixPackage_Dependency_Publisher",
        "minVersion": "packageDep_version"
      }
    ],
    "version": "version",
    "lastUpdated": "2008-09-22T14:01:54.9571247Z",
    "packageApplications": [
      {
        "appId": "Application_Id",
        "description": "desc",
        "appUserModelID": "Application_ModelID",
        "friendlyName": "fri",
        "iconImageName": "Apptile",
        "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo",
        "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo"
      }
    ]
  }
}

Definitions

Name	Description
CloudError	Cloud error object.
CloudErrorProperties	Cloud error object properties.
createdByType	The type of identity that created the resource.
MSIXPackage	Schema for MSIX Package properties.
MsixPackageApplications	Schema for MSIX Package Application properties.
MsixPackageDependencies	Schema for MSIX Package Dependencies properties.
MSIXPackagePatch	MSIX Package properties that can be patched.
systemData	Metadata pertaining to creation and last modification of the resource.

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

MSIXPackage

Schema for MSIX Package 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.displayName	string	User friendly Name to be displayed in the portal.
properties.imagePath	string	VHD/CIM image path on Network Share.
properties.isActive	boolean	Make this version of the package the active one across the hostpool.
properties.isRegularRegistration	boolean	Specifies how to register Package in feed.
properties.lastUpdated	string	Date Package was last updated, found in the appxmanifest.xml.
properties.packageApplications	MsixPackageApplications[]	List of package applications.
properties.packageDependencies	MsixPackageDependencies[]	List of package dependencies.
properties.packageFamilyName	string	Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.
properties.packageName	string	Package Name from appxmanifest.xml.
properties.packageRelativePath	string	Relative Path to the package inside the image.
properties.version	string	Package Version found in the appxmanifest.xml.
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"

MsixPackageApplications

Schema for MSIX Package Application properties.

Name	Type	Description
appId	string	Package Application Id, found in appxmanifest.xml.
appUserModelID	string	Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml.
description	string	Description of Package Application.
friendlyName	string	User friendly name.
iconImageName	string	User friendly name.
rawIcon	string	the icon a 64 bit string as a byte array.
rawPng	string	the icon a 64 bit string as a byte array.

MsixPackageDependencies

Schema for MSIX Package Dependencies properties.

Name	Type	Description
dependencyName	string	Name of package dependency.
minVersion	string	Dependency version required.
publisher	string	Name of dependency publisher.

MSIXPackagePatch

MSIX Package properties that can be patched.

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.displayName	string	Display name for MSIX Package.
properties.isActive	boolean	Set a version of the package to be active across hostpool.
properties.isRegularRegistration	boolean	Set Registration mode. Regular or Delayed.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.