Edit

Bagikan melalui

EnterpriseModernAppManagement CSP

  • Artikel

The EnterpriseModernAppManagement configuration service provider (CSP) is used for the provisioning and reporting of modern enterprise apps. For details about how to use this CSP to for reporting apps inventory, installation and removal of apps for users, provisioning apps to devices, and managing app licenses, see Enterprise app management.

Note

Windows Holographic only supports per-user configuration of the EnterpriseModernAppManagement CSP.

The following list shows the EnterpriseModernAppManagement configuration service provider nodes:

Device/AppInstallation

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation

Used to perform app installation.

This is a required node.

Description framework properties:

Property name Property value
Format node
Access Type Get

Device/AppInstallation/{PackageFamilyName}

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}

Package family name (PFN) of the app. There is one for each PFN on the device when reporting inventory. These items are rooted under their signing origin.

This is an optional node.

Note

XAP files use a product ID in place of PackageFamilyName. Here's an example of XAP product ID (including the braces), {12345678-9012-3456-7890-123456789012}.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get, Replace
Dynamic Node Naming UniqueName: Package family name (PFN) of the app.

Example:

Here's an example for uninstalling an app:

<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
        <!-- Uninstall app -->
        <delete>
           <CmdID>2</CmdID>
              <Item>
                 <Target>
                    <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/%7b12345678-9012-3456-7890-123456789012%7D</LocURI>
                 </Target>
              </Item>
        </delete>
     <Final/>
  </SyncBody>
</SyncML>

Device/AppInstallation/{PackageFamilyName}/HostedInstall

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/HostedInstall

Command to perform an install of an app package from a hosted location (this can be a local drive, a UNC, or https data source).

This is a required node. The following list shows the supported deployment options:

  • ForceApplicationShutdown
  • DevelopmentMode
  • InstallAllResources
  • ForceTargetApplicationShutdown
  • ForceUpdateToAnyVersion
  • DeferRegistration="1". If the app is in use at the time of installation. This option stages the files for an app update and completes the registration of the app update after the app closes. Available in the latest insider flight of 20H1.
  • StageOnly="1". Stages the files for an app installation or update without installing the app. Available in 1803.
  • LicenseUri="\server\license.lic". Deploys an offline license. Available in 1607.
  • ValidateDependencies="1". This option is used at provisioning/staging time. If it's set to 1, deployment will perform the same dependency validation during staging that we would normally do at registration time, failing and rejecting the provision request if the dependencies aren't present. Available in the latest insider flight of 20H1.
  • ExcludeAppFromLayoutModification="1". Sets that the app will be provisioned on all devices and will be able to retain the apps provisioned without pinning them to start layout. Available in 1809.

Description framework properties:

Property name Property value
Format xml
Access Type Add, Delete, Exec, Get

Device/AppInstallation/{PackageFamilyName}/LastError

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/LastError

Last error relating to the app installation.

Note

This element isn't present after the app is installed.

Description framework properties:

Property name Property value
Format int
Access Type Get

Device/AppInstallation/{PackageFamilyName}/LastErrorDesc

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/LastErrorDesc

Description of last error relating to the app installation.

Note

This element isn't present after the app is installed.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get

Device/AppInstallation/{PackageFamilyName}/ProgressStatus

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/ProgressStatus

An integer that indicates the progress of the app installation. For https locations, this indicates the download progress. ProgressStatus isn't available for provisioning and it's only for user-based installations. In provisioning, the value is always 0 (zero).

Note

This element isn't present after the app is installed.

Description framework properties:

Property name Property value
Format int
Access Type Get

Device/AppInstallation/{PackageFamilyName}/Status

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/Status

Status of app installation. The following values are returned: NOT_INSTALLED (0) - The node was added, but the execution hasn't completed. INSTALLING (1) - Execution has started, but the deployment hasn't completed. If the deployment completes regardless of success, this value is updated. FAILED (2) - Installation failed. The details of the error can be found under LastError and LastErrorDescription. INSTALLED (3) - Once an install is successful this node is cleaned up, however in the event the clean up action hasn't completed, this state may briefly appear.

Note

This element isn't present after the app is installed.

Description framework properties:

Property name Property value
Format int
Access Type Get

Device/AppInstallation/{PackageFamilyName}/StoreInstall

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/StoreInstall

Command to perform an install of an app and a license from the Microsoft Store.

Description framework properties:

Property name Property value
Format xml
Access Type Add, Delete, Exec, Get

Device/AppLicenses

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses

Used to manage licenses for app scenarios.

Description framework properties:

Property name Property value
Format node
Access Type Get

Device/AppLicenses/StoreLicenses

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses

Used to manage licenses for store apps.

This is a required node.

Description framework properties:

Property name Property value
Format node
Access Type Get

Device/AppLicenses/StoreLicenses/{LicenseID}

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}

License ID for a store installed app. The license ID is generally the PFN of the app.

This is an optional node.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming UniqueName: License ID for a store installed app. The license ID is generally the PFN of the app.
Device/AppLicenses/StoreLicenses/{LicenseID}/AddLicense
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}/AddLicense

Command to add license.

This is a required node.

Description framework properties:

Property name Property value
Format xml
Access Type Exec
Device/AppLicenses/StoreLicenses/{LicenseID}/GetLicenseFromStore
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}/GetLicenseFromStore

Command to get license from the store.

This is a required node.

Description framework properties:

Property name Property value
Format xml
Access Type Exec
Device/AppLicenses/StoreLicenses/{LicenseID}/LicenseCategory
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}/LicenseCategory

Category of license that's used to classify various license sources. Valid value: Unknown - unknown license category. Retail - license sold through retail channels, typically from the Microsoft Store. Enterprise - license sold through the enterprise sales channel. OEM - license issued to an OEM. Developer - developer license, typically installed during the app development or side-loading scenarios.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppLicenses/StoreLicenses/{LicenseID}/LicenseUsage
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}/LicenseUsage

Indicates the allowed usage for the license. Valid values: Unknown - usage is unknown. Online - the license is only valid for online usage. This is for applications with concurrence requirements, such as an app used on several computers, but can only be used on one at any given time. Offline - license is valid for use offline. You don't need a connection to the internet to use this license. Enterprise Root - The license is valid for line of business apps.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppLicenses/StoreLicenses/{LicenseID}/RequesterID
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}/RequesterID

Identifier for the entity that requested the license, such as the client who acquired the license. For example, all licenses issued by the Store for Business for a particular enterprise client has the same RequesterID.

Note

The Microsoft Store for Business and Microsoft Store for Education are retired. For more information, see Microsoft Store for Business and Education retiring March 31, 2023.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get

Device/AppManagement

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement

Used for inventory and app management (post-install).

This is a required node.

Description framework properties:

Property name Property value
Format node
Access Type Get

Device/AppManagement/AppInventoryQuery

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppInventoryQuery

Specifies the query for app inventory.

This is a required node. Query parameters:

  • Output - Specifies the parameters for the information returned in AppInventoryResults operation. Multiple value must be separate by |. Valid values are:

    • PackagesName - returns the PackageFamilyName and PackageFullName of the app. Default if nothing is specified.
      • PackageDetails - returns all inventory attributes of the package. This information includes all information from PackageNames parameter, but doesn't validate RequiresReinstall.
      • RequiredReinstall - Validates the app status of the apps in the inventory query to determine if they require a reinstallation. This attribute may impact system performance depending on the number of apps installed. Requiring reinstall occurs when resource package updates or when the app is in a tampered state.

  • Source - specifies the app classification that aligns to the existing inventory nodes. You can use a specific filter or if no filter is specified then all sources will be returned. If no value is specified, all classifications are returned. Valid values are:

    • AppStore - This classification is for apps that were acquired from Microsoft Store. These were apps directly installed from Microsoft Store or enterprise apps from Microsoft Store for Business.

      Note

      The Microsoft Store for Business and Microsoft Store for Education are retired. For more information, see Microsoft Store for Business and Education retiring March 31, 2023.

    • nonStore - This classification is for apps that weren't acquired from the Microsoft Store.
    • System - Apps that are part of the OS. You can't uninstall these apps. This classification is read-only and can only be inventoried.

  • PackageTypeFilter - Specifies one or multiple types of packages you can use to query the user or device. Multiple values must be separated by |. Valid values are:

    • Main - returns the main installed package.
    • Bundle - returns installed bundle packages.
    • Framework - returns installed framework packages.
    • Resource - returns installed resources packages. Resources are either language, scale, or DirectX resources. They're parts of a bundle.
    • XAP - returns XAP package types. This filter is only supported on Windows Mobile.
    • All - returns all package types.

    If no value is specified, the combination of Main, Bundle, and Framework are returned.

  • PackageFamilyName - specifies the name of a particular package. If you specify this parameter, it returns the Package Family name if the package contains this value.

    If you don't specify this value, then all packages are returned.

  • Publisher - specifies the publisher of a particular package. If you specify this parameter, it returns the publisher if the value exists in the Publisher field.

    If you don't specify this value, then all publishers are returned.

Description framework properties:

Property name Property value
Format xml
Access Type Get, Replace

Example:

The following example sets the inventory query for the package names and checks the status for reinstallation for all main packages that are nonStore apps.

<Replace>
   <CmdID>10</CmdID>
   <Item>
      <Target>
         <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppInventoryQuery</LocURI>
      </Target>
      <Meta><Format xmlns="syncml:metinf">xml</Format></Meta>
      <Data><Inventory Output="PackageNames|RequiresReinstall" Source="nonStore" PackageTypeFilter="Main" /></Data>
   </Item>
</Replace>

Device/AppManagement/AppInventoryResults

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppInventoryResults

Returns the results for app inventory that was created after the AppInventoryQuery operation.

This is a required node.

Description framework properties:

Property name Property value
Format xml
Access Type Get

Example:

Here's an example of AppInventoryResults operation.

<Get>
   <CmdID>11</CmdID>
   <Item>
      <Target>
         <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppInventoryResults</LocURI>
      </Target>
   </Item>
</Get>

Device/AppManagement/AppStore

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore

This is a required node. Used for managing apps from the Microsoft Store.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get

Device/AppManagement/AppStore/{PackageFamilyName}

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}

Package family name (PFN) of the app. There is one for each PFN on the device when reporting inventory. These items are rooted under their signing origin.

Note

XAP files use a product ID in place of PackageFamilyName. Here's an example of XAP product ID (including the braces), {12345678-9012-3456-7890-123456789012}.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory

Example:

Here's an example for uninstalling an app:

<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
        <!-- Uninstall app -->
        <delete>
           <CmdID>2</CmdID>
              <Item>
                 <Target>
                    <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/%7b12345678-9012-3456-7890-123456789012%7D</LocURI>
                 </Target>
              </Item>
        </delete>
     <Final/>
  </SyncBody>
</SyncML>
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}

Full name of the package installed.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Architecture
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Architecture

Architecture of installed package. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/InstallDate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/InstallDate

Date the app was installed. Value type is string.

This is a required node.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/InstallLocation
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/InstallLocation

Install location of the app on the device. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsBundle
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsBundle

The value is 1 if the package is an app bundle and 0 (zero) for all other cases. Value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsFramework
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsFramework

Whether or not the app is a framework package. Value type is int. The value is 1 if the app is a framework package and 0 (zero) for all other cases.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsProvisioned
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsProvisioned

The value is 0 or 1 that indicates if the app is provisioned on the device. The value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsStub
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsStub

This node is used to identify whether the package is a stub package. A stub package is a version of the package with minimal functionality that will reduce the size of the app.

The value is 1 if the package is a stub package and 0 (zero) for all other cases.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Name
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Name

Name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/PackageStatus
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/PackageStatus

Provides information about the status of the package. Value type is int. Valid values are: OK (0) - The package is usable. LicenseIssue (1) - The license of the package isn't valid. Modified (2) - The package payload was modified by an unknown source. Tampered (4) - The package payload was tampered intentionally. Disabled (8) - The package isn't available for use. It can still be serviced.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Publisher
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Publisher

Publisher name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/RequiresReinstall
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/RequiresReinstall

Specifies whether the package state has changed and requires a reinstallation of the app. This can occur when new app resources are required, such as when a device has a change in language preference or a new DPI. It can also occur of the package was corrupted. If the value is 1, reinstallation of the app is performed.

This is a required node.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/ResourceID
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/ResourceID

Resource ID of the app. This is null for the main app, ~ for a bundle, and contains resource information for resources packages.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Users
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Users

Registered users of the app and the package install state. If the query is at the device level, it returns all the registered users of the device. If you query the user context, it will only return the current user.

This is a required node. Possible values:

  • 0 = Not Installed
  • 1 = Staged
  • 2 = Installed
  • 6 = Paused

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Version
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Version

Version of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/AppStore/{PackageFamilyName}/DoNotUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/DoNotUpdate

Specifies whether you want to block a specific app from being updated via auto-updates.

This is a required node.

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.
Device/AppManagement/AppStore/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate

Specify whether on a AMD64 device, across an app update, the architecture of the installed app mustn't change. For example if you have the x86 flavor of a Windows app installed, with this setting enabled, across an update, the x86 flavor will be installed even when x64 flavor is available.

Expected Behavior on an AMD64 machine that has x86 flavor of an app installed (Most restrictive wins).

Applicability Setting CSP state Result
True Not configured X86 flavor is picked
True Enabled X86 flavor is picked
True Disabled X86 flavor is picked
False (not set) Not configured X64 flavor is picked

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.
Device/AppManagement/AppStore/{PackageFamilyName}/NonRemovable
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1809 [10.0.17763] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/NonRemovable

This setting allows the IT admin to set an app to be nonremovable, or unable to be uninstalled by a user. This is useful in enterprise and education scenarios, where the IT admin might want to ensure that everyone always has certain apps and they won't be removed accidentally. This is also useful when there are multiple users per device, and you want to ensure that one user doesn't remove it for all users.

NonRemovable requires admin permission. This setting can only be defined per device, not per user. You can query the setting using AppInventoryQuery or AppInventoryResults.

Description framework properties:

Property name Property value
Format int
Access Type Add, Get, Replace

Allowed values:

Value Description
0 App isn't in the nonremovable app policy list.
1 App is included in the nonremovable app policy list.

Examples:

  • Add an app to the nonremovable app policy list

    <SyncML xmlns="SYNCML:SYNCML1.2">
    <SyncBody>
       <Add>
             <CmdID>1</CmdID>
             <Item>
                <Target>
                   <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable</LocURI>
                </Target>
                <Meta>
                   <Format xmlns="syncml:metinf">int</Format>
                </Meta>
                <Data>1</Data>
             </Item>
       </Add>
       <Final/>
       </SyncBody>
</SyncML>

  • Get the status for a particular app

    <SyncML xmlns="SYNCML:SYNCML1.2">
    <SyncBody>
       <Get>
             <CmdID>1</CmdID>
             <Item>
                <Target>
                   <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable</LocURI>
                </Target>
             </Item>
       </Get>
       <Final/>
      </SyncBody>
  </SyncML>

  • Replace an app in the nonremovable app policy list (Data 0 = app isn't in the app policy list; Data 1 = app is in the app policy list)

    <SyncML xmlns="SYNCML:SYNCML1.2">
    <SyncBody>
       <Replace>
             <CmdID>1</CmdID>
             <Item>
                <Target>
                   <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable</LocURI>
                </Target>
                <Meta>
                   <Format xmlns="syncml:metinf">int</Format>
                </Meta>
                <Data>0</Data>
             </Item>
       </Replace>
       <Final/>
    </SyncBody>
</SyncML>

Device/AppManagement/AppStore/ReleaseManagement

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement

Interior node for the managing updates through the Microsoft Store. These settings allow the IT admin to specify update channels for apps that they want their users to use for receiving updates. It allows the IT admin to assign a specific release to a smaller group for testing before the large deployment to the rest of the organization.

Note

ReleaseManagement settings only apply to updates through the Microsoft Store.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
Device/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}

Identifier for the app or set of apps. If there is only one app, it's the PackageFamilyName. If it's for a set of apps, it's the PackageFamilyName of the main app.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
Dynamic Node Naming UniqueName: If there is only one app, the name is the PackageFamilyName. If it is for a set of apps, the name is the PackageFamilyName of the main app.
Device/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/ChannelId

Specifies the app channel ID.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace
Device/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease

Interior node used to specify the effective app release to use when multiple user policies are set on the device. The device policy or last user policy is used.

Description framework properties:

Property name Property value
Format node
Access Type Get
Device/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId

Returns the last user channel ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId

Returns the last user release ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId

The IT admin can specify a release ID to indicate a specific release that they would like the user or device to be on.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace

Device/AppManagement/LastScanError

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/LastScanError

Reports the last error code returned by the update scan.

This is a required node.

Description framework properties:

Property name Property value
Format int
Access Type Get

Device/AppManagement/nonStore

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore

Used to manage enterprise apps or developer apps that weren't acquired from the Microsoft Store.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get

Device/AppManagement/nonStore/{PackageFamilyName}

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}

Package family name (PFN) of the app. There is one for each PFN on the device when reporting inventory. These items are rooted under their signing origin.

Note

XAP files use a product ID in place of PackageFamilyName. Here's an example of XAP product ID (including the braces), {12345678-9012-3456-7890-123456789012}.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory

Example:

Here's an example for uninstalling an app:

<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
        <!-- Uninstall app -->
        <delete>
           <CmdID>2</CmdID>
              <Item>
                 <Target>
                    <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/%7b12345678-9012-3456-7890-123456789012%7D</LocURI>
                 </Target>
              </Item>
        </delete>
     <Final/>
  </SyncBody>
</SyncML>
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}

Full name of the package installed.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Architecture
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Architecture

Architecture of installed package. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/InstallDate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/InstallDate

Date the app was installed. Value type is string.

This is a required node.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/InstallLocation
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/InstallLocation

Install location of the app on the device. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsBundle
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsBundle

The value is 1 if the package is an app bundle and 0 (zero) for all other cases. Value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsFramework
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsFramework

Whether or not the app is a framework package. Value type is int. The value is 1 if the app is a framework package and 0 (zero) for all other cases.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsProvisioned
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsProvisioned

The value is 0 or 1 that indicates if the app is provisioned on the device. The value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsStub
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsStub

This node is used to identify whether the package is a stub package. A stub package is a version of the package with minimal functionality that will reduce the size of the app.

The value is 1 if the package is a stub package and 0 (zero) for all other cases.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Name
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Name

Name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/PackageStatus
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/PackageStatus

Provides information about the status of the package. Value type is int. Valid values are: OK (0) - The package is usable. LicenseIssue (1) - The license of the package isn't valid. Modified (2) - The package payload was modified by an unknown source. Tampered (4) - The package payload was tampered intentionally. Disabled (8) - The package isn't available for use. It can still be serviced.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Publisher
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Publisher

Publisher name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/RequiresReinstall
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/RequiresReinstall

Specifies whether the package state has changed and requires a reinstallation of the app. This can occur when new app resources are required, such as when a device has a change in language preference or a new DPI. It can also occur of the package was corrupted. If the value is 1, reinstallation of the app is performed.

This is a required node.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/ResourceID
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/ResourceID

Resource ID of the app. This is null for the main app, ~ for a bundle, and contains resource information for resources packages.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Users
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Users

Registered users of the app and the package install state. If the query is at the device level, it returns all the registered users of the device. If you query the user context, it will only return the current user.

This is a required node. Possible values:

  • 0 = Not Installed
  • 1 = Staged
  • 2 = Installed
  • 6 = Paused

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Version
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Version

Version of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/nonStore/{PackageFamilyName}/DoNotUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/DoNotUpdate

Specifies whether you want to block a specific app from being updated via auto-updates.

This is a required node.

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.
Device/AppManagement/nonStore/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate

Specify whether on a AMD64 device, across an app update, the architecture of the installed app mustn't change. For example if you have the x86 flavor of a Windows app installed, with this setting enabled, across an update, the x86 flavor will be installed even when x64 flavor is available.

Expected Behavior on an AMD64 machine that has x86 flavor of an app installed (Most restrictive wins).

Applicability Setting CSP state Result
True Not configured X86 flavor is picked
True Enabled X86 flavor is picked
True Disabled X86 flavor is picked
False (not set) Not configured X64 flavor is picked

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.
Device/AppManagement/nonStore/{PackageFamilyName}/NonRemovable
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1809 [10.0.17763] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/NonRemovable

This setting allows the IT admin to set an app to be nonremovable, or unable to be uninstalled by a user. This is useful in enterprise and education scenarios, where the IT admin might want to ensure that everyone always has certain apps and they won't be removed accidentally. This is also useful when there are multiple users per device, and you want to ensure that one user doesn't remove it for all users.

NonRemovable requires admin permission. This setting can only be defined per device, not per user. You can query the setting using AppInventoryQuery or AppInventoryResults.

Description framework properties:

Property name Property value
Format int
Access Type Add, Get, Replace

Allowed values:

Value Description
0 App isn't in the nonremovable app policy list.
1 App is included in the nonremovable app policy list.

Examples:

  • Add an app to the nonremovable app policy list

    <SyncML xmlns="SYNCML:SYNCML1.2">
    <SyncBody>
       <Add>
             <CmdID>1</CmdID>
             <Item>
                <Target>
                   <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable</LocURI>
                </Target>
                <Meta>
                   <Format xmlns="syncml:metinf">int</Format>
                </Meta>
                <Data>1</Data>
             </Item>
       </Add>
       <Final/>
       </SyncBody>
</SyncML>

  • Get the status for a particular app

    <SyncML xmlns="SYNCML:SYNCML1.2">
    <SyncBody>
       <Get>
          <CmdID>1</CmdID>
          <Item>
                <Target>
                   <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable</LocURI>
                </Target>
          </Item>
       </Get>
       <Final/>
    </SyncBody>
</SyncML>

  • Replace an app in the nonremovable app policy list (Data 0 = app isn't in the app policy list; Data 1 = app is in the app policy list)

    <SyncML xmlns="SYNCML:SYNCML1.2">
    <SyncBody>
       <Replace>
             <CmdID>1</CmdID>
             <Item>
                <Target>
                   <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable</LocURI>
                </Target>
                <Meta>
                   <Format xmlns="syncml:metinf">int</Format>
                </Meta>
                <Data>0</Data>
             </Item>
       </Replace>
       <Final/>
    </SyncBody>
</SyncML>

Device/AppManagement/nonStore/ReleaseManagement

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement

Interior node for the managing updates through the Microsoft Store. These settings allow the IT admin to specify update channels for apps that they want their users to use for receiving updates. It allows the IT admin to assign a specific release to a smaller group for testing before the large deployment to the rest of the organization.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
Device/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}

Identifier for the app or set of apps. If there is only one app, it's the PackageFamilyName. If it's for a set of apps, it's the PackageFamilyName of the main app.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
Dynamic Node Naming UniqueName: If there is only one app, the name is the PackageFamilyName. If it is for a set of apps, the name is the PackageFamilyName of the main app.
Device/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/ChannelId

Specifies the app channel ID.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace
Device/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease

Interior node used to specify the effective app release to use when multiple user policies are set on the device. The device policy or last user policy is used.

Description framework properties:

Property name Property value
Format node
Access Type Get
Device/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId

Returns the last user channel ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId

Returns the last user release ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId

The IT admin can specify a release ID to indicate a specific release that they would like the user or device to be on.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace

Device/AppManagement/ResetPackage

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/ResetPackage

Used to restore the Windows app to its initial configuration.

Description framework properties:

Property name Property value
Format xml
Access Type Exec, Get

Device/AppManagement/System

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System

Reports apps installed as part of the operating system.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get

Device/AppManagement/System/{PackageFamilyName}

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}

Package family name (PFN) of the app. There is one for each PFN on the device when reporting inventory. These items are rooted under their signing origin.

Note

XAP files use a product ID in place of PackageFamilyName. Here's an example of XAP product ID (including the braces), {12345678-9012-3456-7890-123456789012}.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}

Full name of the package installed.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Architecture
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Architecture

Architecture of installed package. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/InstallDate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/InstallDate

Date the app was installed. Value type is string.

This is a required node.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/InstallLocation
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/InstallLocation

Install location of the app on the device. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsBundle
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsBundle

The value is 1 if the package is an app bundle and 0 (zero) for all other cases. Value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsFramework
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsFramework

Whether or not the app is a framework package. Value type is int. The value is 1 if the app is a framework package and 0 (zero) for all other cases.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsProvisioned
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsProvisioned

The value is 0 or 1 that indicates if the app is provisioned on the device. The value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsStub
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsStub

This node is used to identify whether the package is a stub package. A stub package is a version of the package with minimal functionality that will reduce the size of the app.

The value is 1 if the package is a stub package and 0 (zero) for all other cases.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Name
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Name

Name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/PackageStatus
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/PackageStatus

Provides information about the status of the package. Value type is int. Valid values are: OK (0) - The package is usable. LicenseIssue (1) - The license of the package isn't valid. Modified (2) - The package payload was modified by an unknown source. Tampered (4) - The package payload was tampered intentionally. Disabled (8) - The package isn't available for use. It can still be serviced.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Publisher
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Publisher

Publisher name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/RequiresReinstall
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/RequiresReinstall

Specifies whether the package state has changed and requires a reinstallation of the app. This can occur when new app resources are required, such as when a device has a change in language preference or a new DPI. It can also occur of the package was corrupted. If the value is 1, reinstallation of the app is performed.

This is a required node.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/ResourceID
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/ResourceID

Resource ID of the app. This is null for the main app, ~ for a bundle, and contains resource information for resources packages.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Users
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Users

Registered users of the app and the package install state. If the query is at the device level, it returns all the registered users of the device. If you query the user context, it will only return the current user.

This is a required node.

  • 0 = Not Installed
  • 1 = Staged
  • 2 = Installed
  • 6 = Paused

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Version
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Version

Version of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings

AppUpdateSettings nodes to support the auto-update and auto-repair feature for a specific package.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoRepair
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoRepair

AutoRepair node to support auto-repair feature for a specific package.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoRepair/PackageSource
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoRepair/PackageSource

PackageSource node that points the update location for a specific package.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get, Replace
Allowed Values Regular Expression: ^(([^;]+(?i)(\.appx|\.eappx|\.appxbundle|\.eappxbundle|\.msix|\.emsix|\.msixbundle|\.emsixbundle)([;]|$)){0,10}|([^;]+(?i)(\.appinstaller)([;]|$)){0,10})$
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings

AutoUpdateSettings nodes to support the auto-updates for a specific package.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/AutomaticBackgroundTask
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/AutomaticBackgroundTask

Specifies whether AutomaticBackgroundTask is enabled/disabled for a specific package.

Description framework properties:

Property name Property value
Format bool
Access Type Get, Replace
Default Value False

Allowed values:

Value Description
True AutomaticBackgroundTask is enabled for the package.
False (Default) AutomaticBackgroundTask is disabled for the package.
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/Disable
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/Disable

Specifies whether the auto-update settings is enabled/disabled for a specific package.

Description framework properties:

Property name Property value
Format bool
Access Type Get, Replace
Default Value False

Allowed values:

Value Description
True AutoUpdates settings is disabled for the package.
False (Default) AutoUpdates settings is enabled for the package.
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/ForceUpdateFromAnyVersion
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/ForceUpdateFromAnyVersion

Specifies whether the auto-update setting ForceUpdateFromAnyVersion is enabled/disabled for a specific package.

Description framework properties:

Property name Property value
Format bool
Access Type Get, Replace
Default Value False

Allowed values:

Value Description
True ForceUpdateFromAnyVersion is enabled for the package.
False (Default) ForceUpdateFromAnyVersion is disabled for the package.
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/HoursBetweenUpdateChecks
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/HoursBetweenUpdateChecks

Specifies HoursBetweenUpdateChecks for a specific package.

Description framework properties:

Property name Property value
Format int
Access Type Get, Replace
Allowed Values Range: [8-10000]
Default Value 8
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/OnLaunchUpdateCheck
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/OnLaunchUpdateCheck

Specifies whether OnLaunchUpdateCheck is enabled/disabled for a specific package.

Description framework properties:

Property name Property value
Format bool
Access Type Get, Replace
Default Value False

Allowed values:

Value Description
True OnLaunchUpdateCheck is enabled for the package.
False (Default) OnLaunchUpdateCheck is disabled for the package.
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/PackageSource
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/PackageSource

PackageSource node that points the update location for a specific package.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get, Replace
Allowed Values Regular Expression: ^(([^;]+(?i)(\.appinstaller)([;]|$)){1,11})$
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/ShowPrompt
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/ShowPrompt

Specifies whether the auto-update setting ShowPrompt is enabled/disabled for a specific package.

Description framework properties:

Property name Property value
Format bool
Access Type Get, Replace
Default Value False

Allowed values:

Value Description
True ShowPrompt is enabled for the package.
False (Default) ShowPrompt is disabled for the package.
Device/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/UpdateBlocksActivation
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppUpdateSettings/AutoUpdateSettings/UpdateBlocksActivation

Specifies whether the auto-update setting UpdateBlocksActivation is enabled/disabled for a specific package.

Description framework properties:

Property name Property value
Format bool
Access Type Get, Replace
Default Value False

Allowed values:

Value Description
True UpdateBlocksActivation is enabled for the package.
False (Default) UpdateBlocksActivation is disabled for the package.
Device/AppManagement/System/{PackageFamilyName}/DoNotUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/DoNotUpdate

Specifies whether you want to block a specific app from being updated via auto-updates.

This is a required node.

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.
Device/AppManagement/System/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate

Specify whether on a AMD64 device, across an app update, the architecture of the installed app mustn't change. For example if you have the x86 flavor of a Windows app installed, with this setting enabled, across an update, the x86 flavor will be installed even when x64 flavor is available.

Expected Behavior on an AMD64 machine that has x86 flavor of an app installed (Most restrictive wins).

Applicability Setting CSP state Result
True Not configured X86 flavor is picked
True Enabled X86 flavor is picked
True Disabled X86 flavor is picked
False (not set) Not configured X64 flavor is picked

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.
Device/AppManagement/System/{PackageFamilyName}/NonRemovable
Scope Editions Applicable OS
✅ Device
❌ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1809 [10.0.17763] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/NonRemovable

This setting allows the IT admin to set an app to be nonremovable, or unable to be uninstalled by a user. This is useful in enterprise and education scenarios, where the IT admin might want to ensure that everyone always has certain apps and they won't be removed accidentally. This is also useful when there are multiple users per device, and you want to ensure that one user doesn't remove it for all users.

NonRemovable requires admin permission. This setting can only be defined per device, not per user. You can query the setting using AppInventoryQuery or AppInventoryResults.

Description framework properties:

Property name Property value
Format int
Access Type Add, Get, Replace

Allowed values:

Value Description
0 App isn't in the nonremovable app policy list.
1 App is included in the nonremovable app policy list.

Examples:

  • Add an app to the nonremovable app policy list

    <SyncML xmlns="SYNCML:SYNCML1.2">
    <SyncBody>
       <Add>
             <CmdID>1</CmdID>
             <Item>
                <Target>
                   <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable</LocURI>
                </Target>
                <Meta>
                   <Format xmlns="syncml:metinf">int</Format>
                </Meta>
                <Data>1</Data>
             </Item>
       </Add>
       <Final/>
       </SyncBody>
</SyncML>

  • Get the status for a particular app

    <SyncML xmlns="SYNCML:SYNCML1.2">
    <SyncBody>
       <Get>
             <CmdID>1</CmdID>
             <Item>
                <Target>
                   <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable</LocURI>
                </Target>
             </Item>
       </Get>
       <Final/>
    </SyncBody>
</SyncML>

  • Replace an app in the nonremovable app policy list (Data 0 = app isn't in the app policy list; Data 1 = app is in the app policy list)

    <SyncML xmlns="SYNCML:SYNCML1.2">
    <SyncBody>
       <Replace>
             <CmdID>1</CmdID>
             <Item>
                <Target>
                   <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable</LocURI>
                </Target>
                <Meta>
                   <Format xmlns="syncml:metinf">int</Format>
                </Meta>
                <Data>0</Data>
             </Item>
       </Replace>
       <Final/>
    </SyncBody>
</SyncML>

Device/AppManagement/System/ReleaseManagement

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement

Interior node for the managing updates through the Microsoft Store. These settings allow the IT admin to specify update channels for apps that they want their users to use for receiving updates. It allows the IT admin to assign a specific release to a smaller group for testing before the large deployment to the rest of the organization.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
Device/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}

Identifier for the app or set of apps. If there is only one app, it's the PackageFamilyName. If it's for a set of apps, it's the PackageFamilyName of the main app.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
Dynamic Node Naming UniqueName: If there is only one app, the name is the PackageFamilyName. If it is for a set of apps, the name is the PackageFamilyName of the main app.
Device/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/ChannelId

Specifies the app channel ID.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace
Device/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease

Interior node used to specify the effective app release to use when multiple user policies are set on the device. The device policy or last user policy is used.

Description framework properties:

Property name Property value
Format node
Access Type Get
Device/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId

Returns the last user channel ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId

Returns the last user release ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
Device/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId

The IT admin can specify a release ID to indicate a specific release that they would like the user or device to be on.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace

Device/AppManagement/UpdateScan

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/UpdateScan

Used to start the Windows Update scan.

This is a required node.

Description framework properties:

Property name Property value
Format null
Access Type Exec

User/AppInstallation

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation

Used to perform app installation.

Description framework properties:

Property name Property value
Format node
Access Type Get

User/AppInstallation/{PackageFamilyName}

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}

Package family name (PFN) of the app. There is one for each PFN on the device when reporting inventory. These items are rooted under their signing origin.

Note

XAP files use a product ID in place of PackageFamilyName. Here's an example of XAP product ID (including the braces), {12345678-9012-3456-7890-123456789012}.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get, Replace
Dynamic Node Naming UniqueName: Package family name (PFN) of the app.

Example:

Here's an example for uninstalling an app:

<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
        <!-- Uninstall app -->
        <delete>
           <CmdID>2</CmdID>
              <Item>
                 <Target>
                    <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/%7b12345678-9012-3456-7890-123456789012%7D</LocURI>
                 </Target>
              </Item>
        </delete>
     <Final/>
  </SyncBody>
</SyncML>

User/AppInstallation/{PackageFamilyName}/HostedInstall

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/HostedInstall

Command to perform an install of an app package from a hosted location (this can be a local drive, a UNC, or https data source).

This is a required node. The following list shows the supported deployment options:

  • ForceApplicationShutdown
  • DevelopmentMode
  • InstallAllResources
  • ForceTargetApplicationShutdown
  • ForceUpdateToAnyVersion
  • DeferRegistration="1". If the app is in use at the time of installation. This option stages the files for an app update and completes the registration of the app update after the app closes. Available in the latest insider flight of 20H1.
  • StageOnly="1". Stages the files for an app installation or update without installing the app. Available in 1803.
  • LicenseUri="\server\license.lic". Deploys an offline license. Available in 1607.
  • ValidateDependencies="1". This option is used at provisioning/staging time. If it's set to 1, deployment will perform the same dependency validation during staging that we would normally do at registration time, failing and rejecting the provision request if the dependencies aren't present. Available in the latest insider flight of 20H1.
  • ExcludeAppFromLayoutModification="1". Sets that the app will be provisioned on all devices and will be able to retain the apps provisioned without pinning them to start layout. Available in 1809.

Description framework properties:

Property name Property value
Format xml
Access Type Add, Delete, Exec, Get

User/AppInstallation/{PackageFamilyName}/LastError

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/LastError

Last error relating to the app installation.

Note

This element isn't present after the app is installed.

Description framework properties:

Property name Property value
Format int
Access Type Get

User/AppInstallation/{PackageFamilyName}/LastErrorDesc

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/LastErrorDesc

Description of last error relating to the app installation.

Note

This element isn't present after the app is installed.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get

User/AppInstallation/{PackageFamilyName}/ProgressStatus

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/ProgressStatus

An integer that indicates the progress of the app installation. For https locations, this indicates the download progress. ProgressStatus isn't available for provisioning and it's only for user-based installations. In provisioning, the value is always 0 (zero).

Note

This element isn't present after the app is installed.

Description framework properties:

Property name Property value
Format int
Access Type Get

User/AppInstallation/{PackageFamilyName}/Status

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/Status

Status of app installation. The following values are returned: NOT_INSTALLED (0) - The node was added, but the execution hasn't completed. INSTALLING (1) - Execution has started, but the deployment hasn't completed. If the deployment completes regardless of success, this value is updated. FAILED (2) - Installation failed. The details of the error can be found under LastError and LastErrorDescription. INSTALLED (3) - Once an install is successful this node is cleaned up, however in the event the clean up action hasn't completed, this state may briefly appear.

Note

This element isn't present after the app is installed.

Description framework properties:

Property name Property value
Format int
Access Type Get

User/AppInstallation/{PackageFamilyName}/StoreInstall

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppInstallation/{PackageFamilyName}/StoreInstall

Command to perform an install of an app and a license from the Microsoft Store.

Description framework properties:

Property name Property value
Format xml
Access Type Add, Delete, Exec, Get

User/AppLicenses

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses

Used to manage licenses for app scenarios.

Description framework properties:

Property name Property value
Format node
Access Type Get

User/AppLicenses/StoreLicenses

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses

Used to manage licenses for store apps.

Description framework properties:

Property name Property value
Format node
Access Type Get

User/AppLicenses/StoreLicenses/{LicenseID}

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}

License ID for a store installed app. The license ID is generally the PFN of the app.

This is an optional node.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming UniqueName: License ID for a store installed app. The license ID is generally the PFN of the app.
User/AppLicenses/StoreLicenses/{LicenseID}/AddLicense
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}/AddLicense

Command to add license.

This is a required node.

Description framework properties:

Property name Property value
Format xml
Access Type Exec
User/AppLicenses/StoreLicenses/{LicenseID}/GetLicenseFromStore
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}/GetLicenseFromStore

Command to get license from the store.

This is a required node.

Description framework properties:

Property name Property value
Format xml
Access Type Exec
User/AppLicenses/StoreLicenses/{LicenseID}/LicenseCategory
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}/LicenseCategory

Category of license that's used to classify various license sources. Valid value: Unknown - unknown license category. Retail - license sold through retail channels, typically from the Microsoft Store. Enterprise - license sold through the enterprise sales channel. OEM - license issued to an OEM. Developer - developer license, typically installed during the app development or side-loading scenarios.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppLicenses/StoreLicenses/{LicenseID}/LicenseUsage
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}/LicenseUsage

Indicates the allowed usage for the license. Valid values: Unknown - usage is unknown. Online - the license is only valid for online usage. This is for applications with concurrence requirements, such as an app used on several computers, but can only be used on one at any given time. Offline - license is valid for use offline. You don't need a connection to the internet to use this license. Enterprise Root - The license is valid for line of business apps.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppLicenses/StoreLicenses/{LicenseID}/RequesterID
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppLicenses/StoreLicenses/{LicenseID}/RequesterID

Identifier for the entity that requested the license, such as the client who acquired the license. For example, all licenses issued by the Store for Business for a particular enterprise client has the same RequesterID.

Note

The Microsoft Store for Business and Microsoft Store for Education are retired. For more information, see Microsoft Store for Business and Education retiring March 31, 2023.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get

User/AppManagement

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement

Used for inventory and app management (post-install).

Description framework properties:

Property name Property value
Format node
Access Type Get

User/AppManagement/AppInventoryQuery

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppInventoryQuery

Specifies the query for app inventory.

This is a required node. Query parameters:

  • Output - Specifies the parameters for the information returned in AppInventoryResults operation. Multiple value must be separate by |. Valid values are:

    • PackagesName - returns the PackageFamilyName and PackageFullName of the app. Default if nothing is specified.
    • PackageDetails - returns all inventory attributes of the package. This information includes all information from PackageNames parameter, but doesn't validate RequiresReinstall.
    • RequiredReinstall - Validates the app status of the apps in the inventory query to determine if they require a reinstallation. This attribute may impact system performance depending on the number of apps installed. Requiring reinstall occurs when resource package updates or when the app is in a tampered state.

  • Source - specifies the app classification that aligns to the existing inventory nodes. You can use a specific filter or if no filter is specified then all sources will be returned. If no value is specified, all classifications are returned. Valid values are:

    • AppStore - This classification is for apps that were acquired from Microsoft Store. These were apps directly installed from Microsoft Store or enterprise apps from Microsoft Store for Business.
    • nonStore - This classification is for apps that weren't acquired from the Microsoft Store.
    • System - Apps that are part of the OS. You can't uninstall these apps. This classification is read-only and can only be inventoried.

  • PackageTypeFilter - Specifies one or multiple types of packages you can use to query the user or device. Multiple values must be separated by |. Valid values are:

    • Main - returns the main installed package.
    • Bundle - returns installed bundle packages.
    • Framework - returns installed framework packages.
    • Resource - returns installed resources packages. Resources are either language, scale, or DirectX resources. They're parts of a bundle.
    • XAP - returns XAP package types. This filter is only supported on Windows Mobile.
    • All - returns all package types.

    If no value is specified, the combination of Main, Bundle, and Framework are returned.

  • PackageFamilyName - specifies the name of a particular package. If you specify this parameter, it returns the Package Family name if the package contains this value.

    If you don't specify this value, then all packages are returned.

  • Publisher - specifies the publisher of a particular package. If you specify this parameter, it returns the publisher if the value exists in the Publisher field.

    If you don't specify this value, then all publishers are returned.

Description framework properties:

Property name Property value
Format xml
Access Type Get, Replace

Example:

The following example sets the inventory query for the package names and checks the status for reinstallation for all main packages that are nonStore apps.

<Replace>
   <CmdID>10</CmdID>
   <Item>
      <Target>
         <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppInventoryQuery</LocURI>
      </Target>
      <Meta><Format xmlns="syncml:metinf">xml</Format></Meta>
      <Data><Inventory Output="PackageNames|RequiresReinstall" Source="nonStore" PackageTypeFilter="Main" /></Data>
   </Item>
</Replace>

User/AppManagement/AppInventoryResults

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppInventoryResults

Returns the results for app inventory that was created after the AppInventoryQuery operation.

This is a required node.

Description framework properties:

Property name Property value
Format xml
Access Type Get

Example:

Here's an example of AppInventoryResults operation.

<Get>
   <CmdID>11</CmdID>
   <Item>
      <Target>
         <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppInventoryResults</LocURI>
      </Target>
   </Item>
</Get>

User/AppManagement/AppStore

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore

This is a required node. Used for managing apps from the Microsoft Store.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get

User/AppManagement/AppStore/{PackageFamilyName}

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}

Package family name (PFN) of the app. There is one for each PFN on the device when reporting inventory. These items are rooted under their signing origin.

Note

XAP files use a product ID in place of PackageFamilyName. Here's an example of XAP product ID (including the braces), {12345678-9012-3456-7890-123456789012}.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory

Example:

Here's an example for uninstalling an app:

<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
        <!-- Uninstall app -->
        <delete>
           <CmdID>2</CmdID>
              <Item>
                 <Target>
                    <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/%7b12345678-9012-3456-7890-123456789012%7D</LocURI>
                 </Target>
              </Item>
        </delete>
     <Final/>
  </SyncBody>
</SyncML>
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}

Full name of the package installed.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Architecture
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Architecture

Architecture of installed package. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/InstallDate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/InstallDate

Date the app was installed. Value type is string.

This is a required node.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/InstallLocation
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/InstallLocation

Install location of the app on the device. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsBundle
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsBundle

The value is 1 if the package is an app bundle and 0 (zero) for all other cases. Value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsFramework
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsFramework

Whether or not the app is a framework package. Value type is int. The value is 1 if the app is a framework package and 0 (zero) for all other cases.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsProvisioned
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsProvisioned

The value is 0 or 1 that indicates if the app is provisioned on the device. The value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsStub
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/IsStub

This node is used to identify whether the package is a stub package. A stub package is a version of the package with minimal functionality that will reduce the size of the app.

The value is 1 if the package is a stub package and 0 (zero) for all other cases.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Name
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Name

Name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/PackageStatus
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/PackageStatus

Provides information about the status of the package. Value type is int. Valid values are: OK (0) - The package is usable. LicenseIssue (1) - The license of the package isn't valid. Modified (2) - The package payload was modified by an unknown source. Tampered (4) - The package payload was tampered intentionally. Disabled (8) - The package isn't available for use. It can still be serviced.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Publisher
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Publisher

Publisher name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/RequiresReinstall
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/RequiresReinstall

Specifies whether the package state has changed and requires a reinstallation of the app. This can occur when new app resources are required, such as when a device has a change in language preference or a new DPI. It can also occur of the package was corrupted. If the value is 1, reinstallation of the app is performed.

This is a required node.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/ResourceID
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/ResourceID

Resource ID of the app. This is null for the main app, ~ for a bundle, and contains resource information for resources packages.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Users
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Users

Registered users of the app and the package install state. If the query is at the device level, it returns all the registered users of the device. If you query the user context, it will only return the current user.

This is a required node. Possible values:

  • 0 = Not Installed
  • 1 = Staged
  • 2 = Installed
  • 6 = Paused

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Version
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/{PackageFullName}/Version

Version of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/AppStore/{PackageFamilyName}/AppSettingPolicy
Scope Editions Applicable OS
❌ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/AppSettingPolicy

Interior node for all managed app setting values.

Note

This node is only supported in the user context.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get, Replace
User/AppManagement/AppStore/{PackageFamilyName}/AppSettingPolicy/{SettingValue}
Scope Editions Applicable OS
❌ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/AppSettingPolicy/{SettingValue}

The SettingValue and data represent a key value pair to be configured for the app. The node represents the name of the key and the data represents the value. You can find this value in LocalSettings in the Managed. App. Settings container.

This setting only works for apps that support the feature and it's only supported in the user context.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace
Dynamic Node Naming UniqueName: SettingValue represents a Key in a Key Value Pair. Values can be found in LocalSettings in the Managed.App.Settings container.

Examples:

  • The following example sets the value for the 'Server'

    <!— Configure app settings -->
<Add>
    <CmdID>0</CmdID>
    <Item>
       <Target>
          <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy/Server</LocURI>
       </Target>
       <Meta>
          <Format xmlns="syncml:metinf">chr</Format>
       </Meta>
       <Data>server1.contoso.com</Data>
    </Item>
</Add>

  • The following example gets all managed app settings for a specific app.

    <!—- Get app settings -->
<Get>
    <CmdID>0</CmdID>
    <Item>
       <Target>
          <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy?list=StructData</LocURI>
       </Target>
    </Item>
</Get>
User/AppManagement/AppStore/{PackageFamilyName}/DoNotUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/DoNotUpdate

Specifies whether you want to block a specific app from being updated via auto-updates.

This is a required node.

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.
User/AppManagement/AppStore/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate

Specify whether on a AMD64 device, across an app update, the architecture of the installed app mustn't change. For example if you have the x86 flavor of a Windows app installed, with this setting enabled, across an update, the x86 flavor will be installed even when x64 flavor is available.

Expected Behavior on an AMD64 machine that has x86 flavor of an app installed (Most restrictive wins).

Applicability Setting CSP state Result
True Not configured X86 flavor is picked
True Enabled X86 flavor is picked
True Disabled X86 flavor is picked
False (not set) Not configured X64 flavor is picked

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.

User/AppManagement/AppStore/ReleaseManagement

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement

Interior node for the managing updates through the Microsoft Store. These settings allow the IT admin to specify update channels for apps that they want their users to use for receiving updates. It allows the IT admin to assign a specific release to a smaller group for testing before the large deployment to the rest of the organization.

Note

ReleaseManagement settings only apply to updates through the Microsoft Store.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
User/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}

Identifier for the app or set of apps. If there is only one app, it's the PackageFamilyName. If it's for a set of apps, it's the PackageFamilyName of the main app.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
Dynamic Node Naming UniqueName: If there is only one app, the name is the PackageFamilyName. If it is for a set of apps, the name is the PackageFamilyName of the main app.
User/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/ChannelId

Specifies the app channel ID.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace
User/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease

Interior node used to specify the effective app release to use when multiple user policies are set on the device. The device policy or last user policy is used.

Description framework properties:

Property name Property value
Format node
Access Type Get
User/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId

Returns the last user channel ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId

Returns the last user release ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId

The IT admin can specify a release ID to indicate a specific release that they would like the user or device to be on.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace

User/AppManagement/LastScanError

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/LastScanError

Reports the last error code returned by the update scan.

This is a required node.

Description framework properties:

Property name Property value
Format int
Access Type Get

User/AppManagement/nonStore

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore

Used to manage enterprise apps or developer apps that weren't acquired from the Microsoft Store.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get

User/AppManagement/nonStore/{PackageFamilyName}

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}

Package family name (PFN) of the app. There is one for each PFN on the device when reporting inventory. These items are rooted under their signing origin.

Note

XAP files use a product ID in place of PackageFamilyName. Here's an example of XAP product ID (including the braces), {12345678-9012-3456-7890-123456789012}.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory 
<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
        <!-- Uninstall app -->
        <delete>
           <CmdID>2</CmdID>
              <Item>
                 <Target>
                    <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/%7b12345678-9012-3456-7890-123456789012%7D</LocURI>
                 </Target>
              </Item>
        </delete>
     <Final/>
  </SyncBody>
</SyncML>
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}

Full name of the package installed.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Architecture
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Architecture

Architecture of installed package. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/InstallDate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/InstallDate

Date the app was installed. Value type is string.

This is a required node.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/InstallLocation
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/InstallLocation

Install location of the app on the device. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsBundle
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsBundle

The value is 1 if the package is an app bundle and 0 (zero) for all other cases. Value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsFramework
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsFramework

Whether or not the app is a framework package. Value type is int. The value is 1 if the app is a framework package and 0 (zero) for all other cases.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsProvisioned
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsProvisioned

The value is 0 or 1 that indicates if the app is provisioned on the device. The value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsStub
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/IsStub

This node is used to identify whether the package is a stub package. A stub package is a version of the package with minimal functionality that will reduce the size of the app.

The value is 1 if the package is a stub package and 0 (zero) for all other cases.

Value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Name
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Name

Name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/PackageStatus
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/PackageStatus

Provides information about the status of the package. Value type is int. Valid values are: OK (0) - The package is usable. LicenseIssue (1) - The license of the package isn't valid. Modified (2) - The package payload was modified by an unknown source. Tampered (4) - The package payload was tampered intentionally. Disabled (8) - The package isn't available for use. It can still be serviced.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Publisher
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Publisher

Publisher name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/RequiresReinstall
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/RequiresReinstall

Specifies whether the package state has changed and requires a reinstallation of the app. This can occur when new app resources are required, such as when a device has a change in language preference or a new DPI. It can also occur of the package was corrupted. If the value is 1, reinstallation of the app is performed.

This is a required node.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/ResourceID
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/ResourceID

Resource ID of the app. This is null for the main app, ~ for a bundle, and contains resource information for resources packages.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Users
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Users

Registered users of the app and the package install state. If the query is at the device level, it returns all the registered users of the device. If you query the user context, it will only return the current user.

Requried.

  • Not Installed = 0
  • Staged = 1
  • Installed = 2
  • Paused = 6

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Version
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/{PackageFullName}/Version

Version of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/nonStore/{PackageFamilyName}/AppSettingPolicy
Scope Editions Applicable OS
❌ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/AppSettingPolicy

Interior node for all managed app setting values.

This node is only supported in the user context.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get, Replace
User/AppManagement/nonStore/{PackageFamilyName}/AppSettingPolicy/{SettingValue}
Scope Editions Applicable OS
❌ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/AppSettingPolicy/{SettingValue}

The SettingValue and data represent a key value pair to be configured for the app. The node represents the name of the key and the data represents the value. You can find this value in LocalSettings in the Managed. App. Settings container.

This setting only works for apps that support the feature and it's only supported in the user context.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace
Dynamic Node Naming UniqueName: SettingValue represents a Key in a Key Value Pair. Values can be found in LocalSettings in the Managed.App.Settings container.

The following example sets the value for the 'Server'

<!— Configure app settings -->
<Add>
   <CmdID>0</CmdID>
   <Item>
      <Target>
         <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy/Server</LocURI>
      </Target>
      <Meta>
         <Format xmlns="syncml:metinf">chr</Format>
      </Meta>
      <Data>server1.contoso.com</Data>
   </Item>
</Add>

The following example gets all managed app settings for a specific app.

<!—Get app settings -->
<Get>
   <CmdID>0</CmdID>
   <Item>
      <Target>
         <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy?list=StructData</LocURI>
      </Target>
   </Item>
</Get>
User/AppManagement/nonStore/{PackageFamilyName}/DoNotUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/DoNotUpdate

Specifies whether you want to block a specific app from being updated via auto-updates.

This is a required node.

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.
User/AppManagement/nonStore/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate

Specify whether on a AMD64 device, across an app update, the architecture of the installed app mustn't change. For example if you have the x86 flavor of a Windows app installed, with this setting enabled, across an update, the x86 flavor will be installed even when x64 flavor is available.

Expected Behavior on an AMD64 machine that has x86 flavor of an app installed (Most restrictive wins).

Applicability Setting CSP state Result
True Not configured X86 flavor is picked
True Enabled X86 flavor is picked
True Disabled X86 flavor is picked
False (not set) Not configured X64 flavor is picked

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.

User/AppManagement/nonStore/ReleaseManagement

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement

Interior node for the managing updates through the Microsoft Store. These settings allow the IT admin to specify update channels for apps that they want their users to use for receiving updates. It allows the IT admin to assign a specific release to a smaller group for testing before the large deployment to the rest of the organization.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
User/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}

Identifier for the app or set of apps. If there is only one app, it's the PackageFamilyName. If it's for a set of apps, it's the PackageFamilyName of the main app.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
Dynamic Node Naming UniqueName: If there is only one app, the name is the PackageFamilyName. If it is for a set of apps, the name is the PackageFamilyName of the main app.
User/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/ChannelId

Specifies the app channel ID.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace
User/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease

Interior node used to specify the effective app release to use when multiple user policies are set on the device. The device policy or last user policy is used.

Description framework properties:

Property name Property value
Format node
Access Type Get
User/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId

Returns the last user channel ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId

Returns the last user release ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId

The IT admin can specify a release ID to indicate a specific release that they would like the user or device to be on.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace

User/AppManagement/RemovePackage

Scope Editions Applicable OS
❌ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1703 [10.0.15063] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/RemovePackage

Used to remove packages.

Parameters:

  • Package
    • Name: Specifies the PackageFullName of the particular package to remove.
    • RemoveForAllUsers:
      • 0 (default) - Package will be un-provisioned so that new users don't receive the package. The package will remain installed for current users. This option isn't currently supported.
      • 1 - Package will be removed for all users only if it's a provisioned package.
  • User (optional): Specifies the SID of the particular user for whom to remove the package; only the package for the specified user can be removed.

Description framework properties:

Property name Property value
Format xml
Access Type Exec, Get

Example:

The following example removes a package for all users:

<Exec>
   <CmdID>10</CmdID>
   <Item>
      <Target>
         <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/RemovePackage</LocURI>
      </Target>
      <Meta><Format xmlns="syncml:metinf">xml</Format></Meta>
      <Data>
          <Package Name="{PackageFullName}" RemoveForAllUsers="1" />
      </Data>
   </Item>
</Exec>

User/AppManagement/ResetPackage

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 11, version 21H2 [10.0.22000] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/ResetPackage

Used to restore the Windows app to its initial configuration.

Description framework properties:

Property name Property value
Format xml
Access Type Exec, Get

User/AppManagement/System

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System

Reports apps installed as part of the operating system.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get

User/AppManagement/System/{PackageFamilyName}

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}

Package family name (PFN) of the app. There is one for each PFN on the device when reporting inventory. These items are rooted under their signing origin.

Note

XAP files use a product ID in place of PackageFamilyName. Here's an example of XAP product ID (including the braces), {12345678-9012-3456-7890-123456789012}.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory

Example:

<SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody>
        <!-- Uninstall app -->
        <delete>
           <CmdID>2</CmdID>
              <Item>
                 <Target>
                    <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/%7b12345678-9012-3456-7890-123456789012%7D</LocURI>
                 </Target>
              </Item>
        </delete>
     <Final/>
  </SyncBody>
</SyncML>
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}

Full name of the package installed.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get
Dynamic Node Naming ClientInventory
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Architecture
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Architecture

Architecture of installed package. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/InstallDate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/InstallDate

Date the app was installed. Value type is string.

This is a required node.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/InstallLocation
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/InstallLocation

Install location of the app on the device. Value type is string.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsBundle
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsBundle

The value is 1 if the package is an app bundle and 0 (zero) for all other cases. Value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsFramework
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsFramework

Whether or not the app is a framework package. Value type is int. The value is 1 if the app is a framework package and 0 (zero) for all other cases.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsProvisioned
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsProvisioned

The value is 0 or 1 that indicates if the app is provisioned on the device. The value type is int.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsStub
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/IsStub

This node is used to identify whether the package is a stub package. A stub package is a version of the package with minimal functionality that will reduce the size of the app.

The value is 1 if the package is a stub package and 0 (zero) for all other cases.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Name
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Name

Name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/PackageStatus
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/PackageStatus

Provides information about the status of the package. Value type is int. Valid values are: OK (0) - The package is usable. LicenseIssue (1) - The license of the package isn't valid. Modified (2) - The package payload was modified by an unknown source. Tampered (4) - The package payload was tampered intentionally. Disabled (8) - The package isn't available for use. It can still be serviced.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Publisher
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Publisher

Publisher name of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/RequiresReinstall
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/RequiresReinstall

Specifies whether the package state has changed and requires a reinstallation of the app. This can occur when new app resources are required, such as when a device has a change in language preference or a new DPI. It can also occur of the package was corrupted. If the value is 1, reinstallation of the app is performed.

This is a required node.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format int
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/ResourceID
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/ResourceID

Resource ID of the app. This is null for the main app, ~ for a bundle, and contains resource information for resources packages.

Note

Not applicable to XAP files.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Users
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Users

Registered users of the app and the package install state. If the query is at the device level, it returns all the registered users of the device. If you query the user context, it will only return the current user.

This is a required node.

  • 0 = Not Installed
  • 1 = Staged
  • 2 = Installed
  • 6 = Paused

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Version
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/{PackageFullName}/Version

Version of the app. Value type is string.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/System/{PackageFamilyName}/AppSettingPolicy
Scope Editions Applicable OS
❌ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppSettingPolicy

Interior node for all managed app setting values.

This node is only supported in the user context.

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get, Replace
User/AppManagement/System/{PackageFamilyName}/AppSettingPolicy/{SettingValue}
Scope Editions Applicable OS
❌ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/AppSettingPolicy/{SettingValue}

The SettingValue and data represent a key value pair to be configured for the app. The node represents the name of the key and the data represents the value. You can find this value in LocalSettings in the Managed. App. Settings container.

This setting only works for apps that support the feature and it's only supported in the user context.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace
Dynamic Node Naming UniqueName: SettingValue represents a Key in a Key Value Pair. Values can be found in LocalSettings in the Managed.App.Settings container.

Examples:

  • The following example sets the value for the 'Server'

    <!— Configure app settings -->
<Add>
    <CmdID>0</CmdID>
    <Item>
       <Target>
          <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy/Server</LocURI>
       </Target>
       <Meta>
          <Format xmlns="syncml:metinf">chr</Format>
       </Meta>
       <Data>server1.contoso.com</Data>
    </Item>
</Add>

  • The following example gets all managed app settings for a specific app.

    <!—Get app settings -->
<Get>
    <CmdID>0</CmdID>
    <Item>
       <Target>
          <LocURI>./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy?list=StructData</LocURI>
       </Target>
    </Item>
</Get>
User/AppManagement/System/{PackageFamilyName}/DoNotUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/DoNotUpdate

Specifies whether you want to block a specific app from being updated via auto-updates.

This is a required node.

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.
User/AppManagement/System/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 2004 [10.0.19041] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/{PackageFamilyName}/MaintainProcessorArchitectureOnUpdate

Specify whether on a AMD64 device, across an app update, the architecture of the installed app mustn't change. For example if you have the x86 flavor of a Windows app installed, with this setting enabled, across an update, the x86 flavor will be installed even when x64 flavor is available.

Expected Behavior on an AMD64 machine that has x86 flavor of an app installed (Most restrictive wins).

Applicability Setting CSP state Result
True Not configured X86 flavor is picked
True Enabled X86 flavor is picked
True Disabled X86 flavor is picked
False (not set) Not configured X64 flavor is picked

Description framework properties:

Property name Property value
Format int
Access Type Add, Delete, Get, Replace

Allowed values:

Value Description
0 False.
1 True.

User/AppManagement/System/ReleaseManagement

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement

Interior node for the managing updates through the Microsoft Store. These settings allow the IT admin to specify update channels for apps that they want their users to use for receiving updates. It allows the IT admin to assign a specific release to a smaller group for testing before the large deployment to the rest of the organization.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
User/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}

Identifier for the app or set of apps. If there is only one app, it's the PackageFamilyName. If it's for a set of apps, it's the PackageFamilyName of the main app.

Description framework properties:

Property name Property value
Format node
Access Type Get, Replace
Dynamic Node Naming UniqueName: If there is only one app, the name is the PackageFamilyName. If it is for a set of apps, the name is the PackageFamilyName of the main app.
User/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/ChannelId

Specifies the app channel ID.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace
User/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease

Interior node used to specify the effective app release to use when multiple user policies are set on the device. The device policy or last user policy is used.

Description framework properties:

Property name Property value
Format node
Access Type Get
User/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ChannelId

Returns the last user channel ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/EffectiveRelease/ReleaseManagementId

Returns the last user release ID on the device.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Get
User/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId
Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/System/ReleaseManagement/{ReleaseManagementKey}/ReleaseManagementId

The IT admin can specify a release ID to indicate a specific release that they would like the user or device to be on.

Description framework properties:

Property name Property value
Format chr (string)
Access Type Add, Delete, Get, Replace

User/AppManagement/UpdateScan

Scope Editions Applicable OS
✅ Device
✅ User		 ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE
✅ IoT Enterprise / IoT Enterprise LTSC		 ✅ Windows 10, version 1511 [10.0.10586] and later 
./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/UpdateScan

Used to start the Windows Update scan.

This is a required node.

Description framework properties:

Property name Property value
Format null
Access Type Exec

EnterpriseModernAppManagement XSD

Here is the XSD for the application parameters.

<?xml version="1.0" encoding="utf-16"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Data">
        <xs:complexType>
            <xs:sequence>
                <xs:element maxOccurs="1" name="Application">
                    <xs:complexType mixed="true">
                        <xs:sequence minOccurs="0">
                            <xs:element name="Dependencies">
                                <xs:complexType>
                                    <xs:sequence>
                                        <xs:element maxOccurs="unbounded" name="Dependency">
                                            <xs:complexType>
                                                <xs:attribute name="PackageUri" type="xs:string" use="required" />
                                            </xs:complexType>
                                        </xs:element>
                                    </xs:sequence>
                                </xs:complexType>
                            </xs:element>
                        </xs:sequence>
                        <xs:attribute name="DeploymentOptions" type="xs:unsignedByte" use="optional" />
                        <xs:attribute name="PackageUri" type="xs:string" use="required" />
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

Examples

For examples of how to use this CSP to for reporting apps inventory, installation and removal of apps for users, provisioning apps to devices, and managing app licenses, see Enterprise app management.

Query the device for a specific app subcategory, such as nonStore apps.

<Get>
  <CmdID>1</CmdID>
  <Item>
    <Target>
      <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore</LocURI>
    </Target>
  </Item>
</Get>

The result contains a list of apps, such as <Data>App1/App2/App</Data>.

Subsequent query for a specific app for its properties.

<Get>
   <CmdID>1</CmdID>
   <Item>
     <Target>
       <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/App1?list=StructData</LocURI>
     </Target>
   </Item>
</Get>
<Get>
  <CmdID>2</CmdID>
  <Item>
    <Target>
      <LocURI>./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/nonStore/App2?list=StructData</LocURI>
    </Target>
  </Item>
</Get>

Configuration service provider reference