Microsoft.DesktopVirtualization (preview:2024-08-08)

2025/03/10 • 3 new methods

MSIXPackages_CreateOrUpdate (new)
Description :  Create or update a MSIX package.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
msixPackageFullName:
{
Description: The version specific package full name of the MSIX package within specified hostpool ,
Required: True ,
}
string ,
msixPackage:
{
Description: Object containing MSIX Package definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: True ,
}
{
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of package dependency. ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: True ,
}
{
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of package dependency. ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: True ,
}
{
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of package dependency. ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MSIXPackages_Update (new)
Description :  Update an MSIX Package.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
msixPackageFullName:
{
Description: The version specific package full name of the MSIX package within specified hostpool ,
Required: True ,
}
string ,
msixPackage:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: False ,
}
{
isActive:
{
Description: Set a version of the package to be active across hostpool. ,
Required: False ,
}
boolean ,
isRegularRegistration:
{
Description: Set Registration mode. Regular or Delayed. ,
Required: False ,
}
boolean ,
displayName:
{
Description: Display name for MSIX Package. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: True ,
}
{
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of package dependency. ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MSIXPackages_Delete (new)
Description :  Remove an MSIX Package.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
msixPackageFullName:
{
Description: The version specific package full name of the MSIX package within specified hostpool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}