Msix Images - Expand

Reference

Service:: Desktop Virtualization

API Version:: 2022-02-10-preview

Expands and Lists MSIX packages in an Image, given the Image Path.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/expandMsixImage?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
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
uri	string	URI to Image

Responses

Name	Type	Description
200 OK	ExpandMsixImageList	Successfully retrieved MSIX packages in specified Image Path.
Other Status Codes	CloudError	Automation error response describing why the operation failed.

Examples

MsixImage_Expand

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

{
  "uri": "imagepath"
}

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/MsixImage_Expand_Post.json
func ExampleMsixImagesClient_NewExpandPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdesktopvirtualization.NewMsixImagesClient("daefabc0-95b4-48b3-b645-8a753a63c4fa", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewExpandPager("resourceGroup1",
		"hostpool1",
		armdesktopvirtualization.MSIXImageURI{
			URI: to.Ptr("imagepath"),
		},
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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

{
  "value": [
    {
      "name": "hostpool1/expandmsiximage",
      "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage",
      "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage",
      "properties": {
        "packageAlias": "msixpackagealias",
        "imagePath": "imagepath",
        "packageName": "MsixPackageName",
        "packageFamilyName": "MsixPackage_FamilyName",
        "packageFullName": "MsixPackage_FullName",
        "displayName": "displayname",
        "packageRelativePath": "packagerelativepath",
        "isRegularRegistration": false,
        "isActive": false,
        "packageDependencies": [],
        "version": "packageversion",
        "lastUpdated": "2008-09-22T14:01:54.9571247Z",
        "packageApplications": [
          {
            "appId": "AppId",
            "description": "PackageApplicationDescription",
            "appUserModelID": "AppUserModelId",
            "friendlyName": "FriendlyName",
            "iconImageName": "Iconimagename",
            "rawIcon": "RawIcon",
            "rawPng": "RawPng"
          }
        ]
      }
    },
    {
      "name": "hostpool1/expandmsiximage",
      "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage",
      "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage",
      "properties": {
        "packageAlias": "msixpackagealias2",
        "imagePath": "imagepath",
        "packageName": "MsixPackageName2",
        "packageFamilyName": "MsixPackage_FamilyName2",
        "packageFullName": "MsixPackage_FullName2",
        "displayName": "displayname2",
        "packageRelativePath": "packagerelativepath2",
        "isRegularRegistration": false,
        "isActive": false,
        "packageDependencies": [
          {
            "dependencyName": "MsixPackageDependency1",
            "publisher": "PublisherName1",
            "minVersion": "ver1"
          },
          {
            "dependencyName": "MsixPackageDependency2",
            "publisher": "PublisherName2",
            "minVersion": "ver2"
          }
        ],
        "version": "packageversion",
        "lastUpdated": "2008-09-22T14:01:54.9571247Z",
        "packageApplications": [
          {
            "appId": "AppId1",
            "description": "PackageApplicationDescription1",
            "appUserModelID": "AppUserModelId1",
            "friendlyName": "FriendlyName1",
            "iconImageName": "Iconimagename1",
            "rawIcon": "RawIcon1",
            "rawPng": "RawPng1"
          },
          {
            "appId": "AppId2",
            "description": "PackageApplicationDescription2",
            "appUserModelID": "AppUserModelId2",
            "friendlyName": "FriendlyName2",
            "iconImageName": "Iconimagename2",
            "rawIcon": "RawIcon2",
            "rawPng": "RawPng2"
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
CloudError	Cloud error object.
CloudErrorProperties	Cloud error object properties.
ExpandMsixImage	Represents the definition of contents retrieved after expanding the MSIX Image.
ExpandMsixImageList	ExpandMsixImageList
MSIXImageURI	Represents URI referring to MSIX Image
MsixPackageApplications	Schema for MSIX Package Application properties.
MsixPackageDependencies	Schema for MSIX Package Dependencies properties.

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.

ExpandMsixImage

Represents the definition of contents retrieved after expanding the MSIX Image.

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.packageAlias	string	Alias of MSIX Package.
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.packageFullName	string	Package Full Name from appxmanifest.xml.
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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ExpandMsixImageList

Name	Type	Description
nextLink	string	Link to the next page of results.
value	ExpandMsixImage[]	List of MSIX package properties from give MSIX Image.

MSIXImageURI

Represents URI referring to MSIX Image

Name	Type	Description
uri	string	URI to Image

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.

Share via