diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index e104e625e8..34fdd3782a 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -20535,6 +20535,11 @@ "redirect_url": "/windows/client-management/mdm/windows/enterprisedesktopappmanagement-csp#downloadinstall-xsd-schema", "redirect_document_id": true }, + { + "source_path": "windows/client-management/mdm/enterprisemodernappmanagement-xsd.md", + "redirect_url": "/windows/client-management/mdm/enterprisemodernappmanagement-csp#enterprisemodernappmanagement-xsd", + "redirect_document_id": true + }, { "source_path": "education/windows/education-scenarios-store-for-business.md", "redirect_url": "/windows/resources", diff --git a/windows/client-management/mdm/enterprisemodernappmanagement-csp.md b/windows/client-management/mdm/enterprisemodernappmanagement-csp.md index 3157cc3ee4..726ff88fb1 100644 --- a/windows/client-management/mdm/enterprisemodernappmanagement-csp.md +++ b/windows/client-management/mdm/enterprisemodernappmanagement-csp.md @@ -4,7 +4,7 @@ description: Learn more about the EnterpriseModernAppManagement CSP. author: vinaypamnani-msft manager: aaroncz ms.author: vinpa -ms.date: 02/24/2023 +ms.date: 02/28/2023 ms.localizationpriority: medium ms.prod: windows-client ms.technology: itpro-manage @@ -19,241 +19,237 @@ ms.topic: reference 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](../enterprise-app-management.md). -Device or User context For user context, use ./User/Vendor/MSFT path and for device context, use ./Device/Vendor/MSFT path. - -> [!Note] +> [!NOTE] > Windows Holographic only supports per-user configuration of the EnterpriseModernAppManagement CSP. -The following example shows the EnterpriseModernAppManagement configuration service provider in tree format. +The following list shows the EnterpriseModernAppManagement configuration service provider nodes: -```text -./Device/Vendor/MSFT/EnterpriseModernAppManagement ---- AppInstallation ------- {PackageFamilyName} ---------- HostedInstall ---------- LastError ---------- LastErrorDesc ---------- ProgressStatus ---------- Status ---------- StoreInstall ---- AppLicenses ------- StoreLicenses ---------- {LicenseID} ------------- AddLicense ------------- GetLicenseFromStore ------------- LicenseCategory ------------- LicenseUsage ------------- RequesterID ---- AppManagement ------- AppInventoryQuery ------- AppInventoryResults ------- AppStore ---------- {PackageFamilyName} ------------- {PackageFullName} ---------------- Architecture ---------------- InstallDate ---------------- InstallLocation ---------------- IsBundle ---------------- IsFramework ---------------- IsProvisioned ---------------- IsStub ---------------- Name ---------------- PackageStatus ---------------- Publisher ---------------- RequiresReinstall ---------------- ResourceID ---------------- Users ---------------- Version ------------- DoNotUpdate ------------- MaintainProcessorArchitectureOnUpdate ------------- NonRemovable ---------- ReleaseManagement ------------- {ReleaseManagementKey} ---------------- ChannelId ---------------- EffectiveRelease ------------------- ChannelId ------------------- ReleaseManagementId ---------------- ReleaseManagementId ------- LastScanError ------- nonStore ---------- {PackageFamilyName} ------------- {PackageFullName} ---------------- Architecture ---------------- InstallDate ---------------- InstallLocation ---------------- IsBundle ---------------- IsFramework ---------------- IsProvisioned ---------------- IsStub ---------------- Name ---------------- PackageStatus ---------------- Publisher ---------------- RequiresReinstall ---------------- ResourceID ---------------- Users ---------------- Version ------------- DoNotUpdate ------------- MaintainProcessorArchitectureOnUpdate ------------- NonRemovable ---------- ReleaseManagement ------------- {ReleaseManagementKey} ---------------- ChannelId ---------------- EffectiveRelease ------------------- ChannelId ------------------- ReleaseManagementId ---------------- ReleaseManagementId ------- ResetPackage ------- System ---------- {PackageFamilyName} ------------- {PackageFullName} ---------------- Architecture ---------------- InstallDate ---------------- InstallLocation ---------------- IsBundle ---------------- IsFramework ---------------- IsProvisioned ---------------- IsStub ---------------- Name ---------------- PackageStatus ---------------- Publisher ---------------- RequiresReinstall ---------------- ResourceID ---------------- Users ---------------- Version ------------- AppUpdateSettings ---------------- AutoRepair ------------------- PackageSource ---------------- AutoUpdateSettings ------------------- AutomaticBackgroundTask ------------------- Disable ------------------- ForceUpdateFromAnyVersion ------------------- HoursBetweenUpdateChecks ------------------- OnLaunchUpdateCheck ------------------- PackageSource ------------------- ShowPrompt ------------------- UpdateBlocksActivation ------------- DoNotUpdate ------------- MaintainProcessorArchitectureOnUpdate ------------- NonRemovable ---------- ReleaseManagement ------------- {ReleaseManagementKey} ---------------- ChannelId ---------------- EffectiveRelease ------------------- ChannelId ------------------- ReleaseManagementId ---------------- ReleaseManagementId ------- UpdateScan -./User/Vendor/MSFT/EnterpriseModernAppManagement ---- AppInstallation ------- {PackageFamilyName} ---------- HostedInstall ---------- LastError ---------- LastErrorDesc ---------- ProgressStatus ---------- Status ---------- StoreInstall ---- AppLicenses ------- StoreLicenses ---------- {LicenseID} ------------- AddLicense ------------- GetLicenseFromStore ------------- LicenseCategory ------------- LicenseUsage ------------- RequesterID ---- AppManagement ------- AppInventoryQuery ------- AppInventoryResults ------- AppStore ---------- {PackageFamilyName} ------------- {PackageFullName} ---------------- Architecture ---------------- InstallDate ---------------- InstallLocation ---------------- IsBundle ---------------- IsFramework ---------------- IsProvisioned ---------------- IsStub ---------------- Name ---------------- PackageStatus ---------------- Publisher ---------------- RequiresReinstall ---------------- ResourceID ---------------- Users ---------------- Version ------------- AppSettingPolicy ---------------- {SettingValue} ------------- DoNotUpdate ------------- MaintainProcessorArchitectureOnUpdate ---------- ReleaseManagement ------------- {ReleaseManagementKey} ---------------- ChannelId ---------------- EffectiveRelease ------------------- ChannelId ------------------- ReleaseManagementId ---------------- ReleaseManagementId ------- LastScanError ------- nonStore ---------- {PackageFamilyName} ------------- {PackageFullName} ---------------- Architecture ---------------- InstallDate ---------------- InstallLocation ---------------- IsBundle ---------------- IsFramework ---------------- IsProvisioned ---------------- IsStub ---------------- Name ---------------- PackageStatus ---------------- Publisher ---------------- RequiresReinstall ---------------- ResourceID ---------------- Users ---------------- Version ------------- AppSettingPolicy ---------------- {SettingValue} ------------- DoNotUpdate ------------- MaintainProcessorArchitectureOnUpdate ---------- ReleaseManagement ------------- {ReleaseManagementKey} ---------------- ChannelId ---------------- EffectiveRelease ------------------- ChannelId ------------------- ReleaseManagementId ---------------- ReleaseManagementId ------- RemovePackage ------- ResetPackage ------- System ---------- {PackageFamilyName} ------------- {PackageFullName} ---------------- Architecture ---------------- InstallDate ---------------- InstallLocation ---------------- IsBundle ---------------- IsFramework ---------------- IsProvisioned ---------------- IsStub ---------------- Name ---------------- PackageStatus ---------------- Publisher ---------------- RequiresReinstall ---------------- ResourceID ---------------- Users ---------------- Version ------------- AppSettingPolicy ---------------- {SettingValue} ------------- DoNotUpdate ------------- MaintainProcessorArchitectureOnUpdate ---------- ReleaseManagement ------------- {ReleaseManagementKey} ---------------- ChannelId ---------------- EffectiveRelease ------------------- ChannelId ------------------- ReleaseManagementId ---------------- ReleaseManagementId ------- UpdateScan -``` +- ./Device/Vendor/MSFT/EnterpriseModernAppManagement + - [AppInstallation](#deviceappinstallation) + - [{PackageFamilyName}](#deviceappinstallationpackagefamilyname) + - [HostedInstall](#deviceappinstallationpackagefamilynamehostedinstall) + - [LastError](#deviceappinstallationpackagefamilynamelasterror) + - [LastErrorDesc](#deviceappinstallationpackagefamilynamelasterrordesc) + - [ProgressStatus](#deviceappinstallationpackagefamilynameprogressstatus) + - [Status](#deviceappinstallationpackagefamilynamestatus) + - [StoreInstall](#deviceappinstallationpackagefamilynamestoreinstall) + - [AppLicenses](#deviceapplicenses) + - [StoreLicenses](#deviceapplicensesstorelicenses) + - [{LicenseID}](#deviceapplicensesstorelicenseslicenseid) + - [AddLicense](#deviceapplicensesstorelicenseslicenseidaddlicense) + - [GetLicenseFromStore](#deviceapplicensesstorelicenseslicenseidgetlicensefromstore) + - [LicenseCategory](#deviceapplicensesstorelicenseslicenseidlicensecategory) + - [LicenseUsage](#deviceapplicensesstorelicenseslicenseidlicenseusage) + - [RequesterID](#deviceapplicensesstorelicenseslicenseidrequesterid) + - [AppManagement](#deviceappmanagement) + - [AppInventoryQuery](#deviceappmanagementappinventoryquery) + - [AppInventoryResults](#deviceappmanagementappinventoryresults) + - [AppStore](#deviceappmanagementappstore) + - [{PackageFamilyName}](#deviceappmanagementappstorepackagefamilyname) + - [{PackageFullName}](#deviceappmanagementappstorepackagefamilynamepackagefullname) + - [Architecture](#deviceappmanagementappstorepackagefamilynamepackagefullnamearchitecture) + - [InstallDate](#deviceappmanagementappstorepackagefamilynamepackagefullnameinstalldate) + - [InstallLocation](#deviceappmanagementappstorepackagefamilynamepackagefullnameinstalllocation) + - [IsBundle](#deviceappmanagementappstorepackagefamilynamepackagefullnameisbundle) + - [IsFramework](#deviceappmanagementappstorepackagefamilynamepackagefullnameisframework) + - [IsProvisioned](#deviceappmanagementappstorepackagefamilynamepackagefullnameisprovisioned) + - [IsStub](#deviceappmanagementappstorepackagefamilynamepackagefullnameisstub) + - [Name](#deviceappmanagementappstorepackagefamilynamepackagefullnamename) + - [PackageStatus](#deviceappmanagementappstorepackagefamilynamepackagefullnamepackagestatus) + - [Publisher](#deviceappmanagementappstorepackagefamilynamepackagefullnamepublisher) + - [RequiresReinstall](#deviceappmanagementappstorepackagefamilynamepackagefullnamerequiresreinstall) + - [ResourceID](#deviceappmanagementappstorepackagefamilynamepackagefullnameresourceid) + - [Users](#deviceappmanagementappstorepackagefamilynamepackagefullnameusers) + - [Version](#deviceappmanagementappstorepackagefamilynamepackagefullnameversion) + - [DoNotUpdate](#deviceappmanagementappstorepackagefamilynamedonotupdate) + - [MaintainProcessorArchitectureOnUpdate](#deviceappmanagementappstorepackagefamilynamemaintainprocessorarchitectureonupdate) + - [NonRemovable](#deviceappmanagementappstorepackagefamilynamenonremovable) + - [ReleaseManagement](#deviceappmanagementappstorereleasemanagement) + - [{ReleaseManagementKey}](#deviceappmanagementappstorereleasemanagementreleasemanagementkey) + - [ChannelId](#deviceappmanagementappstorereleasemanagementreleasemanagementkeychannelid) + - [EffectiveRelease](#deviceappmanagementappstorereleasemanagementreleasemanagementkeyeffectiverelease) + - [ChannelId](#deviceappmanagementappstorereleasemanagementreleasemanagementkeyeffectivereleasechannelid) + - [ReleaseManagementId](#deviceappmanagementappstorereleasemanagementreleasemanagementkeyeffectivereleasereleasemanagementid) + - [ReleaseManagementId](#deviceappmanagementappstorereleasemanagementreleasemanagementkeyreleasemanagementid) + - [LastScanError](#deviceappmanagementlastscanerror) + - [nonStore](#deviceappmanagementnonstore) + - [{PackageFamilyName}](#deviceappmanagementnonstorepackagefamilyname) + - [{PackageFullName}](#deviceappmanagementnonstorepackagefamilynamepackagefullname) + - [Architecture](#deviceappmanagementnonstorepackagefamilynamepackagefullnamearchitecture) + - [InstallDate](#deviceappmanagementnonstorepackagefamilynamepackagefullnameinstalldate) + - [InstallLocation](#deviceappmanagementnonstorepackagefamilynamepackagefullnameinstalllocation) + - [IsBundle](#deviceappmanagementnonstorepackagefamilynamepackagefullnameisbundle) + - [IsFramework](#deviceappmanagementnonstorepackagefamilynamepackagefullnameisframework) + - [IsProvisioned](#deviceappmanagementnonstorepackagefamilynamepackagefullnameisprovisioned) + - [IsStub](#deviceappmanagementnonstorepackagefamilynamepackagefullnameisstub) + - [Name](#deviceappmanagementnonstorepackagefamilynamepackagefullnamename) + - [PackageStatus](#deviceappmanagementnonstorepackagefamilynamepackagefullnamepackagestatus) + - [Publisher](#deviceappmanagementnonstorepackagefamilynamepackagefullnamepublisher) + - [RequiresReinstall](#deviceappmanagementnonstorepackagefamilynamepackagefullnamerequiresreinstall) + - [ResourceID](#deviceappmanagementnonstorepackagefamilynamepackagefullnameresourceid) + - [Users](#deviceappmanagementnonstorepackagefamilynamepackagefullnameusers) + - [Version](#deviceappmanagementnonstorepackagefamilynamepackagefullnameversion) + - [DoNotUpdate](#deviceappmanagementnonstorepackagefamilynamedonotupdate) + - [MaintainProcessorArchitectureOnUpdate](#deviceappmanagementnonstorepackagefamilynamemaintainprocessorarchitectureonupdate) + - [NonRemovable](#deviceappmanagementnonstorepackagefamilynamenonremovable) + - [ReleaseManagement](#deviceappmanagementnonstorereleasemanagement) + - [{ReleaseManagementKey}](#deviceappmanagementnonstorereleasemanagementreleasemanagementkey) + - [ChannelId](#deviceappmanagementnonstorereleasemanagementreleasemanagementkeychannelid) + - [EffectiveRelease](#deviceappmanagementnonstorereleasemanagementreleasemanagementkeyeffectiverelease) + - [ChannelId](#deviceappmanagementnonstorereleasemanagementreleasemanagementkeyeffectivereleasechannelid) + - [ReleaseManagementId](#deviceappmanagementnonstorereleasemanagementreleasemanagementkeyeffectivereleasereleasemanagementid) + - [ReleaseManagementId](#deviceappmanagementnonstorereleasemanagementreleasemanagementkeyreleasemanagementid) + - [ResetPackage](#deviceappmanagementresetpackage) + - [System](#deviceappmanagementsystem) + - [{PackageFamilyName}](#deviceappmanagementsystempackagefamilyname) + - [{PackageFullName}](#deviceappmanagementsystempackagefamilynamepackagefullname) + - [Architecture](#deviceappmanagementsystempackagefamilynamepackagefullnamearchitecture) + - [InstallDate](#deviceappmanagementsystempackagefamilynamepackagefullnameinstalldate) + - [InstallLocation](#deviceappmanagementsystempackagefamilynamepackagefullnameinstalllocation) + - [IsBundle](#deviceappmanagementsystempackagefamilynamepackagefullnameisbundle) + - [IsFramework](#deviceappmanagementsystempackagefamilynamepackagefullnameisframework) + - [IsProvisioned](#deviceappmanagementsystempackagefamilynamepackagefullnameisprovisioned) + - [IsStub](#deviceappmanagementsystempackagefamilynamepackagefullnameisstub) + - [Name](#deviceappmanagementsystempackagefamilynamepackagefullnamename) + - [PackageStatus](#deviceappmanagementsystempackagefamilynamepackagefullnamepackagestatus) + - [Publisher](#deviceappmanagementsystempackagefamilynamepackagefullnamepublisher) + - [RequiresReinstall](#deviceappmanagementsystempackagefamilynamepackagefullnamerequiresreinstall) + - [ResourceID](#deviceappmanagementsystempackagefamilynamepackagefullnameresourceid) + - [Users](#deviceappmanagementsystempackagefamilynamepackagefullnameusers) + - [Version](#deviceappmanagementsystempackagefamilynamepackagefullnameversion) + - [AppUpdateSettings](#deviceappmanagementsystempackagefamilynameappupdatesettings) + - [AutoRepair](#deviceappmanagementsystempackagefamilynameappupdatesettingsautorepair) + - [PackageSource](#deviceappmanagementsystempackagefamilynameappupdatesettingsautorepairpackagesource) + - [AutoUpdateSettings](#deviceappmanagementsystempackagefamilynameappupdatesettingsautoupdatesettings) + - [AutomaticBackgroundTask](#deviceappmanagementsystempackagefamilynameappupdatesettingsautoupdatesettingsautomaticbackgroundtask) + - [Disable](#deviceappmanagementsystempackagefamilynameappupdatesettingsautoupdatesettingsdisable) + - [ForceUpdateFromAnyVersion](#deviceappmanagementsystempackagefamilynameappupdatesettingsautoupdatesettingsforceupdatefromanyversion) + - [HoursBetweenUpdateChecks](#deviceappmanagementsystempackagefamilynameappupdatesettingsautoupdatesettingshoursbetweenupdatechecks) + - [OnLaunchUpdateCheck](#deviceappmanagementsystempackagefamilynameappupdatesettingsautoupdatesettingsonlaunchupdatecheck) + - [PackageSource](#deviceappmanagementsystempackagefamilynameappupdatesettingsautoupdatesettingspackagesource) + - [ShowPrompt](#deviceappmanagementsystempackagefamilynameappupdatesettingsautoupdatesettingsshowprompt) + - [UpdateBlocksActivation](#deviceappmanagementsystempackagefamilynameappupdatesettingsautoupdatesettingsupdateblocksactivation) + - [DoNotUpdate](#deviceappmanagementsystempackagefamilynamedonotupdate) + - [MaintainProcessorArchitectureOnUpdate](#deviceappmanagementsystempackagefamilynamemaintainprocessorarchitectureonupdate) + - [NonRemovable](#deviceappmanagementsystempackagefamilynamenonremovable) + - [ReleaseManagement](#deviceappmanagementsystemreleasemanagement) + - [{ReleaseManagementKey}](#deviceappmanagementsystemreleasemanagementreleasemanagementkey) + - [ChannelId](#deviceappmanagementsystemreleasemanagementreleasemanagementkeychannelid) + - [EffectiveRelease](#deviceappmanagementsystemreleasemanagementreleasemanagementkeyeffectiverelease) + - [ChannelId](#deviceappmanagementsystemreleasemanagementreleasemanagementkeyeffectivereleasechannelid) + - [ReleaseManagementId](#deviceappmanagementsystemreleasemanagementreleasemanagementkeyeffectivereleasereleasemanagementid) + - [ReleaseManagementId](#deviceappmanagementsystemreleasemanagementreleasemanagementkeyreleasemanagementid) + - [UpdateScan](#deviceappmanagementupdatescan) +- ./User/Vendor/MSFT/EnterpriseModernAppManagement + - [AppInstallation](#userappinstallation) + - [{PackageFamilyName}](#userappinstallationpackagefamilyname) + - [HostedInstall](#userappinstallationpackagefamilynamehostedinstall) + - [LastError](#userappinstallationpackagefamilynamelasterror) + - [LastErrorDesc](#userappinstallationpackagefamilynamelasterrordesc) + - [ProgressStatus](#userappinstallationpackagefamilynameprogressstatus) + - [Status](#userappinstallationpackagefamilynamestatus) + - [StoreInstall](#userappinstallationpackagefamilynamestoreinstall) + - [AppLicenses](#userapplicenses) + - [StoreLicenses](#userapplicensesstorelicenses) + - [{LicenseID}](#userapplicensesstorelicenseslicenseid) + - [AddLicense](#userapplicensesstorelicenseslicenseidaddlicense) + - [GetLicenseFromStore](#userapplicensesstorelicenseslicenseidgetlicensefromstore) + - [LicenseCategory](#userapplicensesstorelicenseslicenseidlicensecategory) + - [LicenseUsage](#userapplicensesstorelicenseslicenseidlicenseusage) + - [RequesterID](#userapplicensesstorelicenseslicenseidrequesterid) + - [AppManagement](#userappmanagement) + - [AppInventoryQuery](#userappmanagementappinventoryquery) + - [AppInventoryResults](#userappmanagementappinventoryresults) + - [AppStore](#userappmanagementappstore) + - [{PackageFamilyName}](#userappmanagementappstorepackagefamilyname) + - [{PackageFullName}](#userappmanagementappstorepackagefamilynamepackagefullname) + - [Architecture](#userappmanagementappstorepackagefamilynamepackagefullnamearchitecture) + - [InstallDate](#userappmanagementappstorepackagefamilynamepackagefullnameinstalldate) + - [InstallLocation](#userappmanagementappstorepackagefamilynamepackagefullnameinstalllocation) + - [IsBundle](#userappmanagementappstorepackagefamilynamepackagefullnameisbundle) + - [IsFramework](#userappmanagementappstorepackagefamilynamepackagefullnameisframework) + - [IsProvisioned](#userappmanagementappstorepackagefamilynamepackagefullnameisprovisioned) + - [IsStub](#userappmanagementappstorepackagefamilynamepackagefullnameisstub) + - [Name](#userappmanagementappstorepackagefamilynamepackagefullnamename) + - [PackageStatus](#userappmanagementappstorepackagefamilynamepackagefullnamepackagestatus) + - [Publisher](#userappmanagementappstorepackagefamilynamepackagefullnamepublisher) + - [RequiresReinstall](#userappmanagementappstorepackagefamilynamepackagefullnamerequiresreinstall) + - [ResourceID](#userappmanagementappstorepackagefamilynamepackagefullnameresourceid) + - [Users](#userappmanagementappstorepackagefamilynamepackagefullnameusers) + - [Version](#userappmanagementappstorepackagefamilynamepackagefullnameversion) + - [AppSettingPolicy](#userappmanagementappstorepackagefamilynameappsettingpolicy) + - [{SettingValue}](#userappmanagementappstorepackagefamilynameappsettingpolicysettingvalue) + - [DoNotUpdate](#userappmanagementappstorepackagefamilynamedonotupdate) + - [MaintainProcessorArchitectureOnUpdate](#userappmanagementappstorepackagefamilynamemaintainprocessorarchitectureonupdate) + - [ReleaseManagement](#userappmanagementappstorereleasemanagement) + - [{ReleaseManagementKey}](#userappmanagementappstorereleasemanagementreleasemanagementkey) + - [ChannelId](#userappmanagementappstorereleasemanagementreleasemanagementkeychannelid) + - [EffectiveRelease](#userappmanagementappstorereleasemanagementreleasemanagementkeyeffectiverelease) + - [ChannelId](#userappmanagementappstorereleasemanagementreleasemanagementkeyeffectivereleasechannelid) + - [ReleaseManagementId](#userappmanagementappstorereleasemanagementreleasemanagementkeyeffectivereleasereleasemanagementid) + - [ReleaseManagementId](#userappmanagementappstorereleasemanagementreleasemanagementkeyreleasemanagementid) + - [LastScanError](#userappmanagementlastscanerror) + - [nonStore](#userappmanagementnonstore) + - [{PackageFamilyName}](#userappmanagementnonstorepackagefamilyname) + - [{PackageFullName}](#userappmanagementnonstorepackagefamilynamepackagefullname) + - [Architecture](#userappmanagementnonstorepackagefamilynamepackagefullnamearchitecture) + - [InstallDate](#userappmanagementnonstorepackagefamilynamepackagefullnameinstalldate) + - [InstallLocation](#userappmanagementnonstorepackagefamilynamepackagefullnameinstalllocation) + - [IsBundle](#userappmanagementnonstorepackagefamilynamepackagefullnameisbundle) + - [IsFramework](#userappmanagementnonstorepackagefamilynamepackagefullnameisframework) + - [IsProvisioned](#userappmanagementnonstorepackagefamilynamepackagefullnameisprovisioned) + - [IsStub](#userappmanagementnonstorepackagefamilynamepackagefullnameisstub) + - [Name](#userappmanagementnonstorepackagefamilynamepackagefullnamename) + - [PackageStatus](#userappmanagementnonstorepackagefamilynamepackagefullnamepackagestatus) + - [Publisher](#userappmanagementnonstorepackagefamilynamepackagefullnamepublisher) + - [RequiresReinstall](#userappmanagementnonstorepackagefamilynamepackagefullnamerequiresreinstall) + - [ResourceID](#userappmanagementnonstorepackagefamilynamepackagefullnameresourceid) + - [Users](#userappmanagementnonstorepackagefamilynamepackagefullnameusers) + - [Version](#userappmanagementnonstorepackagefamilynamepackagefullnameversion) + - [AppSettingPolicy](#userappmanagementnonstorepackagefamilynameappsettingpolicy) + - [{SettingValue}](#userappmanagementnonstorepackagefamilynameappsettingpolicysettingvalue) + - [DoNotUpdate](#userappmanagementnonstorepackagefamilynamedonotupdate) + - [MaintainProcessorArchitectureOnUpdate](#userappmanagementnonstorepackagefamilynamemaintainprocessorarchitectureonupdate) + - [ReleaseManagement](#userappmanagementnonstorereleasemanagement) + - [{ReleaseManagementKey}](#userappmanagementnonstorereleasemanagementreleasemanagementkey) + - [ChannelId](#userappmanagementnonstorereleasemanagementreleasemanagementkeychannelid) + - [EffectiveRelease](#userappmanagementnonstorereleasemanagementreleasemanagementkeyeffectiverelease) + - [ChannelId](#userappmanagementnonstorereleasemanagementreleasemanagementkeyeffectivereleasechannelid) + - [ReleaseManagementId](#userappmanagementnonstorereleasemanagementreleasemanagementkeyeffectivereleasereleasemanagementid) + - [ReleaseManagementId](#userappmanagementnonstorereleasemanagementreleasemanagementkeyreleasemanagementid) + - [RemovePackage](#userappmanagementremovepackage) + - [ResetPackage](#userappmanagementresetpackage) + - [System](#userappmanagementsystem) + - [{PackageFamilyName}](#userappmanagementsystempackagefamilyname) + - [{PackageFullName}](#userappmanagementsystempackagefamilynamepackagefullname) + - [Architecture](#userappmanagementsystempackagefamilynamepackagefullnamearchitecture) + - [InstallDate](#userappmanagementsystempackagefamilynamepackagefullnameinstalldate) + - [InstallLocation](#userappmanagementsystempackagefamilynamepackagefullnameinstalllocation) + - [IsBundle](#userappmanagementsystempackagefamilynamepackagefullnameisbundle) + - [IsFramework](#userappmanagementsystempackagefamilynamepackagefullnameisframework) + - [IsProvisioned](#userappmanagementsystempackagefamilynamepackagefullnameisprovisioned) + - [IsStub](#userappmanagementsystempackagefamilynamepackagefullnameisstub) + - [Name](#userappmanagementsystempackagefamilynamepackagefullnamename) + - [PackageStatus](#userappmanagementsystempackagefamilynamepackagefullnamepackagestatus) + - [Publisher](#userappmanagementsystempackagefamilynamepackagefullnamepublisher) + - [RequiresReinstall](#userappmanagementsystempackagefamilynamepackagefullnamerequiresreinstall) + - [ResourceID](#userappmanagementsystempackagefamilynamepackagefullnameresourceid) + - [Users](#userappmanagementsystempackagefamilynamepackagefullnameusers) + - [Version](#userappmanagementsystempackagefamilynamepackagefullnameversion) + - [AppSettingPolicy](#userappmanagementsystempackagefamilynameappsettingpolicy) + - [{SettingValue}](#userappmanagementsystempackagefamilynameappsettingpolicysettingvalue) + - [DoNotUpdate](#userappmanagementsystempackagefamilynamedonotupdate) + - [MaintainProcessorArchitectureOnUpdate](#userappmanagementsystempackagefamilynamemaintainprocessorarchitectureonupdate) + - [ReleaseManagement](#userappmanagementsystemreleasemanagement) + - [{ReleaseManagementKey}](#userappmanagementsystemreleasemanagementreleasemanagementkey) + - [ChannelId](#userappmanagementsystemreleasemanagementreleasemanagementkeychannelid) + - [EffectiveRelease](#userappmanagementsystemreleasemanagementreleasemanagementkeyeffectiverelease) + - [ChannelId](#userappmanagementsystemreleasemanagementreleasemanagementkeyeffectivereleasechannelid) + - [ReleaseManagementId](#userappmanagementsystemreleasemanagementreleasemanagementkeyeffectivereleasereleasemanagementid) + - [ReleaseManagementId](#userappmanagementsystemreleasemanagementreleasemanagementkeyreleasemanagementid) + - [UpdateScan](#userappmanagementupdatescan) @@ -277,7 +273,7 @@ Used to perform app installation. -Required node. +This is a required node. @@ -316,9 +312,9 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh -Optional. +This is an optional node. -> [!Note] +> [!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}. @@ -333,6 +329,8 @@ Optional. +**Example**: + Here's an example for uninstalling an app: ```xml @@ -376,14 +374,12 @@ Command to perform an install of an app package from a hosted location (this can -Required. - -The following list shows the supported deployment options: +This is a required node. The following list shows the supported deployment options: - ForceApplicationShutdown -- DevelopmentMode  +- DevelopmentMode - InstallAllResources -- ForceTargetApplicationShutdown  +- 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. @@ -428,7 +424,7 @@ Last error relating to the app installation. -> [!Note] +> [!NOTE] > This element isn't present after the app is installed. @@ -468,7 +464,7 @@ Description of last error relating to the app installation. -> [!Note] +> [!NOTE] > This element isn't present after the app is installed. @@ -508,7 +504,7 @@ An integer the indicates the progress of the app installation. For https locatio -> [!Note] +> [!NOTE] > This element isn't present after the app is installed. @@ -548,7 +544,7 @@ Status of app installation. The following values are returned: NOT_INSTALLED (0) -> [!Note] +> [!NOTE] > This element isn't present after the app is installed. @@ -666,7 +662,7 @@ Used to manage licenses for store apps. -Required. +This is a required node. @@ -705,7 +701,7 @@ License ID for a store installed app. The license ID is generally the PFN of the -Optional. +This is an optional node. @@ -745,7 +741,7 @@ Command to add license. -Required. +This is a required node. @@ -784,7 +780,7 @@ Command to get license from the store. -Required. +This is a required node. @@ -940,7 +936,7 @@ Used for inventory and app management (post-install). -Required. +This is a required node. @@ -979,36 +975,35 @@ Specifies the query for app inventory. -Required. +This is a required node. Query parameters: -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. -- 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: +- 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. - - 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. +- 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. + 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. +- 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. + 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. +- 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. + If you don't specify this value, then all publishers are returned. @@ -1021,6 +1016,8 @@ Query parameters: +**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. ```xml @@ -1060,7 +1057,7 @@ Returns the results for app inventory that was created after the AppInventoryQue -Required. +This is a required node. @@ -1073,6 +1070,8 @@ Required. +**Example**: + Here's an example of AppInventoryResults operation. ```xml @@ -1109,7 +1108,7 @@ Here's an example of AppInventoryResults operation. -Required. Used for managing apps from the Microsoft Store. +This is a required node. Used for managing apps from the Microsoft Store. @@ -1148,7 +1147,7 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh -> [!Note] +> [!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}. @@ -1163,6 +1162,8 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh +**Example**: + Here's an example for uninstalling an app: ```xml @@ -1246,7 +1247,7 @@ Architecture of installed package. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -1286,7 +1287,7 @@ Date the app was installed. Value type is string. -Required. +This is a required node. @@ -1325,7 +1326,7 @@ Install location of the app on the device. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -1404,7 +1405,7 @@ Whether or not the app is a framework package. Value type is int. The value is 1 -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -1484,8 +1485,6 @@ This node is used to identify whether the package is a stub package. A stub pack The value is 1 if the package is a stub package and 0 (zero) for all other cases. - -Value type is int. @@ -1563,7 +1562,7 @@ Provides information about the status of the package. Value type is int. Valid v -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -1642,9 +1641,9 @@ Specifies whether the package state has changed and requires a reinstallation of -Required. +This is a required node. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -1684,7 +1683,7 @@ Resource ID of the app. This is null for the main app, ~ for a bundle, and conta -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -1724,12 +1723,12 @@ Registered users of the app and the package install state. If the query is at th -Requried. +This is a required node. Possible values: -- Not Installed = 0 -- Staged = 1 -- Installed = 2 -- Paused = 6 +- 0 = Not Installed +- 1 = Staged +- 2 = Installed +- 6 = Paused @@ -1807,7 +1806,7 @@ Specifies whether you want to block a specific app from being updated via auto-u -Required. +This is a required node. @@ -1857,12 +1856,12 @@ Specify whether on a AMD64 device, across an app update, the architecture of the 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 | +| 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 | @@ -1932,69 +1931,69 @@ NonRemovable requires admin permission. This setting can only be defined per dev -Add an app to the nonremovable app policy list +**Examples**: -```xml - - - - 1 - - - ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable - - - int - - 1 - - - +- Add an app to the nonremovable app policy list + + ```xml + + + + 1 + + + ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable + + + int + + 1 + + + + + + ``` + +- Get the status for a particular app + + ```xml + + + + 1 + + + ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable + + + + + + + ``` + +- 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) + + ```xml + + + + 1 + + + ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable + + + int + + 0 + + + - -``` - -Get the status for a particular app - -```xml - - - - 1 - - - ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable - - - - - - -``` - -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 - -```xml - - - - 1 - - - ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable - - - int - - 0 - - - - - -``` + + ``` @@ -2295,7 +2294,7 @@ Reports the last error code returned by the update scan. -Required. +This is a required node. @@ -2372,7 +2371,7 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh -> [!Note] +> [!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}. @@ -2387,6 +2386,8 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh +**Example**: + Here's an example for uninstalling an app: ```xml @@ -2470,7 +2471,7 @@ Architecture of installed package. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -2510,7 +2511,7 @@ Date the app was installed. Value type is string. -Required +This is a required node. @@ -2549,7 +2550,7 @@ Install location of the app on the device. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -2628,7 +2629,7 @@ Whether or not the app is a framework package. Value type is int. The value is 1 -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -2708,8 +2709,6 @@ This node is used to identify whether the package is a stub package. A stub pack The value is 1 if the package is a stub package and 0 (zero) for all other cases. - -Value type is int. @@ -2787,7 +2786,7 @@ Provides information about the status of the package. Value type is int. Valid v -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -2866,9 +2865,9 @@ Specifies whether the package state has changed and requires a reinstallation of -Required. +This is a required node. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -2908,7 +2907,7 @@ Resource ID of the app. This is null for the main app, ~ for a bundle, and conta -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -2948,12 +2947,12 @@ Registered users of the app and the package install state. If the query is at th -Requried. +This is a required node. Possible values: -- Not Installed = 0 -- Staged = 1 -- Installed = 2 -- Paused = 6 +- 0 = Not Installed +- 1 = Staged +- 2 = Installed +- 6 = Paused @@ -3031,7 +3030,7 @@ Specifies whether you want to block a specific app from being updated via auto-u -Required. +This is a required node. @@ -3081,12 +3080,12 @@ Specify whether on a AMD64 device, across an app update, the architecture of the 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 | +| 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 | @@ -3156,69 +3155,69 @@ NonRemovable requires admin permission. This setting can only be defined per dev -Add an app to the nonremovable app policy list +**Examples**: -```xml - - - +- Add an app to the nonremovable app policy list + + ```xml + + + + 1 + + + ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable + + + int + + 1 + + + + + + ``` + +- Get the status for a particular app + + ```xml + + + 1 - - ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable - - - int - - 1 + + ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable + - - + + - -``` + + ``` -Get the status for a particular app +- 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) -```xml - - - - 1 - - - ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable - - - - - - -``` - -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 - -```xml - - - - 1 - - - ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable - - - int - - 0 - - - - - -``` + ```xml + + + + 1 + + + ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable + + + int + + 0 + + + + + + ``` @@ -3595,7 +3594,7 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh -> [!Note] +> [!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}. @@ -3676,7 +3675,7 @@ Architecture of installed package. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -3716,7 +3715,7 @@ Date the app was installed. Value type is string. -Required. +This is a required node. @@ -3755,7 +3754,7 @@ Install location of the app on the device. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -3834,7 +3833,7 @@ Whether or not the app is a framework package. Value type is int. The value is 1 -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -3914,8 +3913,6 @@ This node is used to identify whether the package is a stub package. A stub pack The value is 1 if the package is a stub package and 0 (zero) for all other cases. - -Value type is int. @@ -3993,7 +3990,7 @@ Provides information about the status of the package. Value type is int. Valid v -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -4072,9 +4069,9 @@ Specifies whether the package state has changed and requires a reinstallation of -Required. +This is a required node. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -4114,7 +4111,7 @@ Resource ID of the app. This is null for the main app, ~ for a bundle, and conta -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -4154,12 +4151,12 @@ Registered users of the app and the package install state. If the query is at th -Requried. +This is a required node. -- Not Installed = 0 -- Staged = 1 -- Installed = 2 -- Paused = 6 +- 0 = Not Installed +- 1 = Staged +- 2 = Installed +- 6 = Paused @@ -4769,7 +4766,7 @@ Specifies whether you want to block a specific app from being updated via auto-u -Required. +This is a required node. @@ -4819,12 +4816,12 @@ Specify whether on a AMD64 device, across an app update, the architecture of the 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 | +| 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 | @@ -4894,69 +4891,69 @@ NonRemovable requires admin permission. This setting can only be defined per dev -Add an app to the nonremovable app policy list +**Examples**: -```xml - - - - 1 - - - ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable - - - int - - 1 - - - +- Add an app to the nonremovable app policy list + + ```xml + + + + 1 + + + ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable + + + int + + 1 + + + + + + ``` + +- Get the status for a particular app + + ```xml + + + + 1 + + + ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable + + + + - -``` + + ``` -Get the status for a particular app +- 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) -```xml - - - - 1 - - - ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable - - - - - - -``` - -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 - -```xml - - - - 1 - - - ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable - - - int - - 0 - - - - - -``` + ```xml + + + + 1 + + + ./Device/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/NonRemovable + + + int + + 0 + + + + + + ``` @@ -5256,7 +5253,7 @@ Used to start the Windows Update scan. -Required. +This is a required node. @@ -5334,7 +5331,7 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh -> [!Note] +> [!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}. @@ -5349,6 +5346,8 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh +**Example**: + Here's an example for uninstalling an app: ```xml @@ -5392,14 +5391,12 @@ Command to perform an install of an app package from a hosted location (this can -Required. - -The following list shows the supported deployment options: +This is a required node. The following list shows the supported deployment options: - ForceApplicationShutdown -- DevelopmentMode  +- DevelopmentMode - InstallAllResources -- ForceTargetApplicationShutdown  +- 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. @@ -5444,7 +5441,7 @@ Last error relating to the app installation. -> [!Note] +> [!NOTE] > This element isn't present after the app is installed. @@ -5484,7 +5481,7 @@ Description of last error relating to the app installation. -> [!Note] +> [!NOTE] > This element isn't present after the app is installed. @@ -5524,7 +5521,7 @@ An integer the indicates the progress of the app installation. For https locatio -> [!Note] +> [!NOTE] > This element isn't present after the app is installed. @@ -5564,7 +5561,7 @@ Status of app installation. The following values are returned: NOT_INSTALLED (0) -> [!Note] +> [!NOTE] > This element isn't present after the app is installed. @@ -5721,7 +5718,7 @@ License ID for a store installed app. The license ID is generally the PFN of the -Optional. +This is an optional node. @@ -5761,7 +5758,7 @@ Command to add license. -Required. +This is a required node. @@ -5800,7 +5797,7 @@ Command to get license from the store. -Required. +This is a required node. @@ -5995,37 +5992,33 @@ Specifies the query for app inventory. -Required. +This is a required node. Query parameters: -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. -- 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: + If no value is specified, the combination of Main, Bundle, and Framework are returned. - - 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. +- 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 no value is specified, the combination of Main, Bundle, and Framework are returned. + If you don't specify this value, then all packages 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. +- 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. @@ -6038,6 +6031,8 @@ Query parameters: +**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. ```xml @@ -6077,7 +6072,7 @@ Returns the results for app inventory that was created after the AppInventoryQue -Required. +This is a required node. @@ -6090,6 +6085,8 @@ Required. +**Example**: + Here's an example of AppInventoryResults operation. ```xml @@ -6126,7 +6123,7 @@ Here's an example of AppInventoryResults operation. -Required. Used for managing apps from the Microsoft Store. +This is a required node. Used for managing apps from the Microsoft Store. @@ -6165,7 +6162,7 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh -> [!Note] +> [!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}. @@ -6180,6 +6177,8 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh +**Example**: + Here's an example for uninstalling an app: ```xml @@ -6263,7 +6262,7 @@ Architecture of installed package. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -6303,7 +6302,7 @@ Date the app was installed. Value type is string. -Required. +This is a required node. @@ -6342,7 +6341,7 @@ Install location of the app on the device. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -6421,7 +6420,7 @@ Whether or not the app is a framework package. Value type is int. The value is 1 -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -6501,8 +6500,6 @@ This node is used to identify whether the package is a stub package. A stub pack The value is 1 if the package is a stub package and 0 (zero) for all other cases. - -Value type is int. @@ -6580,7 +6577,7 @@ Provides information about the status of the package. Value type is int. Valid v -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -6659,9 +6656,9 @@ Specifies whether the package state has changed and requires a reinstallation of -Required. +This is a required node. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -6701,7 +6698,7 @@ Resource ID of the app. This is null for the main app, ~ for a bundle, and conta -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -6741,12 +6738,12 @@ Registered users of the app and the package install state. If the query is at th -Requried. +This is a required node. Possible values: -- Not Installed = 0 -- Staged = 1 -- Installed = 2 -- Paused = 6 +- 0 = Not Installed +- 1 = Staged +- 2 = Installed +- 6 = Paused @@ -6824,7 +6821,8 @@ Interior node for all managed app setting values. -This node is only supported in the user context. +> [!NOTE] +> This node is only supported in the user context. @@ -6877,37 +6875,39 @@ This setting only works for apps that support the feature and it's only supporte -The following example sets the value for the 'Server' +**Examples**: -```xml - - - 0 - - - ./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy/Server - - - chr - - server1.contoso.com - - -``` +- The following example sets the value for the 'Server' -The following example gets all managed app settings for a specific app. + ```xml + + + 0 + + + ./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy/Server + + + chr + + server1.contoso.com + + + ``` -```xml - - - 0 - - - ./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy?list=StructData - - - -``` +- The following example gets all managed app settings for a specific app. + + ```xml + + + 0 + + + ./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy?list=StructData + + + + ``` @@ -6933,7 +6933,7 @@ Specifies whether you want to block a specific app from being updated via auto-u -Required. +This is a required node. @@ -7311,7 +7311,7 @@ Reports the last error code returned by the update scan. -Required. +This is a required node. @@ -7388,7 +7388,7 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh -> [!Note] +> [!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}. @@ -7484,7 +7484,7 @@ Architecture of installed package. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -7524,7 +7524,7 @@ Date the app was installed. Value type is string. -Required. +This is a required node. @@ -7563,7 +7563,7 @@ Install location of the app on the device. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -7642,7 +7642,7 @@ Whether or not the app is a framework package. Value type is int. The value is 1 -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -7801,7 +7801,7 @@ Provides information about the status of the package. Value type is int. Valid v -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -7880,9 +7880,9 @@ Specifies whether the package state has changed and requires a reinstallation of -Required. +This is a required node. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -7922,7 +7922,7 @@ Resource ID of the app. This is null for the main app, ~ for a bundle, and conta -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -8154,7 +8154,7 @@ Specifies whether you want to block a specific app from being updated via auto-u -Required. +This is a required node. @@ -8204,12 +8204,12 @@ Specify whether on a AMD64 device, across an app update, the architecture of the 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 | +| 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 | @@ -8532,20 +8532,13 @@ 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. @@ -8558,6 +8551,8 @@ Parameters: +**Example**: + The following example removes a package for all users: ````XML @@ -8676,7 +8671,7 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh -> [!Note] +> [!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}. @@ -8691,6 +8686,8 @@ Package family name (PFN) of the app. There is one for each PFN on the device wh +**Example**: + ```xml @@ -8772,7 +8769,7 @@ Architecture of installed package. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -8812,7 +8809,7 @@ Date the app was installed. Value type is string. -Required. +This is a required node. @@ -8851,7 +8848,7 @@ Install location of the app on the device. Value type is string. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -8930,7 +8927,7 @@ Whether or not the app is a framework package. Value type is int. The value is 1 -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -9010,8 +9007,6 @@ This node is used to identify whether the package is a stub package. A stub pack The value is 1 if the package is a stub package and 0 (zero) for all other cases. - -Value type is int. @@ -9089,7 +9084,7 @@ Provides information about the status of the package. Value type is int. Valid v -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -9168,9 +9163,9 @@ Specifies whether the package state has changed and requires a reinstallation of -Required. +This is a required node. -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -9210,7 +9205,7 @@ Resource ID of the app. This is null for the main app, ~ for a bundle, and conta -> [!Note] +> [!NOTE] > Not applicable to XAP files. @@ -9250,12 +9245,12 @@ Registered users of the app and the package install state. If the query is at th -Requried. +This is a required node. -- Not Installed = 0 -- Staged = 1 -- Installed = 2 -- Paused = 6 +- 0 = Not Installed +- 1 = Staged +- 2 = Installed +- 6 = Paused @@ -9386,37 +9381,39 @@ This setting only works for apps that support the feature and it's only supporte -The following example sets the value for the 'Server' +**Examples**: -```xml - - - 0 - - - ./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy/Server - - - chr - - server1.contoso.com - - -``` +- The following example sets the value for the 'Server' -The following example gets all managed app settings for a specific app. + ```xml + + + 0 + + + ./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy/Server + + + chr + + server1.contoso.com + + + ``` -```xml - - - 0 - - - ./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy?list=StructData - - - -``` +- The following example gets all managed app settings for a specific app. + + ```xml + + + 0 + + + ./User/Vendor/MSFT/EnterpriseModernAppManagement/AppManagement/AppStore/PackageFamilyName/AppSettingPolicy?list=StructData + + + + ``` @@ -9442,7 +9439,7 @@ Specifies whether you want to block a specific app from being updated via auto-u -Required. +This is a required node. @@ -9492,12 +9489,12 @@ Specify whether on a AMD64 device, across an app update, the architecture of the 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 | +| 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 | @@ -9819,7 +9816,7 @@ Used to start the Windows Update scan. -Required. +This is a required node. @@ -9838,6 +9835,42 @@ Required. + +## EnterpriseModernAppManagement XSD + +Here is the XSD for the application parameters. + +```xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + ## 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](../enterprise-app-management.md). diff --git a/windows/client-management/mdm/enterprisemodernappmanagement-xsd.md b/windows/client-management/mdm/enterprisemodernappmanagement-xsd.md deleted file mode 100644 index 423e4752c9..0000000000 --- a/windows/client-management/mdm/enterprisemodernappmanagement-xsd.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: EnterpriseModernAppManagement XSD -description: In this article, view the EnterpriseModernAppManagement XSD example so you can set application parameters. -ms.reviewer: -manager: aaroncz -ms.author: vinpa -ms.topic: article -ms.prod: windows-client -ms.technology: itpro-manage -author: vinaypamnani-msft -ms.date: 06/26/2017 ---- - -# EnterpriseModernAppManagement XSD - -Here is the XSD for the application parameters. - -```xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` - -  - -  - - - - - -