From f9fded60d6a6e0729c55c3518a2003e2859f3597 Mon Sep 17 00:00:00 2001 From: Dani Halfin Date: Tue, 11 Sep 2018 00:00:08 +0000 Subject: [PATCH] Merged PR 11206: Live push for down-level privacy events and fields --- ...ndows-diagnostic-events-and-fields-1703.md | 4543 ++++++----- ...ndows-diagnostic-events-and-fields-1709.md | 7015 +++++++++-------- ...ndows-diagnostic-events-and-fields-1803.md | 4396 ++++++----- 3 files changed, 8625 insertions(+), 7329 deletions(-) diff --git a/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1703.md b/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1703.md index d75aa0580e..371890febb 100644 --- a/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1703.md +++ b/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1703.md @@ -1,15 +1,15 @@ --- description: Use this article to learn more about what Windows diagnostic data is gathered at the basic level. title: Windows 10, version 1703 basic diagnostic events and fields (Windows 10) -keywords: privacy, diagnostic data +keywords: privacy, telemetry ms.prod: w10 ms.mktglfcycl: manage ms.sitesec: library ms.pagetype: security -ms.localizationpriority: high -author: eross-msft -ms.author: lizross -ms.date: 03/13/2018 +localizationpriority: high +author: brianlic-msft +ms.author: brianlic +ms.date: 09/10/2018 --- @@ -19,225 +19,22 @@ ms.date: 03/13/2018 - Windows 10, version 1703 -The Basic level gathers a limited set of information that is critical for understanding the device and its configuration including: basic device information, quality-related information, app compatibility, and Microsoft Store. When the level is set to Basic, it also includes the Security level information. The Basic level also helps to identify problems that can occur on a particular device hardware or software configuration. For example, it can help determine if crashes are more frequent on devices with a specific amount of memory or that are running a particular driver version. This helps Microsoft fix operating system or app problems. -Use this article to learn about diagnostic events, grouped by event area, and the fields within each event. A brief description is provided for each field. Every event generated includes common data, which collects device data. You can learn more about Windows functional and diagnostic data through these articles: +The Basic level gathers a limited set of information that is critical for understanding the device and its configuration including: basic device information, quality-related information, app compatibility, and Windows Store. When the level is set to Basic, it also includes the Security level information. -- [Windows 10, version 1803 basic diagnostic events and fields](https://docs.microsoft.com/windows/configuration/basic-level-windows-diagnostic-events-and-fields-1803) -- [Windows 10, version 1709 basic diagnostic events and fields](https://docs.microsoft.com/windows/configuration/basic-level-windows-diagnostic-events-and-fields-1709) +The Basic level helps to identify problems that can occur on a particular device hardware or software configuration. For example, it can help determine if crashes are more frequent on devices with a specific amount of memory or that are running a particular driver version. This helps Microsoft fix operating system or app problems. + +Use this article to learn about diagnostic events, grouped by event area, and the fields within each event. A brief description is provided for each field. Every event generated includes common data, which collects device data. + +You can learn more about Windows functional and diagnostic data through these articles: + + +- [Windows 10, version 1803 basic diagnostic events and fields](basic-level-windows-diagnostic-events-and-fields-1803.md) +- [Windows 10, version 1709 basic diagnostic events and fields](basic-level-windows-diagnostic-events-and-fields-1709.md) - [Manage connections from Windows operating system components to Microsoft services](manage-connections-from-windows-operating-system-components-to-microsoft-services.md) - [Configure Windows diagnostic data in your organization](configure-windows-diagnostic-data-in-your-organization.md) ->[!Note] ->Updated November 2017 to document new and modified events. We’ve added some new events and also added new fields to existing events to prepare for upgrades to the next release of Windows. -## Common data extensions - -### Common Data Extensions.App - -The following fields are available: - -- **expId** Associates a flight, such as an OS flight, or an experiment, such as a web site UX experiment, with an event. -- **userId** The userID as known by the application. -- **env** The environment from which the event was logged. -- **asId** An integer value that represents the app session. This value starts at 0 on the first app launch and increments after each subsequent app launch per boot session. - - -### Common Data Extensions.CS - -The following fields are available: - -- **sig** A common schema signature that identifies new and modified event schemas. - - -### Common Data Extensions.CUET - -The following fields are available: - -- **stId** Represents the Scenario Entry Point ID. This is a unique GUID for each event in a diagnostic scenario. This used to be Scenario Trigger ID. -- **aId** Represents the ETW ActivityId. Logged via TraceLogging or directly via ETW. -- **raId** Represents the ETW Related ActivityId. Logged via TraceLogging or directly via ETW. -- **op** Represents the ETW Op Code. -- **cat** Represents a bitmask of the ETW Keywords associated with the event. -- **flags** Represents the bitmap that captures various Windows specific flags. -- **cpId** The composer ID, such as Reference, Desktop, Phone, Holographic, Hub, IoT Composer. -- **tickets** A list of strings that represent entries in the HTTP header of the web request that includes this event. -- **bseq** Upload buffer sequence number in the format \:\ -- **mon** Combined monitor and event sequence numbers in the format \:\ - - -### Common Data Extensions.Device - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **localId** Represents a locally defined unique ID for the device, not the human readable device name. Most likely equal to the value stored at HKLM\Software\Microsoft\SQMClient\MachineId -- **deviceClass** Represents the classification of the device, the device “family”.  For example, Desktop, Server, or Mobile. - - -### Common Data Extensions.Envelope - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **name** Represents the uniquely qualified name for the event. -- **time** Represents the event date time in Coordinated Universal Time (UTC) when the event was generated on the client. This should be in ISO 8601 format. -- **popSample** Represents the effective sample rate for this event at the time it was generated by a client. -- **epoch** Represents the epoch and seqNum fields, which help track how many events were fired and how many events were uploaded, and enables identification of data lost during upload and de-duplication of events on the ingress server. -- **seqNum** Represents the sequence field used to track absolute order of uploaded events. It is an incrementing identifier for each event added to the upload queue.  The Sequence helps track how many events were fired and how many events were uploaded and enables identification of data lost during upload and de-duplication of events on the ingress server. -- **iKey** Represents an ID for applications or other logical groupings of events. -- **flags** Represents a collection of bits that describe how the event should be processed by the Connected User Experiences and Telemetry component pipeline. The lowest-order byte is the event persistence. The next byte is the event latency. -- **os** Represents the operating system name. -- **osVer** Represents the OS version, and its format is OS dependent. -- **appId** Represents a unique identifier of the client application currently loaded in the process producing the event; and is used to group events together and understand usage pattern, errors by application. -- **appVer** Represents the version number of the application. Used to understand errors by Version, Usage by Version across an app. -- **cV** Represents the Correlation Vector: A single field for tracking partial order of related diagnostic data events across component boundaries. - - -### Common Data Extensions.OS - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **expId** Represents the experiment ID. The standard for associating a flight, such as an OS flight (pre-release build), or an experiment, such as a web site UX experiment, with an event is to record the flight / experiment IDs in Part A of the common schema. -- **locale** Represents the locale of the operating system. -- **bootId** An integer value that represents the boot session. This value starts at 0 on first boot after OS install and increments after every reboot. - - -### Common Data Extensions.User - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **localId** Represents a unique user identity that is created locally and added by the client. This is not the user's account ID. - - -### Common Data Extensions.XBL - - - -The following fields are available: - -- **nbf** Not before time -- **expId** Expiration time -- **sbx** XBOX sandbox identifier -- **dty** XBOX device type -- **did** XBOX device ID -- **xid** A list of base10-encoded XBOX User IDs. -- **uts** A bit field, with 2 bits being assigned to each user ID listed in xid. This field is omitted if all users are retail accounts. - - -### Common Data Extensions.Consent UI Event - -This User Account Control (UAC) diagnostic data point collects information on elevations that originate from low integrity levels. This occurs when a process running at low integrity level (IL) requires higher (administrator) privileges, and therefore requests for elevation via UAC (consent.exe). By better understanding the processes requesting these elevations, Microsoft can in turn improve the detection and handling of potentially malicious behavior in this path. - -The following fields are available: - -- **eventType** Represents the type of elevation: If it succeeded, was cancelled, or was auto-approved. -- **splitToken** Represents the flag used to distinguish between administrators and standard users. -- **friendlyName** Represents the name of the file requesting elevation from low IL. -- **elevationReason** Represents the distinction between various elevation requests sources (appcompat, installer, COM, MSI and so on). -- **exeName** Represents the name of the file requesting elevation from low IL. -- **signatureState** Represents the state of the signature, if it signed, unsigned, OS signed and so on. -- **publisherName** Represents the name of the publisher of the file requesting elevation from low IL. -- **cmdLine** Represents the full command line arguments being used to elevate. -- **Hash.Length** Represents the length of the hash of the file requesting elevation from low IL. -- **Hash** Represents the hash of the file requesting elevation from low IL. -- **HashAlgId** Represents the algorithm ID of the hash of the file requesting elevation from low IL. -- **telemetryFlags** Represents the details about the elevation prompt for CEIP data. -- **timeStamp** Represents the time stamp on the file requesting elevation. -- **fileVersionMS** Represents the major version of the file requesting elevation. -- **fileVersionLS** Represents the minor version of the file requesting elevation. - - -## Common data fields - -### Common Data Fields.MS.Device.DeviceInventory.Change - -These fields are added whenever Ms.Device.DeviceInventoryChange is included in the event. - -The following fields are available: - -- **syncId** A string used to group StartSync, EndSync, Add, and Remove operations that belong together. This field is unique by Sync period and is used to disambiguate in situations where multiple agents perform overlapping inventories for the same object. -- **objectType** Indicates the object type that the event applies to. -- **Action** The change that was invoked on a device inventory object. -- **inventoryId** Device ID used for Compatibility testing - - -### Common Data Fields.TelClientSynthetic.PrivacySettingsAfterCreatorsUpdate.PreUpgradeSettings - -These fields are added whenever PreUpgradeSettings is included in the event. - -The following fields are available: - -- **HKLM_SensorPermissionState.SensorPermissionState** The state of the Location service before the feature update completed. -- **HKLM_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the device. -- **HKCU_SensorPermissionState.SensorPermissionState** The state of the Location service when a user signs on before the feature update completed. -- **HKCU_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the current user. -- **HKLM_LocationPlatform.Status** The state of the location platform after the feature update has completed. -- **HKLM_LocationPlatform.HRESULT** The error code returned when trying to query the location platform for the device. -- **HKLM_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the device before the feature update completed. -- **HKLM_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the device. -- **HKCU_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the current user before the feature update completed. -- **HKCU_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the current user. -- **HKLM_AllowTelemetry.AllowTelemetry** The state of the Connected User Experiences and Telemetry component for the device before the feature update. -- **HKLM_AllowTelemetry.HRESULT** The error code returned when trying to query the Connected User Experiences and Telemetry conponent for the device. -- **HKLM_TIPC.Enabled** The state of TIPC for the device. -- **HKLM_TIPC.HRESULT** The error code returned when trying to query TIPC for the device. -- **HKCU_TIPC.Enabled** The state of TIPC for the current user. -- **HKCU_TIPC.HRESULT** The error code returned when trying to query TIPC for the current user. -- **HKLM_FlipAhead.FPEnabled** Is Flip Ahead enabled for the device before the feature update was completed? -- **HKLM_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the device. -- **HKCU_FlipAhead.FPEnabled** Is Flip Ahead enabled for the current user before the feature update was completed? -- **HKCU_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the current user. -- **HKLM_TailoredExperiences.TailoredExperiencesWithDiagnosticDataEnabled** Is Tailored Experiences with Diagnostics Data enabled for the current user after the feature update had completed? -- **HKCU_TailoredExperiences.HRESULT** The error code returned when trying to query Tailored Experiences with Diagnostics Data for the current user. -- **HKLM_AdvertisingID.Enabled** Is the adverising ID enabled for the device? -- **HKLM_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the device. -- **HKCU_AdvertisingID.Enabled** Is the adveristing ID enabled for the current user? -- **HKCU_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the user. - - -### Common Data Fields.TelClientSynthetic.PrivacySettingsAfterCreatorsUpdate.PostUpgradeSettings - -These fields are added whenever PostUpgradeSettings is included in the event. - -The following fields are available: - -- **HKLM_SensorPermissionState.SensorPermissionState** The state of the Location service after the feature update has completed. -- **HKLM_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the device. -- **HKCU_SensorPermissionState.SensorPermissionState** The state of the Location service when a user signs on after a feature update has completed. -- **HKCU_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the current user. -- **HKLM_LocationPlatform.Status** The state of the location platform after the feature update has completed. -- **HKLM_LocationPlatform.HRESULT** The error code returned when trying to query the location platform for the device. -- **HKLM_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the device after the feature update has completed. -- **HKLM_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the device. -- **HKCU_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the current user after the feature update has completed. -- **HKCU_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the current user. -- **HKLM_AllowTelemetry.AllowTelemetry** The state of the Connected User Experiences and Telemetry component for the device after the feature update. -- **HKLM_AllowTelemetry.HRESULT** The error code returned when trying to query the Connected User Experiences and Telemetry conponent for the device. -- **HKLM_TIPC.Enabled** The state of TIPC for the device. -- **HKLM_TIPC.HRESULT** The error code returned when trying to query TIPC for the device. -- **HKCU_TIPC.Enabled** The state of TIPC for the current user. -- **HKCU_TIPC.HRESULT** The error code returned when trying to query TIPC for the current user. -- **HKLM_FlipAhead.FPEnabled** Is Flip Ahead enabled for the device after the feature update has completed? -- **HKLM_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the device. -- **HKCU_FlipAhead.FPEnabled** Is Flip Ahead enabled for the current user after the feature update has completed? -- **HKCU_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the current user. -- **HKLM_TailoredExperiences.TailoredExperiencesWithDiagnosticDataEnabled** Is Tailored Experiences with Diagnostics Data enabled for the current user after the feature update had completed? -- **HKCU_TailoredExperiences.HRESULT** The error code returned when trying to query Tailored Experiences with Diagnostics Data for the current user. -- **HKLM_AdvertisingID.Enabled** Is the adveristing ID enabled for the device? -- **HKLM_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the device. -- **HKCU_AdvertisingID.Enabled** Is the adveristing ID enabled for the current user? -- **HKCU_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the user. ## Appraiser events @@ -248,93 +45,46 @@ This event lists the types of objects and how many of each exist on the client d The following fields are available: -- **DatasourceApplicationFile_RS3** The total DecisionApplicationFile objects targeting the next release of Windows on this device. on this device. -- **DatasourceDevicePnp_RS3** The total DatasourceDevicePnp objects targeting the next release of Windows on this device. -- **DatasourceDriverPackage_RS3** The total DatasourceDriverPackage objects targeting the next release of Windows on this device. +- **DatasourceApplicationFile_RS3** The total DecisionApplicationFile objects targeting the next release of Windows on this device. +- **DatasourceDevicePnp_RS3** The total DatasourceDevicePnp objects targeting the next release of Windows on this device. +- **DatasourceDriverPackage_RS3** The total DatasourceDriverPackage objects targeting the next release of Windows on this device. - **DataSourceMatchingInfoBlock_RS3** The total DataSourceMatchingInfoBlock objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPassive objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoPostUpgrade_RS3** The total DataSourceMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. -- **DatasourceSystemBios_RS3** The total DatasourceSystemBios objects targeting the next release of Windows on this device. -- **DecisionApplicationFile_RS3** The total DecisionApplicationFile objects targeting the next release of Windows on this device. -- **DecisionDevicePnp_RS3** The total DecisionDevicePnp objects targeting the next release of Windows on this device. -- **DecisionDriverPackage_RS3** The total DecisionDriverPackage objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoBlock_RS3** The total DecisionMatchingInfoBlock objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoPostUpgrade_RS3** The total DecisionMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. -- **DecisionMediaCenter_RS3** The total DecisionMediaCenter objects targeting the next release of Windows on this device. -- **DecisionSystemBios_RS3** The total DecisionSystemBios objects targeting the next release of Windows on this device. -- **PCFP** An ID for the system that is calculated by hashing hardware identifiers. -- **InventoryApplicationFile** The total InventoryApplicationFile objects that are present on this device. -- **InventoryMediaCenter** The total InventoryMediaCenter objects that are present on this device. -- **InventoryLanguagePack** The total InventoryLanguagePack objects that are present on this device. -- **InventoryUplevelDriverPackage** The total InventoryUplevelDriverPackage objects that are present on this device. -- **InventorySystemBios** The total InventorySystemBios objects that are present on this device. -- **SystemProcessorCompareExchange** The total SystemProcessorCompareExchange objects that are present on this device. -- **SystemProcessorLahfSahf** The total SystemProcessorLahfSahf objects that are present on this device. -- **SystemMemory** The total SystemMemory objects that are present on this device. -- **SystemProcessorPrefetchW** The total SystemProcessorPrefetchW objects that are present on this device. -- **SystemProcessorSse2** The total SystemProcessorSse2 objects that are present on this device. -- **SystemProcessorNx** The total SystemProcessorNx objects that are present on this device. -- **SystemWlan** The total SystemWlan objects that are present on this device. -- **SystemWim** The total SystemWim objects that are present on this device -- **SystemTouch** The total SystemTouch objects that are present on this device. -- **SystemWindowsActivationStatus** The total SystemWindowsActivationStatus objects that are present on this device. -- **Wmdrm_RS3** The total Wmdrm objects targeting the next release of Windows on this device. - - -### Microsoft.Windows.Appraiser.General.ChecksumTotalPictureIdHashSha256 - -This event lists the types of objects and the hashed values of all the identifiers for each one. This allows for a more in-depth way to ensure that the records present on the server match what is present on the client. - -The following fields are available: - -- **DatasourceApplicationFile_RS3** The total DatasourceApplicationFile objects targeting the next release of Windows on this device. -- **DatasourceDevicePnp_RS3** The total DatasourceDevicePnp objects targeting the next release of Windows on this device. -- **DatasourceDriverPackage_RS3** The total DatasourceDriverPackage objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoBlock_RS3** The total DataSourceMatchingInfoBlock objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPassive objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoPostUpgrade_RS3** The total DataSourceMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. -- **DatasourceSystemBios_RS3** The total DatasourceSystemBios objects targeting the next release of Windows on this device. -- **DecisionApplicationFile_RS3** The total DecisionApplicationFile objects targeting the next release of Windows on this device. -- **DecisionDevicePnp_RS3** The total DecisionDevicePnp objects targeting the next release of Windows on this device. -- **DecisionDriverPackage_RS3** The total DecisionDriverPackage objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoBlock_RS3** The total DecisionMatchingInfoBlock objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoPostUpgrade_RS3** The total DecisionMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. -- **DecisionMediaCenter_RS3** The total DecisionMediaCenter objects targeting the next release of Windows on this device. -- **DecisionSystemBios_RS3** The total DecisionSystemBios objects targeting the next release of Windows on this device. -- **PCFP** An ID for the system that is calculated by hashing hardware identifiers. -- **InventoryApplicationFile** The SHA256 hash of InventoryApplicationFile objects that are present on this device. -- **InventoryMediaCenter** The SHA256 hash of InventoryMediaCenter objects that are present on this device. -- **InventoryLanguagePack** The SHA256 hash of InventoryLanguagePack objects that are present on this device. -- **InventoryUplevelDriverPackage** The SHA256 hash of InventoryUplevelDriverPackage objects that are present on this device. -- **InventorySystemBios** The SHA256 hash of InventorySystemBios objects that are present on this device. -- **SystemProcessorCompareExchange** The SHA256 hash of SystemProcessorCompareExchange objects that are present on this device. -- **SystemProcessorLahfSahf** The SHA256 hash of SystemProcessorLahfSahf objects that are present on this device. -- **SystemMemory** The SHA256 hash of SystemMemory objects that are present on this device. -- **SystemProcessorPrefetchW** The SHA256 hash of SystemProcessorPrefetchW objects that are present on this device. -- **SystemProcessorSse2** The SHA256 hash of SystemProcessorSse2 objects that are present on this device. -- **SystemProcessorNx** The SHA256 hash of SystemProcessorNx objects that are present on this device. -- **SystemWlan** The SHA256 hash of SystemWlan objects that are present on this device. -- **SystemWim** The SHA256 hash of SystemWim objects that are present on this device. -- **SystemTouch** The SHA256 hash of SystemTouch objects that are present on this device. -- **SystemWindowsActivationStatus** The SHA256 hash of SystemWindowsActivationStatus objects that are present on this device. -- **Wmdrm_RS3** The total Wmdrm objects targeting the next release of Windows on this device. +- **DataSourceMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPassive objects targeting the next release of Windows on this device. +- **DataSourceMatchingInfoPostUpgrade_RS3** The total DataSourceMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. +- **DatasourceSystemBios_RS3** The total DatasourceSystemBios objects targeting the next release of Windows on this device. +- **DecisionApplicationFile_RS3** The total DecisionApplicationFile objects targeting the next release of Windows on this device. +- **DecisionDevicePnp_RS3** The total DecisionDevicePnp objects targeting the next release of Windows on this device. +- **DecisionDriverPackage_RS3** The total DecisionDriverPackage objects targeting the next release of Windows on this device. +- **DecisionMatchingInfoBlock_RS3** The total DecisionMatchingInfoBlock objects targeting the next release of Windows on this device. +- **DecisionMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPassive objects targeting the next release of Windows on this device. +- **DecisionMatchingInfoPostUpgrade_RS3** The total DecisionMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. +- **DecisionMediaCenter_RS3** The total DecisionMediaCenter objects targeting the next release of Windows on this device. +- **DecisionSystemBios_RS3** The total DecisionSystemBios objects targeting the next release of Windows on this device. +- **InventoryLanguagePack** The count of DecisionApplicationFile objects present on this machine targeting the next release of Windows +- **InventorySystemBios** The count of DecisionDevicePnp objects present on this machine targeting the next release of Windows +- **PCFP** The count of DecisionDriverPackage objects present on this machine targeting the next release of Windows +- **SystemProcessorCompareExchange** The count of DecisionMatchingInfoBlock objects present on this machine targeting the next release of Windows +- **SystemProcessorNx** The count of DataSourceMatchingInfoPostUpgrade objects present on this machine targeting the next release of Windows +- **SystemProcessorSse2** The count of DecisionMatchingInfoPostUpgrade objects present on this machine targeting the next release of Windows +- **SystemWim** The count of DecisionMediaCenter objects present on this machine targeting the next release of Windows +- **SystemWindowsActivationStatus** The count of DecisionSystemBios objects present on this machine targeting the next release of Windows +- **SystemWlan** The count of InventoryApplicationFile objects present on this machine. +- **Wmdrm_RS3** The total Wmdrm objects targeting the next release of Windows on this device. ### Microsoft.Windows.Appraiser.General.DatasourceApplicationFileAdd -This event sends compatibility information about a file to help keep Windows up-to-date. +Represents the basic metadata about specific application files installed on the system. The following fields are available: - **AppraiserVersion** The version of the appraiser file that is generating the events. -- **AvDisplayName** If it is an anti-virus app, this is its display name. +- **AvDisplayName** If the app is an anti-virus app, this is its display name. - **CompatModelIndex** The compatibility prediction for this file. -- **HasCitData** Is the file present in CIT data? -- **HasUpgradeExe** Does the anti-virus app have an upgrade.exe file? +- **HasCitData** Indicates whether the file is present in CIT data. +- **HasUpgradeExe** Indicates whether the anti-virus app has an upgrade.exe file. - **IsAv** Is the file an anti-virus reporting EXE? -- **ResolveAttempted** This will always be an empty string when sending diagnostic data. +- **ResolveAttempted** This will always be an empty string when sending telemetry. - **SdbEntries** An array of fields that indicates the SDB entries that apply to this file. @@ -342,6 +92,8 @@ The following fields are available: This event indicates that the DatasourceApplicationFile object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -351,6 +103,8 @@ The following fields are available: This event indicates that a new set of DatasourceApplicationFileAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -358,16 +112,18 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DatasourceDevicePnpAdd -This event sends compatibility data for a PNP device, to help keep Windows up-to-date. +This event sends compatibility data for a Plug and Play device, to help keep Windows up to date. The following fields are available: +- **ActiveNetworkConnection** Indicates whether the device is an active network device. - **AppraiserVersion** The version of the appraiser file generating the events. -- **ActiveNetworkConnection** Is the device an active network device? -- **IsBootCritical** Is the device boot critical? +- **IsBootCritical** Indicates whether the device boot is critical. - **SdbEntries** An array of fields indicating the SDB entries that apply to this device. -- **WuDriverCoverage** Is there a driver uplevel for this device according to Windows Update? -- **WuDriverUpdateID** The Windows Update ID of the applicable uplevel driver. +- **WuDriverCoverage** Indicates whether there is a driver uplevel for this device, according to Windows Update. +- **WuDriverUpdateId** The Windows Update ID of the applicable uplevel driver. +- **WuDriverUpdateID** The Update ID of the applicable uplevel driver from Windows Update. +- **WuPopulatedFromId** The expected uplevel driver matching ID based on driver coverage from Windows Update. - **WuPopulatedFromID** The expected uplevel driver matching ID based on driver coverage from Windows Update. @@ -375,6 +131,8 @@ The following fields are available: This event indicates that the DatasourceDevicePnp object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -384,6 +142,8 @@ The following fields are available: This event indicates that a new set of DatasourceDevicePnpAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -391,18 +151,19 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DatasourceDriverPackageAdd -This event sends compatibility database data about driver packages to help keep Windows up-to-date. +This event sends compatibility database data about driver packages to help keep Windows up to date. The following fields are available: - **AppraiserVersion** The version of the appraiser file generating the events. -- **SdbEntries** An array of fields indicating the SDB entries that apply to this driver package. ### Microsoft.Windows.Appraiser.General.DatasourceDriverPackageRemove This event indicates that the DatasourceDriverPackage object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -412,6 +173,8 @@ The following fields are available: This event indicates that a new set of DatasourceDriverPackageAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -424,13 +187,14 @@ This event sends blocking data about any compatibility blocking entries hit on t The following fields are available: - **AppraiserVersion** The version of the appraiser file generating the events. -- **SdbEntries** An array of fields indicating the SDB entries that apply to this file. ### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockRemove This event indicates that the DataSourceMatchingInfoBlock object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -440,6 +204,8 @@ The following fields are available: This event indicates that a full set of DataSourceMatchingInfoBlockStAdd events have been sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -452,13 +218,14 @@ This event sends compatibility database information about non-blocking compatibi The following fields are available: - **AppraiserVersion** The version of the appraiser file generating the events. -- **SdbEntries** An array of fields indicating the SDB entries that apply to this file. ### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveRemove This event indicates that the DataSourceMatchingInfoPassive object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -468,6 +235,8 @@ The following fields are available: This event indicates that a new set of DataSourceMatchingInfoPassiveAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -480,13 +249,14 @@ This event sends compatibility database information about entries requiring rein The following fields are available: - **AppraiserVersion** The version of the appraiser file generating the events. -- **SdbEntries** An array of fields indicating the SDB entries that apply to this file. ### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeRemove This event indicates that the DataSourceMatchingInfoPostUpgrade object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -496,6 +266,8 @@ The following fields are available: This event indicates that a new set of DataSourceMatchingInfoPostUpgradeAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -515,6 +287,8 @@ The following fields are available: This event indicates that the DatasourceSystemBios object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -524,6 +298,8 @@ The following fields are available: This event indicates that a new set of DatasourceSystemBiosAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -535,9 +311,9 @@ This event sends compatibility decision data about a file to help keep Windows u The following fields are available: -- **AppraiserVersion** The version of the appraiser file generating the events. +- **AppraiserVersion** The version of the appraiser file that is generating the events. - **BlockAlreadyInbox** The uplevel runtime block on the file already existed on the current OS. -- **BlockingApplication** Are there any application issues that interfere with upgrade due to the file in question? +- **BlockingApplication** Indicates whether there are any application issues that interfere with the upgrade due to the file in question. - **DisplayGenericMessage** Will be a generic message be shown for this file? - **HardBlock** This file is blocked in the SDB. - **HasUxBlockOverride** Does the file have a block that is overridden by a tag in the SDB? @@ -558,7 +334,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionApplicationFileRemove -This event indicates that the DecisionApplicationFile object is no longer present. +This event indicates Indicates that the DecisionApplicationFile object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -569,6 +347,8 @@ The following fields are available: This event indicates that a new set of DecisionApplicationFileAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -576,16 +356,16 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionDevicePnpAdd -This event sends compatibility decision data about a PNP device to help keep Windows up-to-date. +This event sends compatibility decision data about a PNP device to help keep Windows up to date. The following fields are available: - **AppraiserVersion** The version of the appraiser file generating the events. - **AssociatedDriverIsBlocked** Is the driver associated with this PNP device blocked? - **BlockAssociatedDriver** Should the driver associated with this PNP device be blocked? +- **BlockingDevice** Is this PNP device blocking upgrade? - **BlockUpgradeIfDriverBlocked** Is the PNP device both boot critical and does not have a driver included with the OS? - **BlockUpgradeIfDriverBlockedAndOnlyActiveNetwork** Is this PNP device the only active network device? -- **BlockingDevice** Is this PNP device blocking upgrade? - **DisplayGenericMessage** Will a generic message be shown during Setup for this PNP device? - **DriverAvailableInbox** Is a driver included with the operating system for this PNP device? - **DriverAvailableOnline** Is there a driver for this PNP device on Windows Update? @@ -595,13 +375,14 @@ The following fields are available: - **NotRegressed** Does the device have a problem code on the source OS that is no better than the one it would have on the target OS? - **SdbDeviceBlockUpgrade** Is there an SDB block on the PNP device that blocks upgrade? - **SdbDriverBlockOverridden** Is there an SDB block on the PNP device that blocks upgrade, but that block was overridden? -- **AssociatedDriverWillNotMigrate** Will the driver associated with this plug-and-play device migrate? ### Microsoft.Windows.Appraiser.General.DecisionDevicePnpRemove This event indicates that the DecisionDevicePnp object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -611,6 +392,8 @@ The following fields are available: This event indicates that the DecisionDevicePnp object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -618,7 +401,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionDriverPackageAdd -This event sends decision data about driver package compatibility to help keep Windows up-to-date. +This event sends decision data about driver package compatibility to help keep Windows up to date. The following fields are available: @@ -634,6 +417,8 @@ The following fields are available: This event indicates that the DecisionDriverPackage object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -643,6 +428,8 @@ The following fields are available: This event indicates that a new set of DecisionDriverPackageAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -650,7 +437,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoBlockAdd -This event sends compatibility decision data about blocking entries on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. +This event sends compatibility decision data about blocking entries on the system that are not keyed by either applications or devices, to help keep Windows up to date. The following fields are available: @@ -667,6 +454,8 @@ The following fields are available: This event indicates that the DecisionMatchingInfoBlock object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -676,6 +465,8 @@ The following fields are available: This event indicates that a new set of DecisionMatchingInfoBlockAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -696,6 +487,8 @@ The following fields are available: This event Indicates that the DecisionMatchingInfoPassive object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -705,6 +498,8 @@ The following fields are available: This event indicates that a new set of DecisionMatchingInfoPassiveAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -712,7 +507,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPostUpgradeAdd -This event sends compatibility decision data about entries that require reinstall after upgrade. It's used to help keep Windows up-to-date. +This event sends compatibility decision data about entries that require reinstall after upgrade. It's used to help keep Windows up to date. The following fields are available: @@ -727,6 +522,8 @@ The following fields are available: This event indicates that the DecisionMatchingInfoPostUpgrade object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -736,6 +533,8 @@ The following fields are available: This event indicates that a new set of DecisionMatchingInfoPostUpgradeAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -743,15 +542,15 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionMediaCenterAdd -This event sends decision data about the presence of Windows Media Center, to help keep Windows up-to-date. +This event sends decision data about the presence of Windows Media Center, to help keep Windows up to date. The following fields are available: - **AppraiserVersion** The version of the Appraiser file generating the events. - **BlockingApplication** Is there any application issues that interfere with upgrade due to Windows Media Center? - **MediaCenterActivelyUsed** If Windows Media Center is supported on the edition, has it been run at least once and are the MediaCenterIndicators are true? -- **MediaCenterInUse** Is Windows Media Center actively being used? - **MediaCenterIndicators** Do any indicators imply that Windows Media Center is in active use? +- **MediaCenterInUse** Is Windows Media Center actively being used? - **MediaCenterPaidOrActivelyUsed** Is Windows Media Center actively being used or is it running on a supported edition? - **NeedsDismissAction** Are there any actions that can be dismissed coming from Windows Media Center? @@ -760,6 +559,8 @@ The following fields are available: This event indicates that the DecisionMediaCenter object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -769,6 +570,8 @@ The following fields are available: This event indicates that a new set of DecisionMediaCenterAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -776,7 +579,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionSystemBiosAdd -This event sends compatibility decision data about the BIOS to help keep Windows up-to-date. +This event sends compatibility decision data about the BIOS to help keep Windows up to date. The following fields are available: @@ -789,6 +592,8 @@ The following fields are available: This event indicates that the DecisionSystemBios object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -798,6 +603,8 @@ The following fields are available: This event indicates that a new set of DecisionSystemBiosAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -805,12 +612,12 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.EnterpriseScenarioWithDiagTrackServiceRunning -The event that indicates that Appraiser has been triggered to run an enterprise scenario while the DiagTrack service is installed. This event can only be sent if a special flag is used to trigger the enterprise scenario. +This event indicates that Appraiser has been triggered to run an enterprise scenario while the DiagTrack service is installed. This event can only be sent if a special flag is used to trigger the enterprise scenario. The following fields are available: -- **Time** The client time of the event. - **PCFP** An ID for the system calculated by hashing hardware identifiers. +- **Time** The client time of the event. ### Microsoft.Windows.Appraiser.General.GatedRegChange @@ -819,31 +626,28 @@ This event sends data about the results of running a set of quick-blocking instr The following fields are available: -- **Time** The client time of the event. +- **NewData** The data in the registry value after the scan completed. +- **OldData** The previous data in the registry value before the scan ran. - **PCFP** An ID for the system calculated by hashing hardware identifiers. - **RegKey** The registry key name for which a result is being sent. - **RegValue** The registry value for which a result is being sent. -- **OldData** The previous data in the registry value before the scan ran. -- **NewData** The data in the registry value after the scan completed. +- **Time** The client time of the event. ### Microsoft.Windows.Appraiser.General.InventoryApplicationFileAdd -This event represents the basic metadata about a file on the system. The file must be part of an app and either have a block in the compatibility database or are part of an anti-virus program. +This event represents the basic metadata about a file on the system. The file must be part of an app and either have a block in the compatibility database or be part of an antivirus program. The following fields are available: -- **AvDisplayName** If the app is an anti-virus app, this is its display name. -- **AvProductState** Represents state of antivirus program with respect to whether it's turned on and the signatures are up-to-date. -- **BinaryType** A binary type. Example: UNINITIALIZED, ZERO_BYTE, DATA_ONLY, DOS_MODULE, NE16_MODULE, PE32_UNKNOWN, PE32_I386, PE32_ARM, PE64_UNKNOWN, PE64_AMD64, PE64_ARM64, PE64_IA64, PE32_CLR_32, PE32_CLR_IL, PE32_CLR_IL_PREFER32, PE64_CLR_64 +- **AppraiserVersion** The version of the Appraiser file generating the events. +- **BinaryType** A binary type. Example: UNINITIALIZED, ZERO_BYTE, DATA_ONLY, DOS_MODULE, NE16_MODULE, PE32_UNKNOWN, PE32_I386, PE32_ARM, PE64_UNKNOWN, PE64_AMD64, PE64_ARM64, PE64_IA64, PE32_CLR_32, PE32_CLR_IL, PE32_CLR_IL_PREFER32, PE64_CLR_64. - **BinFileVersion** An attempt to clean up FileVersion at the client that tries to place the version into 4 octets. - **BinProductVersion** An attempt to clean up ProductVersion at the client that tries to place the version into 4 octets. - **BoeProgramId** If there is no entry in Add/Remove Programs, this is the ProgramID that is generated from the file metadata. - **CompanyName** The company name of the vendor who developed this file. - **FileId** A hash that uniquely identifies a file. - **FileVersion** The File version field from the file metadata under Properties -> Details. -- **HasUpgradeExe** Does the anti-virus app have an upgrade.exe file? -- **IsAv** Is the file an anti-virus reporting EXE? - **LinkDate** The date and time that this file was linked on. - **LowerCaseLongPath** The full file path to the file that was inventoried on the device. - **Name** The name of the file that was inventoried. @@ -852,29 +656,13 @@ The following fields are available: - **ProgramId** A hash of the Name, Version, Publisher, and Language of an application used to identify it. - **Size** The size of the file (in hexadecimal bytes). -### Microsoft.Windows.Inventory.Core.InventoryApplicationDriverAdd - -This event represents the drivers that an application installs. - -The following fields are available: - -- **InventoryVersion** The version of the inventory component -- **Programids** The unique program identifier the driver is associated with. - - -### Microsoft.Windows.Inventory.Core.InventoryApplicationDriverStartSync - -This event indicates that a new set of InventoryApplicationDriverStartAdd events will be sent. - -The following fields are available: - -- **InventoryVersion** The version of the inventory component. - ### Microsoft.Windows.Appraiser.General.InventoryApplicationFileRemove This event indicates that the InventoryApplicationFile object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -882,7 +670,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.InventoryApplicationFileStartSync -This event indicates that a new set of InventoryApplicationFileAdd events will be sent. +This event indicates indicates that a new set of InventoryApplicationFileAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -891,19 +681,21 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.InventoryLanguagePackAdd -This event sends data about the number of language packs installed on the system, to help keep Windows up-to-date. +This event sends data about the number of language packs installed on the system, to help keep Windows up to date. The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **HasLanguagePack** Does this device have 2 or more language packs? -- **LanguagePackCount** How many language packs are installed? +- **HasLanguagePack** Indicates whether this device has 2 or more language packs. +- **LanguagePackCount** The number of language packs are installed. ### Microsoft.Windows.Appraiser.General.InventoryLanguagePackRemove This event indicates that the InventoryLanguagePack object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -913,6 +705,8 @@ The following fields are available: This event indicates that a new set of InventoryLanguagePackAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -938,6 +732,8 @@ The following fields are available: This event indicates that the InventoryMediaCenter object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -947,6 +743,8 @@ The following fields are available: This event indicates that a new set of InventoryMediaCenterAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -967,7 +765,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.InventorySystemBiosRemove -This event indicates that the InventorySystemBios object is no longer present. +This event indicates that the InventorySystemBios object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -978,6 +778,8 @@ The following fields are available: This event indicates that a new set of InventorySystemBiosAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -987,29 +789,33 @@ The following fields are available: This event is only runs during setup. It provides a listing of the uplevel driver packages that were downloaded before the upgrade. Is critical to understanding if failures in setup can be traced to not having sufficient uplevel drivers before the upgrade. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. - **BootCritical** Is the driver package marked as boot critical? - **Build** The build value from the driver package. - **CatalogFile** The name of the catalog file within the driver package. -- **ClassGuid** The device class GUID from the driver package. - **Class** The device class from the driver package. +- **ClassGuid** The device class unique ID from the driver package. - **Date** The date from the driver package. -- **SignatureStatus** Indicates if the driver package is signed. Unknown:0, Unsigned:1, Signed: 2 - **Inbox** Is the driver package of a driver that is included with Windows? +- **OriginalName** The original name of the INF file before it was renamed. Generally a path under $WINDOWS.~BT\Drivers\DU. +- **Provider** The provider of the driver package. +- **PublishedName** The name of the INF file after it was renamed. +- **Revision** The revision of the driver package. +- **SignatureStatus** Indicates if the driver package is signed. Unknown = 0, Unsigned = 1, Signed = 2. - **VersionMajor** The major version of the driver package. - **VersionMinor** The minor version of the driver package. -- **OriginalName** The original name of the INF file before it was renamed. Generally a path under $WINDOWS.~BT\Drivers\DU -- **Provider** The provider of the driver package. -- **PublishedName** The name of the INF file, post-rename. -- **Revision** The revision of the driver package. ### Microsoft.Windows.Appraiser.General.InventoryUplevelDriverPackageRemove This event indicates that the InventoryUplevelDriverPackage object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1019,60 +825,25 @@ The following fields are available: This event indicates that a new set of InventoryUplevelDriverPackageAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.IsOnlineTelemetryOutputter - -This event indicates if Appraiser was able to connect successfully to Windows Update to get driver availability information. - -The following fields are available: - -- **Time** The client time of the event. -- **PCFP** A unique hardware identifier that is calculated by hashing hardware identifiers. -- **IsOnlineRun** Was the device able to connect to Windows Update to get driver availability information? - - -### Microsoft.Windows.Appraiser.General.IsOnlineWuDriverDataSource - -This event indicates if Appraiser was able to connect to Windows Update to gather driver coverage information. - -The following fields are available: - -- **Time** The client time of the event. -- **PCFP** A unique hardware identifier that is calculated by hashing hardware identifiers. -- **IsOnlineRun** Was the device able to connect to Windows Update to get driver availability information? -- **TargetVersion** The abbreviated name for the OS version against which Windows Update was queried. - - ### Microsoft.Windows.Appraiser.General.RunContext -This event indicates what should be expected in the data payload. +This event indicates what should be expected in the data payload. The following fields are available: - **AppraiserBranch** The source branch in which the currently running version of Appraiser was built. -- **AppraiserVersion** The version of the Appraiser file generating the events. -- **Context** Indicates what mode Appraiser is running in. Example: Setup or Diagnostic Data. -- **Time** The client time of the event. - **AppraiserProcess** The name of the process that launched Appraiser. +- **AppraiserVersion** The version of the Appraiser file generating the events. +- **Context** Indicates what mode Appraiser is running in. Example: Setup or Telemetry. - **PCFP** An ID for the system calculated by hashing hardware identifiers. - - -### Microsoft.Windows.Appraiser.General.SetupAdlStatus - -This event indicates if Appraiser used data files from the setup image or more up-to-date data files downloaded from a Microsoft server. - -The following fields are available: - - **Time** The client time of the event. -- **PCFP** An ID for the system calculated by hashing hardware identifiers. -- **Result** The last result of the operation to determine if there is a data file to download. -- **OneSettingsInitialized** Was the query to OneSettings, where the information is stored on if there is a data file to download, initialized? -- **Url** The URL of the data file to download. This will be an empty string if there is no data file to download. -- **UsingAlternateData** Is the client using alternate data file or using the data file in the setup image? ### Microsoft.Windows.Appraiser.General.SystemMemoryAdd @@ -1095,6 +866,8 @@ The following fields are available: This event that the SystemMemory object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1104,6 +877,8 @@ The following fields are available: This event indicates that a new set of SystemMemoryAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1122,7 +897,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemProcessorCompareExchangeRemove -This event indicates that the SystemProcessorCompareExchange object is no longer present. +This event indicates that the SystemProcessorCompareExchange object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1133,6 +910,8 @@ The following fields are available: This event indicates that a new set of SystemProcessorCompareExchangeAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1151,7 +930,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemProcessorLahfSahfRemove -This event indicates that the SystemProcessorLahfSahf object is no longer present. +This event indicates that the SystemProcessorLahfSahf object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1162,6 +943,8 @@ The following fields are available: This event indicates that a new set of SystemProcessorLahfSahfAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1183,6 +966,8 @@ The following fields are available: This event indicates that the SystemProcessorNx object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1192,6 +977,8 @@ The following fields are available: This event indicates that a new set of SystemProcessorNxAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1199,7 +986,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemProcessorPrefetchWAdd -This event sends data indicating whether the system supports the PrefetchW CPU requirement, to help keep Windows up-to-date. +This event sends data indicating whether the system supports the PrefetchW CPU requirement, to help keep Windows up to date. The following fields are available: @@ -1212,6 +999,8 @@ The following fields are available: This event indicates that the SystemProcessorPrefetchW object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1221,6 +1010,8 @@ The following fields are available: This event indicates that a new set of SystemProcessorPrefetchWAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1228,7 +1019,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemProcessorSse2Add -This event sends data indicating whether the system supports the SSE2 CPU requirement, to help keep Windows up-to-date. +This event sends data indicating whether the system supports the SSE2 CPU requirement, to help keep Windows up to date. The following fields are available: @@ -1241,6 +1032,8 @@ The following fields are available: This event indicates that the SystemProcessorSse2 object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1250,6 +1043,8 @@ The following fields are available: This event indicates that a new set of SystemProcessorSse2Add events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1257,7 +1052,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemTouchAdd -This event sends data indicating whether the system supports touch, to help keep Windows up-to-date. +This event sends data indicating whether the system supports touch, to help keep Windows up to date. The following fields are available: @@ -1268,7 +1063,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemTouchRemove -This event indicates that the SystemTouch object is no longer present. +This event indicates that the SystemTouch object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1279,6 +1076,8 @@ The following fields are available: This event indicates that a new set of SystemTouchAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1286,7 +1085,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemWimAdd -This event sends data indicating whether the operating system is running from a compressed WIM file, to help keep Windows up-to-date. +This event sends data indicating whether the operating system is running from a compressed Windows Imaging Format (WIM) file, to help keep Windows up to date. The following fields are available: @@ -1297,7 +1096,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemWimRemove -This event indicates that the SystemWim object is no longer present. +This event indicates that the SystemWim object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1308,6 +1109,8 @@ The following fields are available: This event indicates that a new set of SystemWimAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1315,7 +1118,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemWindowsActivationStatusAdd -This event sends data indicating whether the current operating system is activated, to help keep Windows up-to-date. +This event sends data indicating whether the current operating system is activated, to help keep Windows up to date. The following fields are available: @@ -1328,6 +1131,8 @@ The following fields are available: This event indicates that the SystemWindowsActivationStatus object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1337,6 +1142,8 @@ The following fields are available: This event indicates that a new set of SystemWindowsActivationStatusAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1359,7 +1166,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemWlanRemove -This event indicates that the SystemWlan object is no longer present. +This event indicates that the SystemWlan object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1370,6 +1179,8 @@ The following fields are available: This event indicates that a new set of SystemWlanAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1377,58 +1188,62 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.TelemetryRunHealth -A summary event indicating the parameters and result of a diagnostic data run. This allows the rest of the data sent over the course of the run to be properly contextualized and understood, which is then used to keep Windows up-to-date. +This event indicates the parameters and result of a telemetry (diagnostic) run. This allows the rest of the data sent over the course of the run to be properly contextualized and understood, which is then used to keep Windows up to date. The following fields are available: -- **PerfBackoff** Indicates if the run was invoked with logic to stop running when a user is present. Helps to understand why a run may have a longer elapsed time than normal. -- **RunAppraiser** Indicates if Appraiser was set to run at all. If this if false, it is understood that data events will not be received from this device. -- **ThrottlingUtc** Indicates if the Appraiser client is throttling its output of CUET events to avoid being disabled. This increases runtime but also diagnostic data reliability. -- **AuxInitial** Obsolete, indicates if Appraiser is writing data files to be read by the Get Windows 10 app. -- **Time** The client time of the event. -- **RunDate** The date that the diagnostic data run was stated, expressed as a filetime. +- **AppraiserBranch** The source branch in which the version of Appraiser that is running was built. +- **AppraiserDataVersion** The version of the data files being used by the Appraiser telemetry run. - **AppraiserProcess** The name of the process that launched Appraiser. - **AppraiserVersion** The file version (major, minor and build) of the Appraiser DLL, concatenated without dots. -- **SendingUtc** Indicates if the Appraiser client is sending events during the current diagnostic data run. +- **AuxFinal** Obsolete, always set to false. +- **AuxInitial** Obsolete, indicates if Appraiser is writing data files to be read by the Get Windows 10 app. - **DeadlineDate** A timestamp representing the deadline date, which is the time until which appraiser will wait to do a full scan. -- **AppraiserBranch** The source branch in which the version of Appraiser that is running was built. -- **EnterpriseRun** Indicates if the diagnostic data run is an enterprise run, which means appraiser was run from the command line with an extra enterprise parameter. -- **RunGeneralTel** Indicates if the generaltel.dll component was run. Generaltel collects additional diagnostic data on an infrequent schedule and only from machines at diagnostic data levels higher than Basic. -- **PerfBackoffInsurance** Indicates if appraiser is running without performance backoff because it has run with perf backoff and failed to complete several times in a row. -- **AuxFinal** Obsolete, always set to false -- **StoreHandleIsNotNull** Obsolete, always set to false -- **VerboseMode** Indicates if appraiser ran in Verbose mode, which is a test-only mode with extra logging. -- **AppraiserDataVersion** The version of the data files being used by the Appraiser diagnostic data run. +- **EnterpriseRun** Indicates if the telemetry run is an enterprise run, which means appraiser was run from the command line with an extra enterprise parameter. - **FullSync** Indicates if Appraiser is performing a full sync, which means that full set of events representing the state of the machine are sent. Otherwise, only the changes from the previous run are sent. - **InventoryFullSync** Indicates if inventory is performing a full sync, which means that the full set of events representing the inventory of machine are sent. - **PCFP** An ID for the system calculated by hashing hardware identifiers. +- **PerfBackoff** Indicates if the run was invoked with logic to stop running when a user is present. Helps to understand why a run may have a longer elapsed time than normal. +- **PerfBackoffInsurance** Indicates if appraiser is running without performance backoff because it has run with perf backoff and failed to complete several times in a row. +- **RunAppraiser** Indicates if Appraiser was set to run at all. If this if false, it is understood that data events will not be received from this device. +- **RunDate** The date that the telemetry run was stated, expressed as a filetime. +- **RunGeneralTel** Indicates if the generaltel.dll component was run. Generaltel collects additional telemetry on an infrequent schedule and only from machines at telemetry levels higher than Basic. - **RunOnline** Indicates if appraiser was able to connect to Windows Update and theefore is making decisions using up-to-date driver coverage information. -- **TelementrySent** Indicates if diagnostic data was successfully sent. +- **RunResult** The hresult of the Appraiser telemetry run. +- **SendingUtc** Indicates if the Appraiser client is sending events during the current telemetry run. +- **StoreHandleIsNotNull** Obsolete, always set to false +- **TelementrySent** Indicates if telemetry was successfully sent. +- **ThrottlingUtc** Indicates if the Appraiser client is throttling its output of CUET events to avoid being disabled. This increases runtime but also telemetry reliability. +- **Time** The client time of the event. +- **VerboseMode** Indicates if appraiser ran in Verbose mode, which is a test-only mode with extra logging. - **WhyFullSyncWithoutTablePrefix** Indicates the reason or reasons that a full sync was generated. -- **RunResult** The hresult of the Appraiser diagnostic data run. ### Microsoft.Windows.Appraiser.General.WmdrmAdd This event sends data about the usage of older digital rights management on the system, to help keep Windows up to date. This data does not indicate the details of the media using the digital rights management, only whether any such files exist. Collecting this data was critical to ensuring the correct mitigation for customers, and should be able to be removed once all mitigations are in place. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **BlockingApplication** Same as NeedsDismissAction. +- **NeedsDismissAction** Indicates if a dismissible message is needed to warn the user about a potential loss of data due to DRM deprecation. +- **WmdrmApiResult** Raw value of the API used to gather DRM state. - **WmdrmCdRipped** Indicates if the system has any files encrypted with personal DRM, which was used for ripped CDs. +- **WmdrmIndicators** WmdrmCdRipped OR WmdrmPurchased. +- **WmdrmInUse** WmdrmIndicators AND dismissible block in setup was not dismissed. - **WmdrmNonPermanent** Indicates if the system has any files with non-permanent licenses. - **WmdrmPurchased** Indicates if the system has any files with permanent licenses. -- **WmdrmApiResult** Raw value of the API used to gather DRM state. -- **WmdrmInUse** WmdrmIndicators AND dismissible block in setup was not dismissed. -- **WmdrmIndicators** WmdrmCdRipped OR WmdrmPurchased -- **NeedsDismissAction** Indicates if a dismissible message is needed to warn the user about a potential loss of data due to DRM deprecation. -- **BlockingApplication** Same as NeedsDismissAction ### Microsoft.Windows.Appraiser.General.WmdrmRemove This event indicates that the Wmdrm object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1438,6 +1253,8 @@ The following fields are available: This event indicates that a new set of WmdrmAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1451,8 +1268,8 @@ This event sends version data about the Apps running on this device, to help kee The following fields are available: -- **IEVersion** Retrieves which version of Internet Explorer is running on this device. - **CensusVersion** The version of Census that generated the current data for this device. +- **IEVersion** Retrieves which version of Internet Explorer is running on this device. ### Census.Battery @@ -1464,8 +1281,8 @@ The following fields are available: - **InternalBatteryCapablities** Represents information about what the battery is capable of doing. - **InternalBatteryCapacityCurrent** Represents the battery's current fully charged capacity in mWh (or relative). Compare this value to DesignedCapacity  to estimate the battery's wear. - **InternalBatteryCapacityDesign** Represents the theoretical capacity of the battery when new, in mWh. -- **IsAlwaysOnAlwaysConnectedCapable** Represents whether the battery enables the device to be AlwaysOnAlwaysConnected . Boolean value. - **InternalBatteryNumberOfCharges** Provides the number of battery charges. This is used when creating new products and validating that existing products meets targeted functionality performance. +- **IsAlwaysOnAlwaysConnectedCapable** Represents whether the battery enables the device to be AlwaysOnAlwaysConnected . Boolean value. ### Census.Camera @@ -1484,23 +1301,22 @@ This event sends data about Azure presence, type, and cloud domain use in order The following fields are available: -- **IsCloudDomainJoined** Is this device joined to an Azure Active Directory (AAD) tenant? true/false -- **IsMDMEnrolled** Whether the device has been MDM Enrolled or not. -- **ServerFeatures** Represents the features installed on a Windows   Server. This can be used by developers and administrators who need to automate the process of determining the features installed on a set of server computers. -- **CommercialId** Represents the GUID for the commercial entity which the device is a member of.  Will be used to reflect insights back to customers. -- **AzureVMType** Represents whether the instance is Azure VM PAAS, Azure VM IAAS or any other VMs. - **AzureOSIDPresent** Represents the field used to identify an Azure machine. -- **IsDomainJoined** Indicates whether a machine is joined to a domain. -- **HashedDomain** The hashed representation of the user domain used for login. -- **SystemCenterID** The SCCM ID is an anonymized one-way hash of the Active Directory Organization identifier -- **MPNId** Returns the Partner ID/MPN ID from Regkey. HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\DeployID -- **SCCMClientId** This ID correlate systems that send data to Compat Analytics (OMS) and other OMS based systems with systems in an Enterprise SCCM environment. +- **AzureVMType** Represents whether the instance is Azure VM PAAS, Azure VM IAAS or any other VMs. - **CDJType** Represents the type of cloud domain joined for the machine. -- **IsDeviceProtected** Represents if Device protected by BitLocker/Device Encryption -- **IsDERequirementMet** Represents if the device can do device encryption. -- **IsEDPEnabled** Represents if Enterprise data protected on the device. +- **CommercialId** Represents the GUID for the commercial entity which the device is a member of.  Will be used to reflect insights back to customers. - **ContainerType** The type of container, such as process or virtual machine hosted. -- **EnrollmentType** Represents the type of enrollment, such as MDM or Intune, for a particular device. +- **HashedDomain** The hashed representation of the user domain used for login. +- **IsCloudDomainJoined** Is this device joined to an Azure Active Directory (AAD) tenant? true/false +- **IsDERequirementMet** Represents if the device can do device encryption. +- **IsDeviceProtected** Represents if Device protected by BitLocker/Device Encryption +- **IsDomainJoined** Indicates whether a machine is joined to a domain. +- **IsEDPEnabled** Represents if Enterprise data protected on the device. +- **IsMDMEnrolled** Whether the device has been MDM Enrolled or not. +- **MPNId** Returns the Partner ID/MPN ID from Regkey. HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\DeployID +- **SCCMClientId** This ID correlate systems that send data to Compat Analytics (OMS) and other OMS based systems with systems in an Enterprise System Center Configuration Manager (SCCM) environment. +- **ServerFeatures** Represents the features installed on a Windows   Server. This can be used by developers and administrators who need to automate the process of determining the features installed on a set of server computers. +- **SystemCenterID** The SCCM ID is an anonymized one-way hash of the Active Directory Organization identifier. ### Census.Firmware @@ -1517,58 +1333,54 @@ The following fields are available: ### Census.Flighting -This event sends Windows Insider data from customers participating in improvement testing and feedback programs, to help keep Windows up-to-date. +This event sends Windows Insider data from customers participating in improvement testing and feedback programs, to help keep Windows up to date. The following fields are available: -- **FlightIds** A list of the different Windows Insider builds on this device. -- **MSA_Accounts** Represents a list of hashed IDs of the Microsoft Accounts that are flighting (pre-release builds) on this device. -- **IsFlightsDisabled** Represents if the device is participating in the Windows Insider program. -- **FlightingBranchName** The name of the Windows Insider branch currently used by the device. -- **DeviceSampleRate** The diagnostic data sample rate assigned to the device. +- **DeviceSampleRate** The telemetry sample rate assigned to the device. - **EnablePreviewBuilds** Used to enable Windows Insider builds on a device. +- **FlightIds** A list of the different Windows Insider builds on this device. +- **FlightingBranchName** The name of the Windows Insider branch currently used by the device. +- **IsFlightsDisabled** Represents if the device is participating in the Windows Insider program. +- **MSA_Accounts** Represents a list of hashed IDs of the Microsoft Accounts that are flighting (pre-release builds) on this device. - **SSRK** Retrieves the mobile targeting settings. ### Census.Hardware -This event sends data about the device, including hardware type, OEM brand, model line, model, diagnostic data level setting, and TPM support, to help keep Windows up-to-date. +This event sends data about the device, including hardware type, OEM brand, model line, model, telemetry level setting, and TPM support, to help keep Windows up to date. The following fields are available: +- **ActiveMicCount** The number of active microphones attached to the device. - **ChassisType** Represents the type of device chassis, such as desktop or low profile desktop. The possible values can range between 1 - 36. - **ComputerHardwareID** Identifies a device class that is represented by a hash of different SMBIOS fields. - **DeviceColor** Indicates a color of the device. +- **DeviceForm** Indicates the form as per the device classification. - **DeviceName** The device name that is set by the user. +- **DigitizerSupport** Is a digitizer supported? +- **DUID** The device unique ID. +- **InventoryId** The device ID used for compatibility testing. - **OEMDigitalMarkerFileName** The name of the file placed in the \Windows\system32\drivers directory that specifies the OEM and model name of the device. - **OEMManufacturerName** The device manufacturer name. The OEMName for an inactive device is not reprocessed even if the clean OEM name is changed at a later date. -- **OEMModelNumber** The device model number. +- **OEMModelBaseBoard** The baseboard model used by the OEM. +- **OEMModelBaseBoardVersion** Differentiates between developer and retail devices. - **OEMModelName** The device model name. +- **OEMModelNumber** The device model number. - **OEMModelSKU** The device edition that is defined by the manufacturer. +- **OEMModelSystemFamily** The system family set on the device by an OEM. +- **OEMModelSystemVersion** The system model version set on the device by the OEM. - **OEMOptionalIdentifier** A Microsoft assigned value that represents a specific OEM subsidiary. - **OEMSerialNumber** The serial number of the device that is set by the manufacturer. - **PhoneManufacturer** The friendly name of the phone manufacturer. -- **SoCName** The firmware manufacturer of the device. -- **DUID** The device unique ID. -- **InventoryId** The device ID used for compatibility testing. -- **VoiceSupported** Does the device have a cellular radio capable of making voice calls? - **PowerPlatformRole** The OEM preferred power management profile. It's used to help to identify the basic form factor of the device. -- **TPMVersion** The supported Trusted Platform Module (TPM) on the device. If no TPM is present, the value is 0. +- **SoCName** The firmware manufacturer of the device. - **StudyID** Used to identify retail and non-retail device. -- **TelemetryLevel** The diagnostic data level the user has opted into, such as Basic or Enhanced. -- **TelemetrySettingAuthority** Determines who set the diagnostic data level, such as GP, MDM, or the user. -- **DeviceForm** Indicates the form as per the device classification. -- **DigitizerSupport** Is a digitizer supported? -- **OEMModelBaseBoard** The baseboard model used by the OEM. -- **OEMModelSystemFamily** The system family set on the device by an OEM. -- **OEMModelBaseBoardVersion** Differentiates between developer and retail devices. -- **ActiveMicCount** The number of active microphones attached to the device. -- **OEMModelSystemVersion** The system model version set on the device by the OEM. -- **D3DMaxFeatureLevel** The supported Direct3D version. -- **Gyroscope** Indicates whether the device has a gyroscope. -- **Magnetometer** Indicates whether the device has a magnetometer. -- **NFCProximity** Indicates whether the device supports NFC. -- **TelemetryLevelLimitEnhanced** The diagnostic data level for Windows Analytics-based solutions. +- **TelemetryLevel** The telemetry level the user has opted into, such as Basic or Enhanced. +- **TelemetrySettingAuthority** Determines who set the telemetry level, such as GP, MDM, or the user. +- **TPMVersion** The supported Trusted Platform Module (TPM) on the device. If no TPM is present, the value is 0. +- **VoiceSupported** Does the device have a cellular radio capable of making voice calls? + ### Census.Memory @@ -1586,21 +1398,21 @@ This event sends data about the mobile and cellular network used by the device ( The following fields are available: +- **IMEI0** Represents the International Mobile Station Equipment Identity. This number is usually unique and used by the mobile operator to distinguish different phone hardware. Microsoft does not have access to mobile operator billing data so collecting this data does not expose or identify the user. The two fields represent phone with dual sim coverage. +- **IMEI1** Represents the International Mobile Station Equipment Identity. This number is usually unique and used by the mobile operator to distinguish different phone hardware. Microsoft does not have access to mobile operator billing data so collecting this data does not expose or identify the user. The two fields represent phone with dual sim coverage. +- **MCC0** Represents the Mobile Country Code (MCC). It used with the Mobile Network Code (MNC) to uniquely identify a mobile network operator. The two fields represent phone with dual sim coverage. +- **MCC1** Represents the Mobile Country Code (MCC). It used with the Mobile Network Code (MNC) to uniquely identify a mobile network operator. The two fields represent phone with dual sim coverage. +- **MEID** Represents the Mobile Equipment Identity (MEID). MEID is a worldwide unique phone ID assigned to CDMA phones. MEID replaces electronic serial number (ESN), and is equivalent to IMEI for GSM and WCDMA phones. Microsoft does not have access to mobile operator billing data so collecting this data does not expose or identify the user. +- **MNC0** Retrieves the Mobile Network Code (MNC). It used with the Mobile Country Code (MCC) to uniquely identify a mobile network operator. The two fields represent phone with dual sim coverage. +- **MNC1** Retrieves the Mobile Network Code (MNC). It used with the Mobile Country Code (MCC) to uniquely identify a mobile network operator. The two fields represent phone with dual sim coverage. - **MobileOperatorBilling** Represents the telephone company that provides services for mobile phone users. - **MobileOperatorCommercialized** Represents which reseller and geography the phone is commercialized for. This is the set of values on the phone for who and where it was intended to be used. For example, the commercialized mobile operator code AT&T in the US would be ATT-US. -- **NetworkCost** Represents the network cost associated with a connection. -- **IMEI0** Represents the International Mobile Station Equipment Identity. This number is usually unique and used by the mobile operator to distinguish different phone hardware. Microsoft does not have access to mobile operator billing data so collecting this data does not expose or identify the user. The two fields represent phone with dual sim coverage. -- **SPN0** Retrieves the Service Provider Name (SPN). For example, these might be AT&T, Sprint, T-Mobile, or Verizon. The two fields represent phone with dual sim coverage. - **MobileOperatorNetwork0** Represents the operator of the current mobile network that the device is used on. (AT&T, T-Mobile, Vodafone). The two fields represent phone with dual sim coverage. -- **MCC0** Represents the Mobile Country Code (MCC). It used with the Mobile Network Code (MNC) to uniquely identify a mobile network operator. The two fields represent phone with dual sim coverage. -- **MNC0** Retrieves the Mobile Network Code (MNC). It used with the Mobile Country Code (MCC) to uniquely identify a mobile network operator. The two fields represent phone with dual sim coverage. -- **IMEI1** Represents the International Mobile Station Equipment Identity. This number is usually unique and used by the mobile operator to distinguish different phone hardware. Microsoft does not have access to mobile operator billing data so collecting this data does not expose or identify the user. The two fields represent phone with dual sim coverage. -- **SPN1** Retrieves the Service Provider Name (SPN). For example, these might be AT&T, Sprint, T-Mobile, or Verizon. The two fields represent phone with dual sim coverage. - **MobileOperatorNetwork1** Represents the operator of the current mobile network that the device is used on. (AT&T, T-Mobile, Vodafone). The two fields represent phone with dual sim coverage. -- **MCC1** Represents the Mobile Country Code (MCC). It used with the Mobile Network Code (MNC) to uniquely identify a mobile network operator. The two fields represent phone with dual sim coverage. -- **MNC1** Retrieves the Mobile Network Code (MNC). It used with the Mobile Country Code (MCC) to uniquely identify a mobile network operator. The two fields represent phone with dual sim coverage. -- **MEID** Represents the Mobile Equipment Identity (MEID). MEID is a worldwide unique phone ID assigned to CDMA phones. MEID replaces electronic serial number (ESN), and is equivalent to IMEI for GSM and WCDMA phones. Microsoft does not have access to mobile operator billing data so collecting this data does not expose or identify the user. - **NetworkAdapterGUID** The GUID of the primary network adapter. +- **NetworkCost** Represents the network cost associated with a connection. +- **SPN0** Retrieves the Service Provider Name (SPN). For example, these might be AT&T, Sprint, T-Mobile, or Verizon. The two fields represent phone with dual sim coverage. +- **SPN1** Retrieves the Service Provider Name (SPN). For example, these might be AT&T, Sprint, T-Mobile, or Verizon. The two fields represent phone with dual sim coverage. ### Census.OS @@ -1609,40 +1421,39 @@ This event sends data about the operating system such as the version, locale, up The following fields are available: +- **ActivationChannel** Retrieves the retail license key or Volume license key for a machine. +- **CompactOS** Indicates if the Compact OS feature from Win10 is enabled. +- **DeveloperUnlockStatus** Represents if a device has been developer unlocked by the user or Group Policy. +- **DeviceTimeZone** The time zone that is set on the device. Example: Pacific Standard Time - **GenuineState** Retrieves the ID Value specifying the OS Genuine check. +- **InstallationType** Retrieves the type of OS installation. (Clean, Upgrade, Reset, Refresh, Update). +- **InstallLanguage** The first language installed on the user machine. +- **IsDeviceRetailDemo** Retrieves if the device is running in demo mode. +- **IsEduData** Returns Boolean if the education data policy is enabled. - **IsPortableOperatingSystem** Retrieves whether OS is running Windows-To-Go - **IsSecureBootEnabled** Retrieves whether Boot chain is signed under UEFI. -- **InstallationType** Retrieves the type of OS installation. (Clean, Upgrade, Reset, Refresh, Update). +- **LanguagePacks** The list of language packages installed on the device. +- **LicenseStateReason** Retrieves why (or how) a system is licensed or unlicensed. The HRESULT may indicate an error code that indicates a key blocked error, or it may indicate that we are running an OS License granted by the MS store. +- **OA3xOriginalProductKey** Retrieves the License key stamped by the OEM to the machine. +- **OSEdition** Retrieves the version of the current OS. - **OSInstallType** Retrieves a numeric description of what install was used on the device i.e. clean, upgrade, refresh, reset, etc - **OSOOBEDateTime** Retrieves Out of Box Experience (OOBE) Date in Coordinated Universal Time (UTC). - **OSSKU** Retrieves the Friendly Name of OS Edition. +- **OSSubscriptionStatus** Represents the existing status for enterprise subscription feature for PRO machines. +- **OSSubscriptionTypeId** Returns boolean for enterprise subscription feature for selected PRO machines. - **OSTimeZoneBiasInMins** Retrieves the time zone set on machine. - **OSUILocale** Retrieves the locale of the UI that is currently used by the OS. -- **RACw7Id** Retrieves the Microsoft Reliability Analysis Component (RAC) Win7 Identifier. RAC is used to monitor and analyze system usage and reliability. -- **CompactOS** Indicates if the Compact OS feature from Win10 is enabled. -- **Signature** Retrieves if it is a signature machine sold by Microsoft store. -- **IsDeviceRetailDemo** Retrieves if the device is running in demo mode. -- **ActivationChannel** Retrieves the retail license key or Volume license key for a machine. -- **LicenseStateReason** Retrieves why (or how) a system is licensed or unlicensed. The HRESULT may indicate an error code that indicates a key blocked error, or it may indicate that we are running an OS License granted by the MS store. -- **OA3xOriginalProductKey** Retrieves the License key stamped by the OEM to the machine. -- **ProductKeyID2** Retrieves the License key if the machine is updated with a new license key. -- **ServiceMachineIP** Retrieves the IP address of the KMS host used for anti-piracy. -- **ServiceProductKeyID** Retrieves the License key of the KMS -- **LanguagePacks** The list of language packages installed on the device. -- **InstallLanguage** The first language installed on the user machine. -- **IsEduData** Returns Boolean if the education data policy is enabled. -- **SharedPCMode** Returns Boolean for education devices used as shared cart -- **SLICVersion** Returns OS type/version from SLIC table. -- **SLICStatus** Whether a SLIC table exists on the device. -- **OSEdition** Retrieves the version of the current OS. -- **ProductActivationTime** Returns the OS Activation time for tracking piracy issues. - **ProductActivationResult** Returns Boolean if the OS Activation was successful. -- **OSSubscriptionTypeId** Returns boolean for enterprise subscription feature for selected PRO machines. -- **OSSubscriptionStatus** Represents the existing status for enterprise subscription feature for PRO machines. +- **ProductActivationTime** Returns the OS Activation time for tracking piracy issues. +- **ProductKeyID2** Retrieves the License key if the machine is updated with a new license key. +- **RACw7Id** Retrieves the Microsoft Reliability Analysis Component (RAC) Win7 Identifier. RAC is used to monitor and analyze system usage and reliability. +- **ServiceMachineIP** Retrieves the IP address of the KMS host used for anti-piracy. - **ServiceMachinePort** Retrieves the port of the KMS host used for anti-piracy. -- **DeviceTimeZone** The time zone that is set on the device. Example: Pacific Standard Time -- **DeveloperUnlockStatus** Represents if a device has been developer unlocked by the user or Group Policy. -- **AssignedAccessStatus** The kiosk configuration mode. +- **ServiceProductKeyID** Retrieves the License key of the KMS +- **SharedPCMode** Returns Boolean for education devices used as shared cart +- **Signature** Retrieves if it is a signature machine sold by Microsoft store. +- **SLICStatus** Whether a SLIC table exists on the device. +- **SLICVersion** Returns OS type/version from SLIC table. ### Census.Processor @@ -1651,19 +1462,14 @@ This event sends data about the processor (architecture, speed, number of cores, The following fields are available: -- **KvaShadow** Microcode info of the processor. -- **MMSettingOverride** Microcode setting of the processor. -- **MMSettingOverrideMask** Microcode setting override of the processor. -- **ProcessorArchitecture** Retrieves the processor architecture of the installed operating system. +- **ProcessorArchitecture** Retrieves the processor architecture of the installed operating system. - **ProcessorClockSpeed** Retrieves the clock speed of the processor in MHz. - **ProcessorCores** Retrieves the number of cores in the processor. - **ProcessorIdentifier** The processor identifier of a manufacturer. - **ProcessorManufacturer** Retrieves the name of the processor's manufacturer. - **ProcessorModel** Retrieves the name of the processor model. - **ProcessorPhysicalCores** Number of physical cores in the processor. -- **ProcessorUpdateRevision** The microcode version. - **SocketCount** Number of physical CPU sockets of the machine. -- **SpeculationControl** If the system has enabled protections needed to validate the speculation control vulnerability. ### Census.Speech @@ -1672,15 +1478,15 @@ This event is used to gather basic speech settings on the device. The following fields are available: -- **AboveLockEnabled** Cortana setting that represents if Cortana can be invoked when the device is locked. -- **GPAllowInputPersonalization** Indicates if a Group Policy setting has enabled speech functionalities. -- **HolographicSpeechInputDisabled** Holographic setting that represents if the attached HMD devices have speech functionality disabled by the user. -- **HolographicSpeechInputDisabledRemote** Indicates if a remote policy has disabled speech functionalities for the HMD devices. -- **KWSEnabled** Cortana setting that represents if a user has enabled the "Hey Cortana" keyword spotter (KWS). -- **MDMAllowInputPersonalization** Indicates if an MDM policy has enabled speech functionalities. -- **RemotelyManaged** Indicates if the device is being controlled by a remote administrator (MDM or Group Policy) in the context of speech functionalities. -- **SpeakerIdEnabled** Cortana setting that represents if keyword detection has been trained to try to respond to a single user's voice. -- **SpeechServicesEnabled** Windows setting that represents whether a user is opted-in for speech services on the device. +- **AboveLockEnabled** Cortana setting that represents if Cortana can be invoked when the device is locked. +- **GPAllowInputPersonalization** Indicates if a Group Policy setting has enabled speech functionalities. +- **HolographicSpeechInputDisabled** Holographic setting that represents if the attached HMD devices have speech functionality disabled by the user. +- **HolographicSpeechInputDisabledRemote** Indicates if a remote policy has disabled speech functionalities for the HMD devices. +- **KWSEnabled** Cortana setting that represents if a user has enabled the "Hey Cortana" keyword spotter (KWS). +- **MDMAllowInputPersonalization** Indicates if an MDM policy has enabled speech functionalities. +- **RemotelyManaged** Indicates if the device is being controlled by a remote admininistrator (MDM or Group Policy) in the context of speech functionalities. +- **SpeakerIdEnabled** Cortana setting that represents if keyword detection has been trained to try to respond to a single user's voice. +- **SpeechServicesEnabled** Windows setting that represents whether a user is opted-in for speech services on the device. ### Census.Storage @@ -1690,8 +1496,8 @@ This event sends data about the total capacity of the system volume and primary The following fields are available: - **PrimaryDiskTotalCapacity** Retrieves the amount of disk space on the primary disk of the device in MB. -- **SystemVolumeTotalCapacity** Retrieves the size of the partition that the System volume is installed on in MB. - **PrimaryDiskType** Retrieves an enumerator value of type STORAGE_BUS_TYPE that indicates the type of bus to which the device is connected. This should be used to interpret the raw device properties at the end of this structure (if any). +- **SystemVolumeTotalCapacity** Retrieves the size of the partition that the System volume is installed on in MB. ### Census.Userdefault @@ -1700,8 +1506,8 @@ This event sends data about the current user's default preferences for browser a The following fields are available: -- **DefaultBrowserProgId** The ProgramId of the current user's default browser -- **DefaultApp** The current uer's default program selected for the following extension or protocol: .html,.htm,.jpg,.jpeg,.png,.mp3,.mp4, .mov,.pdf +- **DefaultApp** The current uer's default program selected for the following extension or protocol: .html, .htm, .jpg, .jpeg, .png, .mp3, .mp4, .mov, .pdf. +- **DefaultBrowserProgId** The ProgramId of the current user's default browser. ### Census.UserDisplay @@ -1718,8 +1524,8 @@ The following fields are available: - **InternalPrimaryDisplayResolutionVertical** Retrieves the number of pixels in the vertical direction of the internal display. - **InternalPrimaryDisplaySizePhysicalH** Retrieves the physical horizontal length of the display in mm. Used for calculating the diagonal length in inches . - **InternalPrimaryDisplaySizePhysicalY** Retrieves the physical vertical length of the display in mm. Used for calculating the diagonal length in inches -- **NumberofInternalDisplays** Retrieves the number of internal displays in a machine. - **NumberofExternalDisplays** Retrieves the number of external displays connected to the machine +- **NumberofInternalDisplays** Retrieves the number of internal displays in a machine. - **VRAMDedicated** Retrieves the video RAM in MB. - **VRAMDedicatedSystem** Retrieves the amount of memory on the dedicated video card. - **VRAMSharedSystem** Retrieves the amount of RAM memory that the video card can use. @@ -1732,10 +1538,10 @@ This event sends data about the default app language, input, and display languag The following fields are available: - **DefaultAppLanguage** The current user Default App Language. -- **HomeLocation** The current user location, which is populated using GetUserGeoId() function. - **DisplayLanguage** The current user preferred Windows Display Language. -- **SpeechInputLanguages** The Speech Input languages installed on the device. +- **HomeLocation** The current user location, which is populated using GetUserGeoId() function. - **KeyboardInputLanguages** The Keyboard input languages installed on the device. +- **SpeechInputLanguages** The Speech Input languages installed on the device. ### Census.VM @@ -1744,13 +1550,11 @@ This event sends data indicating whether virtualization is enabled on the device The following fields are available: -- **VirtualizationFirmwareEnabled** Represents whether virtualization is enabled in the firmware. -- **SLATSupported** Represents whether Second Level Address Translation (SLAT) is supported by the hardware. +- **HyperVisor** Retrieves whether the current OS is running on top of a Hypervisor. - **IOMMUPresent** Represents if an input/output memory management unit (IOMMU) is present. - **IsVirtualDevice** Retrieves that when the Hypervisor is Microsoft's Hyper-V Hypervisor or other Hv#1 Hypervisor, this field will be set to FALSE for the Hyper-V host OS and TRUE for any guest OS's. This field should not be relied upon for non-Hv#1 Hypervisors. -- **HyperVisor** Retrieves whether the current OS is running on top of a Hypervisor. -- **CloudService** Indicates which cloud service, if any, that this virtual machine is running within. -- **isVDI** Is the device using Virtual Desktop Infrastructure? +- **SLATSupported** Represents whether Second Level Address Translation (SLAT) is supported by the hardware. +- **VirtualizationFirmwareEnabled** Represents whether virtualization is enabled in the firmware. ### Census.WU @@ -1759,29 +1563,23 @@ This event sends data about the Windows update server and other App store polici The following fields are available: -- **WUMachineId** Retrieves the Windows Update (WU) Machine Identifier. -- **WUServer** Retrieves the HTTP(S) URL of the WSUS server that is used by Automatic Updates and API callers (by default). -- **WUDODownloadMode** Retrieves whether DO is turned on and how to acquire/distribute updates Delivery Optimization (DO) allows users to deploy previously downloaded WU updates to other devices on the same network. -- **OSWUAutoUpdateOptions** Retrieves the auto update settings on the device. -- **AppStoreAutoUpdate** Retrieves the Appstore settings for auto upgrade. (Enable/Disabled). -- **AppStoreAutoUpdatePolicy** Retrieves the Microsoft Store App Auto Update group policy setting -- **AppStoreAutoUpdateMDM** Retrieves the App Auto Update value for MDM: 0 - Disallowed. 1 - Allowed. 2 - Not configured. Default: [2] Not configured -- **DelayUpgrade** Retrieves the Windows upgrade flag for delaying upgrades. -- **UpdateServiceURLConfigured** Retrieves if the device is managed by Windows Server Update Services (WSUS). -- **WUDeferUpgradePeriod** Retrieves if deferral is set for Upgrades -- **WUDeferUpdatePeriod** Retrieves if deferral is set for Updates -- **WUPauseState** Retrieves WU setting to determine if updates are paused -- **OSUninstalled** A flag that represents when a feature update is uninstalled on a device . -- **OSRolledBack** A flag that represents when a feature update has rolled back during setup. -- **OSRollbackCount** The number of times feature updates have rolled back on the device. -- **UninstallActive** A flag that represents when a device has uninstalled a previous upgrade recently. - **AppraiserGatedStatus** Indicates whether a device has been gated for upgrading. -- **OSAssessmentFeatureOutOfDate** How many days has it been since a the last feature update was released but the device did not install it? -- **OSAssessmentForFeatureUpdate** Is the device is on the latest feature update? -- **OSAssessmentForQualityUpdate** Is the device on the latest quality update? -- **OSAssessmentForSecurityUpdate** Is the device on the latest security update? -- **OSAssessmentQualityOutOfDate** How many days has it been since a the last quality update was released but the device did not install it? -- **OSAssessmentReleaseInfoTime** The freshness of release information used to perform an assessment. +- **AppStoreAutoUpdate** Retrieves the Appstore settings for auto upgrade. (Enable/Disabled). +- **AppStoreAutoUpdateMDM** Retrieves the App Auto Update value for MDM: 0 - Disallowed. 1 - Allowed. 2 - Not configured. Default: [2] Not configured +- **AppStoreAutoUpdatePolicy** Retrieves the Microsoft Store App Auto Update group policy setting +- **DelayUpgrade** Retrieves the Windows upgrade flag for delaying upgrades. +- **OSRollbackCount** The number of times feature updates have rolled back on the device. +- **OSRolledBack** A flag that represents when a feature update has rolled back during setup. +- **OSUninstalled** A flag that represents when a feature update is uninstalled on a device . +- **OSWUAutoUpdateOptions** Retrieves the auto update settings on the device. +- **UninstallActive** A flag that represents when a device has uninstalled a previous upgrade recently. +- **UpdateServiceURLConfigured** Retrieves if the device is managed by Windows Server Update Services (WSUS). +- **WUDeferUpdatePeriod** Retrieves if deferral is set for Updates. +- **WUDeferUpgradePeriod** Retrieves if deferral is set for Upgrades. +- **WUDODownloadMode** Retrieves whether DO is turned on and how to acquire/distribute updates Delivery Optimization (DO) allows users to deploy previously downloaded WU updates to other devices on the same network. +- **WUMachineId** Retrieves the Windows Update (WU) Machine Identifier. +- **WUPauseState** Retrieves WU setting to determine if updates are paused. +- **WUServer** Retrieves the HTTP(S) URL of the WSUS server that is used by Automatic Updates and API callers (by default). ### Census.Xbox @@ -1790,66 +1588,211 @@ This event sends data about the Xbox Console, such as Serial Number and DeviceId The following fields are available: -- **XboxLiveDeviceId** Retrieves the unique device id of the console. -- **XboxConsoleSerialNumber** Retrieves the serial number of the Xbox console. -- **XboxLiveSandboxId** Retrieves the developer sandbox id if the device is internal to MS. - **XboxConsolePreferredLanguage** Retrieves the preferred language selected by the user on Xbox console. +- **XboxConsoleSerialNumber** Retrieves the serial number of the Xbox console. +- **XboxLiveDeviceId** Retrieves the unique device ID of the console. +- **XboxLiveSandboxId** Retrieves the developer sandbox ID if the device is internal to Microsoft. -### Census.Security -This event provides information on about security settings used to help keep Windows up-to-date and secure. +## Common data extensions + +### Common Data Extensions.app + +Describes the properties of the running application. This extension could be populated by a client app or a web app. + +The following fields are available: + +- **asId** An integer value that represents the app session. This value starts at 0 on the first app launch and increments after each subsequent app launch per boot session. +- **env** The environment from which the event was logged. +- **expId** Associates a flight, such as an OS flight, or an experiment, such as a web site UX experiment, with an event. +- **id** Represents a unique identifier of the client application currently loaded in the process producing the event; and is used to group events together and understand usage pattern, errors by application. +- **userId** The userID as known by the application. +- **ver** Represents the version number of the application. Used to understand errors by Version, Usage by Version across an app. + + +### Common Data Extensions.container + +Describes the properties of the container for events logged within a container. + +The following fields are available: + +- **localId** The device ID as known by the client. +- **osVer** The operating system version. +- **type** The container type. Examples: Process or VMHost + + +### Common Data Extensions.cs + +Describes properties related to the schema of the event. + +The following fields are available: + +- **sig** A common schema signature that identifies new and modified event schemas. + + +### Common Data Extensions.device + +Describes the device-related fields. + +The following fields are available: + +- **deviceClass** Represents the classification of the device, the device “family”. For example, Desktop, Server, or Mobile. +- **localId** Represents a locally defined unique ID for the device, not the human readable device name. Most likely equal to the value stored at HKLM\Software\Microsoft\SQMClient\MachineId + + +### Common Data Extensions.Envelope + +Represents an envelope that contains all of the common data extensions. + +The following fields are available: + +- **appId** Represents a unique identifier of the client application currently loaded in the process producing the event; and is used to group events together and understand usage pattern, errors by application. +- **appVer** Represents the version number of the application. Used to understand errors by version and usage by version across an app. +- **cV** Represents the Correlation Vector: A single field for tracking partial order of related telemetry events across component boundaries. +- **data** Represents the optional unique diagnostic data for a particular event schema. +- **epoch** ID used to help distinguish events in the sequence by indicating the current boot session. +- **ext_app** Describes the properties of the running application. This extension could be populated by either a client app or a web app. See [Common Data Extensions.app](#common-data-extensionsapp). +- **ext_container** Describes the properties of the container for events logged within a container. See [Common Data Extensions.container](#common-data-extensionscontainer). +- **ext_cs** Describes properties related to the schema of the event. See [Common Data Extensions.cs](#common-data-extensionscs). +- **ext_device** Describes the device-related fields. See [Common Data Extensions.device](#common-data-extensionsdevice). +- **ext_os** Describes the operating system properties that would be populated by the client. See [Common Data Extensions.os](#common-data-extensionsos). +- **ext_user** Describes the fields related to a user. See [Common Data Extensions.user](#common-data-extensionsuser). +- **ext_utc** Describes the fields that might be populated by a logging library on Windows. See [Common Data Extensions.utc](#common-data-extensionsutc). +- **ext_xbl** Describes the fields related to XBOX Live. See [Common Data Extensions.xbl](#common-data-extensionsxbl). +- **flags** Represents a collection of bits that describe how the event should be processed by the Connected User Experience and Telemetry component pipeline. The lowest-order byte is the event persistence. The next byte is the event latency. +- **iKey** Represents an ID for applications or other logical groupings of events. +- **name** Represents the uniquely qualified name for the event. +- **os** The operating system name. +- **osVer** The operating system version. +- **popSample** Represents the effective sample rate for this event at the time it was generated by a client. +- **seqNum** Used to track the absolute order of uploaded events. +- **tags** A header for semi-managed extensions. +- **time** Represents the event date time in Coordinated Universal Time (UTC) when the event was generated on the client. This should be in ISO 8601 format. +- **ver** Represents the major and minor version of the extension. + + +### Common Data Extensions.os + +Describes some properties of the operating system. + +The following fields are available: + +- **bootId** An integer value that represents the boot session. This value starts at 0 on first boot after OS install and increments after every reboot. +- **expId** Represents the experiment ID. The standard for associating a flight, such as an OS flight (pre-release build), or an experiment, such as a web site UX experiment, with an event is to record the flight / experiment IDs in Part A of the common schema. +- **locale** Represents the locale of the operating system. + + +### Common Data Extensions.user + +Describes the fields related to a user. + +The following fields are available: + +- **authId** This is an ID of the user associated with this event that is deduced from a token such as a Microsoft Account ticket or an XBOX token. +- **localId** Represents a unique user identity that is created locally and added by the client. This is not the user's account ID. + + +### Common Data Extensions.utc + +Describes the properties that could be populated by a logging library on Windows. + +The following fields are available: + +- **aId** Represents the ETW ActivityId. Logged via TraceLogging or directly via ETW. +- **bSeq** Upload buffer sequence number in the format: buffer identifier:sequence number +- **cat** Represents a bitmask of the ETW Keywords associated with the event. +- **cpId** The composer ID, such as Reference, Desktop, Phone, Holographic, Hub, IoT Composer. +- **flags** Represents the bitmap that captures various Windows specific flags. +- **mon** Combined monitor and event sequence numbers in the format: monitor sequence : event sequence +- **op** Represents the ETW Op Code. +- **raId** Represents the ETW Related ActivityId. Logged via TraceLogging or directly via ETW. +- **sqmId** The Windows SQM ID. +- **stId** Represents the Scenario Entry Point ID. This is a unique GUID for each event in a diagnostic scenario. This used to be Scenario Trigger ID. +- **tickets** An array of strings that refer back to a key in the X-Tickets http header that the client uploaded along with a batch of events. + + +### Common Data Extensions.xbl + +Describes the fields that are related to XBOX Live. + +The following fields are available: + +- **claims** Any additional claims whose short claim name hasn't been added to this structure. +- **did** XBOX device ID +- **dty** XBOX device type +- **dvr** The version of the operating system on the device. +- **eid** A unique ID that represents the developer entity. +- **exp** Expiration time +- **ip** The IP address of the client device. +- **nbf** Not before time +- **pid** A comma separated list of PUIDs listed as base10 numbers. +- **sbx** XBOX sandbox identifier +- **sid** The service instance ID. +- **sty** The service type. +- **tid** The XBOX Live title ID. +- **tvr** The XBOX Live title version. +- **uts** A bit field, with 2 bits being assigned to each user ID listed in xid. This field is omitted if all users are retail accounts. +- **xid** A list of base10-encoded XBOX User IDs. + + +## Common data fields + +### Ms.Device.DeviceInventoryChange + +Describes the installation state for all hardware and software components available on a particular device. + +The following fields are available: + +- **action** The change that was invoked on a device inventory object. +- **inventoryId** Device ID used for Compatibility testing +- **objectInstanceId** Object identity which is unique within the device scope. +- **objectType** Indicates the object type that the event applies to. +- **syncId** A string used to group StartSync, EndSync, Add, and Remove operations that belong together. This field is unique by Sync period and is used to disambiguate in situations where multiple agents perform overlapping inventories for the same object. -- **AvailableSecurityProperties** Enumerates and reports state on the relevant security properties for Device Guard. -- **CGRunning** Is Credential Guard running? -- **DGState** A summary of the Device Guard state. -- **HVCIRunning** Is HVCI running? -- **RequiredSecurityProperties** Describes the required security properties to enable virtualization-based security. -- **SecureBootCapable** Is this device capable of running Secure Boot? -- **VBSState** Is virtualization-based security enabled, disabled, or running? ## Diagnostic data events ### TelClientSynthetic.AuthorizationInfo_RuntimeTransition -This event sends data indicating that a device has undergone a change of diagnostic data opt-in level during the runtime of the device (not at UTC boot or offline), to help keep Windows up to date. +This event sends data indicating that a device has undergone a change of telemetry opt-in level detected at UTC startup, to help keep Windows up to date. The telemetry opt-in level signals what data we are allowed to collect. The following fields are available: -- **CanAddMsaToMsTelemetry** True if UTC is allowed to add MSA user identity onto diagnostic data from the OS provider groups. -- **CanCollectAnyTelemetry** True if UTC is allowed to collect non-OS diagnostic data. Non-OS diagnostic data is responsible for providing its own opt-in mechanism. +- **CanAddMsaToMsTelemetry** True if UTC is allowed to add MSA user identity onto telemetry from the OS provider groups. +- **CanCollectAnyTelemetry** True if UTC is allowed to collect non-OS telemetry. Non-OS telemetry is responsible for providing its own opt-in mechanism. - **CanCollectCoreTelemetry** True if UTC is allowed to collect data which is tagged with both MICROSOFT_KEYWORD_CRITICAL_DATA and MICROSOFT_EVENTTAG_CORE_DATA. - **CanCollectHeartbeats** True if UTC is allowed to collect heartbeats. -- **CanCollectOsTelemetry** True if UTC is allowed to collect diagnostic data from the OS provider groups. +- **CanCollectOsTelemetry** True if UTC is allowed to collect telemetry from the OS provider groups (often called Microsoft Telemetry). - **CanPerformDiagnosticEscalations** True if UTC is allowed to perform all scenario escalations. - **CanPerformScripting** True if UTC is allowed to perform scripting. - **CanPerformTraceEscalations** True if UTC is allowed to perform scenario escalations with tracing actions. - **CanReportScenarios** True if UTC is allowed to load and report scenario completion, failure, and cancellation events. -- **TransitionFromEverythingOff** True if this transition is moving from not allowing core diagnostic data to allowing core diagnostic data. -- **PreviousPermissions** Bitmask representing the previously configured permissions since the diagnostic data opt-in level was last changed. +- **PreviousPermissions** Bitmask representing the previously configured permissions since the telemetry opt-in level was last changed. +- **TransitionFromEverythingOff** True if this transition is moving from not allowing core telemetry to allowing core telemetry. ### TelClientSynthetic.AuthorizationInfo_Startup -This event sends data indicating that a device has undergone a change of diagnostic data opt-in level detected at UTC startup, to help keep Windows up to date. +This event sends data indicating that a device has undergone a change of telemetry opt-in level detected at UTC startup, to help keep Windows up to date. The telemetry opt-in level signals what data we are allowed to collect. The following fields are available: -- **TransitionFromEverythingOff** True if this transition is moving from not allowing core diagnostic data to allowing core diagnostic data. -- **CanCollectAnyTelemetry** True if UTC is allowed to collect non-OS diagnostic data. Non-OS diagnostic data is responsible for providing its own opt-in mechanism. -- **CanCollectHeartbeats** True if UTC is allowed to collect heartbeats. +- **CanAddMsaToMsTelemetry** True if UTC is allowed to add MSA user identity onto telemetry from the OS provider groups. +- **CanCollectAnyTelemetry** True if UTC is allowed to collect non-OS telemetry. Non-OS telemetry is responsible for providing its own opt-in mechanism. - **CanCollectCoreTelemetry** True if UTC is allowed to collect data which is tagged with both MICROSOFT_KEYWORD_CRITICAL_DATA and MICROSOFT_EVENTTAG_CORE_DATA. -- **CanCollectOsTelemetry** True if UTC is allowed to collect diagnostic data from the OS provider groups. -- **CanReportScenarios** True if UTC is allowed to load and report scenario completion, failure, and cancellation events. -- **CanAddMsaToMsTelemetry** True if UTC is allowed to add MSA user identity onto diagnostic data from the OS provider groups. -- **CanPerformTraceEscalations** True if UTC is allowed to perform scenario escalations with tracing actions. +- **CanCollectHeartbeats** True if UTC is allowed to collect heartbeats. +- **CanCollectOsTelemetry** True if UTC is allowed to collect telemetry from the OS provider groups (often called Microsoft Telemetry). - **CanPerformDiagnosticEscalations** True if UTC is allowed to perform all scenario escalations. - **CanPerformScripting** True if UTC is allowed to perform scripting. -- **PreviousPermissions** Bitmask representing the previously configured permissions since the diagnostic data client was last started. +- **CanPerformTraceEscalations** True if UTC is allowed to perform scenario escalations with tracing actions. +- **CanReportScenarios** True if UTC is allowed to load and report scenario completion, failure, and cancellation events. +- **PreviousPermissions** Bitmask representing the previously configured permissions since the telemetry client was last started. +- **TransitionFromEverythingOff** True if this transition is moving from not allowing core telemetry to allowing core telemetry. ### TelClientSynthetic.ConnectivityHeartBeat_0 -This event sends data about the connectivity status of the Connected User Experiences and Telemetry component that uploads diagnostic data events. If an unrestricted free network (such as Wi-Fi) is available, this event updates the last successful upload time. Otherwise, it checks whether a Connectivity Heartbeat event was fired in the past 24 hours, and if not, it fires an event. A Connectivity Heartbeat event also fires when a device recovers from costed network to free network. +This event sends data about the connectivity status of the Connected User Experience and Telemetry component that uploads telemetry events. If an unrestricted free network (such as Wi-Fi) is available, this event updates the last successful upload time. Otherwise, it checks whether a Connectivity Heartbeat event was fired in the past 24 hours, and if not, it fires an event. A Connectivity Heartbeat event also fires when a device recovers from costed network to free network. The following fields are available: @@ -1857,10 +1800,10 @@ The following fields are available: - **CensusStartTime** Returns timestamp corresponding to last successful census run. - **CensusTaskEnabled** Returns Boolean value for the census task (Enable/Disable) on client machine. - **LastConnectivityLossTime** Retrieves the last time the device lost free network. +- **LastConntectivityLossTime** Retrieves the last time the device lost free network. - **NetworkState** Retrieves the network state: 0 = No network. 1 = Restricted network. 2 = Free network. - **NoNetworkTime** Retrieves the time spent with no network (since the last time) in seconds. - **RestrictedNetworkTime** Retrieves the time spent on a metered (cost restricted) network in seconds. -- **LastConntectivityLossTime** Retrieves the last time the device lost free network. ### TelClientSynthetic.HeartBeat_5 @@ -1869,51 +1812,41 @@ This event sends data about the health and quality of the diagnostic data from t The following fields are available: -- **PreviousHeartBeatTime** The time of last heartbeat event. This allows chaining of events. -- **EtwDroppedCount** The number of events dropped by the ETW layer of the diagnostic data client. -- **ConsumerDroppedCount** The number of events dropped by the consumer layer of the diagnostic data client. -- **DecodingDroppedCount** The number of events dropped because of decoding failures. -- **ThrottledDroppedCount** The number of events dropped due to throttling of noisy providers. -- **DbDroppedCount** The number of events that were dropped because the database was full. -- **EventSubStoreResetCounter** The number of times the event database was reset. -- **EventSubStoreResetSizeSum** The total size of the event database across all resets reports in this instance. -- **CriticalOverflowEntersCounter** The number of times a critical overflow mode was entered into the event database. -- **EnteringCriticalOverflowDroppedCounter** The number of events that was dropped because a critical overflow mode was initiated. -- **UploaderDroppedCount** The number of events dropped by the uploader layer of the diagnostic data client. -- **InvalidHttpCodeCount** The number of invalid HTTP codes received from Vortex. -- **LastInvalidHttpCode** The last invalid HTTP code received from Vortex. -- **MaxInUseScenarioCounter** The soft maximum number of scenarios loaded by the Connected User Experiences and Telemetry component. -- **LastEventSizeOffender** The name of the last event that exceeded the maximum event size. -- **SettingsHttpAttempts** The number of attempts to contact the OneSettings service. -- **SettingsHttpFailures** The number of failures from contacting the OneSettings service. -- **VortexHttpAttempts** The number of attempts to contact the Vortex service. -- **EventsUploaded** The number of events that have been uploaded. -- **DbCriticalDroppedCount** The total number of dropped critical events in the event database. -- **VortexHttpFailures4xx** The number of 400-499 error codes received from Vortex. -- **VortexHttpFailures5xx** The number of 500-599 error codes received from Vortex. -- **VortexFailuresTimeout** The number of timeout failures received from Vortex. -- **HeartBeatSequenceNumber** A monotonically increasing heartbeat counter. -- **EtwDroppedBufferCount** The number of buffers dropped in the CUET ETW session. -- **FullTriggerBufferDroppedCount** The number of events that were dropped because the trigger buffer was full. -- **CriticalDataThrottleDroppedCount** The number of critical data sampled events that were dropped because of throttling. -- **CriticalDataDbDroppedCount** The number of critical data sampled events that were dropped at the database layer. -- **MaxActiveAgentConnectionCount** The maximum number of active agents during this heartbeat timeframe. - **AgentConnectionErrorsCount** The number of non-timeout errors associated with the host/agent channel. -- **LastAgentConnectionError** The last non-timeout error that happened in the host/agent channel. -- **Flags** Flags that indicate device state, such as network, battery, and opt-in state. -- **CensusTaskEnabled** Indicates whether Census is enabled. - **CensusExitCode** The last exit code of the Census task. - **CensusStartTime** The time of the last Census run. - - -### TelClientSynthetic.PrivacySettingsAfterCreatorsUpdate - -This event sends basic data on privacy settings before and after a feature update. This is used to ensure that customer privacy settings are correctly migrated across feature updates. - -The following fields are available: - -- **PostUpgradeSettings** The privacy settings after a feature update. -- **PreUpgradeSettings** The privacy settings before a feature update. +- **CensusTaskEnabled** Indicates whether Census is enabled. +- **ConsumerDroppedCount** The number of events dropped by the consumer layer of the telemetry client. +- **CriticalDataDbDroppedCount** The number of critical data sampled events that were dropped at the database layer. +- **CriticalDataThrottleDroppedCount** The number of critical data sampled events that were dropped because of throttling. +- **CriticalOverflowEntersCounter** The number of times a critical overflow mode was entered into the event database. +- **DbCriticalDroppedCount** The total number of dropped critical events in the event database. +- **DbDroppedCount** The number of events that were dropped because the database was full. +- **DecodingDroppedCount** The number of events dropped because of decoding failures. +- **EnteringCriticalOverflowDroppedCounter** The number of events that was dropped because a critical overflow mode was initiated. +- **EtwDroppedBufferCount** The number of buffers dropped in the CUET ETW session. +- **EtwDroppedCount** The number of events dropped by the ETW layer of the telemetry client. +- **EventSubStoreResetCounter** The number of times the event database was reset. +- **EventSubStoreResetSizeSum** The total size of the event database across all resets reports in this instance. +- **EventsUploaded** The number of events that have been uploaded. +- **Flags** Flags that indicate device state, such as network, battery, and opt-in state. +- **FullTriggerBufferDroppedCount** The number of events that were dropped because the trigger buffer was full. +- **HeartBeatSequenceNumber** A monotonically increasing heartbeat counter. +- **InvalidHttpCodeCount** The number of invalid HTTP codes received from Vortex. +- **LastAgentConnectionError** The last non-timeout error that happened in the host/agent channel. +- **LastEventSizeOffender** The name of the last event that exceeded the maximum event size. +- **LastInvalidHttpCode** The last invalid HTTP code received from Vortex. +- **MaxActiveAgentConnectionCount** The maximum number of active agents during this heartbeat timeframe. +- **MaxInUseScenarioCounter** The soft maximum number of scenarios loaded by the Connected User Experience and Telemetry component. +- **PreviousHeartBeatTime** The time of last heartbeat event. This allows chaining of events. +- **SettingsHttpAttempts** The number of attempts to contact the OneSettings service. +- **SettingsHttpFailures** The number of failures from contacting the OneSettings service. +- **ThrottledDroppedCount** The number of events dropped due to throttling of noisy providers. +- **UploaderDroppedCount** The number of events dropped by the uploader layer of the telemetry client. +- **VortexFailuresTimeout** The number of timeout failures received from Vortex. +- **VortexHttpAttempts** The number of attempts to contact the Vortex service. +- **VortexHttpFailures4xx** The number of 400-499 error codes received from Vortex. +- **VortexHttpFailures5xx** The number of 500-599 error codes received from Vortex. ## DxgKernelTelemetry events @@ -1924,72 +1857,80 @@ This event sends basic GPU and display driver information to keep Windows and di The following fields are available: -- **version** The event version. -- **bootId** The system boot ID. - **aiSeqId** The event sequence ID. -- **MeasureEnabled** Is the device listening to MICROSOFT_KEYWORD_MEASURES? -- **TelemetryEnabled** Is the device listening to MICROSOFT_KEYWORD_TELEMETRY? -- **InterfaceId** The GPU interface ID. -- **GPUVendorID** The GPU vendor ID. -- **GPUDeviceID** The GPU device ID. -- **SubVendorID** The GPU sub vendor ID. -- **SubSystemID** The subsystem ID. -- **GPURevisionID** The GPU revision ID. -- **DriverVersion** The display driver version. +- **bootId** The system boot ID. +- **ComputePreemptionLevel** The maximum preemption level supported by GPU for compute payload. +- **DedicatedSystemMemoryB** The amount of system memory dedicated for GPU use (in bytes). +- **DedicatedVideoMemoryB** The amount of dedicated VRAM of the GPU (in bytes). +- **DisplayAdapterLuid** The display adapter LUID. - **DriverDate** The date of the display driver. - **DriverRank** The rank of the display driver. -- **IsMiracastSupported** Does the GPU support Miracast? -- **IsMsMiracastSupported** Are the GPU Miracast capabilities driven by a Microsoft solution? +- **DriverVersion** The display driver version. +- **GPUDeviceID** The GPU device ID. +- **GPUPreemptionLevel** The maximum preemption level supported by GPU for graphics payload. +- **GPURevisionID** The GPU revision ID. +- **GPUVendorID** The GPU vendor ID. +- **InterfaceId** The GPU interface ID. +- **IsDisplayDevice** Does the GPU have displaying capabilities? - **IsHybridDiscrete** Does the GPU have discrete GPU capabilities in a hybrid device? - **IsHybridIntegrated** Does the GPU have integrated GPU capabilities in a hybrid device? -- **IsMPOSupported** Does the GPU support Multi-Plane Overlays? - **IsLDA** Is the GPU comprised of Linked Display Adapters? +- **IsMiracastSupported** Does the GPU support Miracast? - **IsMismatchLDA** Is at least one device in the Linked Display Adapters chain from a different vendor? +- **IsMPOSupported** Does the GPU support Multi-Plane Overlays? +- **IsMsMiracastSupported** Are the GPU Miracast capabilities driven by a Microsoft solution? - **IsPostAdapter** Is this GPU the POST GPU in the device? -- **IsSoftwareDevice** Is this a software implementation of the GPU? - **IsRenderDevice** Does the GPU have rendering capabilities? -- **IsDisplayDevice** Does the GPU have displaying capabilities? -- **WDDMVersion** The Windows Display Driver Model version. -- **DisplayAdapterLuid** The display adapter LUID. -- **GPUPreemptionLevel** The maximum preemption level supported by GPU for graphics payload. -- **ComputePreemptionLevel** The maximum preemption level supported by GPU for compute payload. -- **TelInvEvntTrigger** What triggered this event to be logged? Example: 0 (GPU enumeration) or 1 (DxgKrnlTelemetry provider toggling) -- **DedicatedVideoMemoryB** The amount of dedicated VRAM of the GPU (in bytes). -- **DedicatedSystemMemoryB** The amount of system memory dedicated for GPU use (in bytes). -- **SharedSystemMemoryB** The amount of system memory shared by GPU and CPU (in bytes). +- **IsSoftwareDevice** Is this a software implementation of the GPU? +- **MeasureEnabled** Is the device listening to MICROSOFT_KEYWORD_MEASURES? - **NumVidPnSources** The number of supported display output sources. - **NumVidPnTargets** The number of supported display output targets. +- **SharedSystemMemoryB** The amount of system memory shared by GPU and CPU (in bytes). +- **SubSystemID** The subsystem ID. +- **SubVendorID** The GPU sub vendor ID. +- **TelemetryEnabled** Is the device listening to MICROSOFT_KEYWORD_TELEMETRY? +- **TelInvEvntTrigger** What triggered this event to be logged? Example: 0 (GPU enumeration) or 1 (DxgKrnlTelemetry provider toggling) +- **version** The event version. +- **WDDMVersion** The Windows Display Driver Model version. ## Fault Reporting events ### Microsoft.Windows.FaultReporting.AppCrashEvent -This event sends data about crashes for both native and managed applications, to help keep Windows up to date. The data includes information about the crashing process and a summary of its exception record. It does not contain any Watson bucketing information. The bucketing information is recorded in a Windows Error Reporting (WER) event that is generated when the WER client reports the crash to the Watson service, and the WER event will contain the same ReportID (see field 14 of crash event, field 19 of WER event) as the crash event for the crash being reported. AppCrash is emitted once for each crash handled by WER (e.g. from an unhandled exception or FailFast or ReportException). Note that Generic Watson event types (e.g. from PLM) that may be considered crashes" by a user DO NOT emit this event. +This event sends data about crashes for both native and managed applications, to help keep Windows up to date. The data includes information about the crashing process and a summary of its exception record. It does not contain any Watson bucketing information. The bucketing information is recorded in a Windows Error Reporting (WER) event that is generated when the WER client reports the crash to the Watson service, and the WER event will contain the same ReportID (see field 14 of crash event, field 19 of WER event) as the crash event for the crash being reported. AppCrash is emitted once for each crash handled by WER (e.g. from an unhandled exception or FailFast or ReportException). Note that Generic Watson event types (e.g. from PLM) that may be considered crashes\" by a user DO NOT emit this event. The following fields are available: -- **ProcessId** The ID of the process that has crashed. -- **ProcessCreateTime** The time of creation of the process that has crashed. +- **AppName** The name of the app that has crashed. +- **AppSessionGuid** GUID made up of process ID and is used as a correlation vector for process instances in the telemetry backend. +- **AppTimeStamp** The date/time stamp of the app. +- **AppVersion** The version of the app that has crashed. - **ExceptionCode** The exception code returned by the process that has crashed. - **ExceptionOffset** The address where the exception had occurred. -- **AppName** The name of the app that has crashed. -- **AppVersion** The version of the app that has crashed. -- **AppTimeStamp** The date/time stamp of the app. +- **Flags** Flags indicating how reporting is done. For example, queue the report, do not offer JIT debugging, or do not terminate the process after reporting. - **ModName** Exception module name (e.g. bar.dll). -- **ModVersion** The version of the module that has crashed. - **ModTimeStamp** The date/time stamp of the module. +- **ModVersion** The version of the module that has crashed. - **PackageFullName** Store application identity. - **PackageRelativeAppId** Store application identity. - **ProcessArchitecture** Architecture of the crashing process, as one of the PROCESSOR_ARCHITECTURE_* constants: 0: PROCESSOR_ARCHITECTURE_INTEL. 5: PROCESSOR_ARCHITECTURE_ARM. 9: PROCESSOR_ARCHITECTURE_AMD64. 12: PROCESSOR_ARCHITECTURE_ARM64. +- **ProcessCreateTime** The time of creation of the process that has crashed. +- **ProcessId** The ID of the process that has crashed. - **ReportId** A GUID used to identify the report. This can used to track the report across Watson. -- **Flags** Flags indicating how reporting is done. For example, queue the report, do not offer JIT debugging, or do not terminate the process after reporting. -- **AppSessionGuid** GUID made up of process ID and is used as a correlation vector for process instances in the diagnostic data backend. - **TargetAppId** The kernel reported AppId of the application being reported. - **TargetAppVer** The specific version of the application being reported - **TargetAsId** The sequence number for the hanging process. +## Feature update events + +### Microsoft.Windows.Upgrade.Uninstall.UninstallGoBackButtonClicked + +This event sends basic metadata about the starting point of uninstalling a feature update, which helps ensure customers can safely revert to a well-known state if the update caused any problems. + + + ## Hang Reporting events ### Microsoft.Windows.HangReporting.AppHangEvent @@ -1999,52 +1940,110 @@ This event sends data about hangs for both native and managed applications, to h The following fields are available: - **AppName** The name of the app that has hung. -- **TypeCode** Bitmap describing the hang type. -- **ProcessId** The ID of the process that has hung. -- **UTCReplace_TargetAppId** The kernel reported AppId of the application being reported. -- **ProcessCreateTime** The time of creation of the process that has hung. -- **UTCReplace_TargetAppVer** The specific version of the application being reported. -- **WaitingOnAppName** If this is a cross process hang waiting for an application, this has the name of the application. +- **AppSessionGuid** GUID made up of process id used as a correlation vector for process instances in the telemetry backend. +- **AppVersion** The version of the app that has hung. +- **PackageFullName** Store application identity. - **PackageRelativeAppId** Store application identity. - **ProcessArchitecture** Architecture of the hung process, as one of the PROCESSOR_ARCHITECTURE_* constants: 0: PROCESSOR_ARCHITECTURE_INTEL. 5: PROCESSOR_ARCHITECTURE_ARM. 9: PROCESSOR_ARCHITECTURE_AMD64. 12: PROCESSOR_ARCHITECTURE_ARM64. -- **WaitingOnPackageRelativeAppId** If this is a cross process hang waiting for a package, this has the relative application id of the package. -- **WaitingOnAppVersion** If this is a cross process hang, this has the version of the application for which it is waiting. -- **AppSessionGuid** GUID made up of process id used as a correlation vector for process instances in the diagnostic data backend. -- **WaitingOnPackageFullName** If this is a cross process hang waiting for a package, this has the full name of the package for which it is waiting. -- **PackageFullName** Store application identity. -- **AppVersion** The version of the app that has hung. +- **ProcessCreateTime** The time of creation of the process that has hung. +- **ProcessId** The ID of the process that has hung. - **ReportId** A GUID used to identify the report. This can used to track the report across Watson. - **TargetAppId** The kernel reported AppId of the application being reported. - **TargetAppVer** The specific version of the application being reported. - **TargetAsId** The sequence number for the hanging process. +- **TypeCode** Bitmap describing the hang type. +- **WaitingOnAppName** If this is a cross process hang waiting for an application, this has the name of the application. +- **WaitingOnAppVersion** If this is a cross process hang, this has the version of the application for which it is waiting. +- **WaitingOnPackageFullName** If this is a cross process hang waiting for a package, this has the full name of the package for which it is waiting. +- **WaitingOnPackageRelativeAppId** If this is a cross process hang waiting for a package, this has the relative application id of the package. ## Inventory events +### ChecksumDictionary + +The list of values sent by each object type. + +The following fields are available: + +- **Key** The object type being described. +- **Value** The number of objects of this type that were sent. + + +### COMPID + +This event provides a device's internal application compatible ID, a vendor-defined identification that Windows uses to match a device to an INF file. A device can have a list of compatible IDs associated with it. + +The following fields are available: + +- **Order** The index of the array of compatible IDs for the device. +- **Value** The array of compatible IDs for the device. + + +### HWID + +This event provides a device's internal hardware ID, a vendor-defined identification that Windows uses to match a device to an INF file. In most cases, a device has associated with it a list of hardware IDs. + +The following fields are available: + +- **Order** The index of the array of internal hardware IDs for the device. +- **Value** The array of internal hardware IDs for the device. + + +### InstallDateArpLastModified + +This event indicates the date the add/remove program (ARP) entry was last modified by an update. + +The following fields are available: + +- **Order** The index of the ordered array. +- **Value** The value contained in the ordered array. + + +### InstallDateFromLinkFile + +This event provides the application installation date from the linked file. + +The following fields are available: + +- **Order** The index of the ordered array. +- **Value** The value contained in the ordered array. + + +### InstallDateMsi + +The install date from the Microsoft installer (MSI) database. + +The following fields are available: + +- **Order** The index of the ordered array. +- **Value** The value contained in the ordered array. + + ### Microsoft.Windows.Inventory.Core.AmiTelCacheChecksum This event captures basic checksum data about the device inventory items stored in the cache for use in validating data completeness for Microsoft.Windows.Inventory.Core events. The fields in this event may change over time, but they will always represent a count of a given object. The following fields are available: -- **Device** A count of device objects in cache -- **DeviceCensus** A count of devicecensus objects in cache -- **DriverPackageExtended** A count of driverpackageextended objects in cache -- **File** A count of file objects in cache -- **Generic** A count of generic objects in cache -- **HwItem** A count of hwitem objects in cache -- **InventoryApplication** A count of application objects in cache -- **InventoryApplicationFile** A count of application file objects in cache -- **InventoryDeviceContainer** A count of device container objects in cache -- **InventoryDeviceMediaClass** A count of device media objects in cache -- **InventoryDevicePnp** A count of devicepnp objects in cache -- **InventoryDriverBinary** A count of driver binary objects in cache -- **InventoryDriverPackage** A count of device objects in cache -- **Metadata** A count of metadata objects in cache -- **Orphan** A count of orphan file objects in cache -- **Programs** A count of program objects in cache -- **FileSigningInfo** A count of file signing info objects in cache. -- **InventoryDeviceInterface** A count of inventory device interface objects in cache. +- **Device** A count of device objects in cache. +- **DeviceCensus** A count of devicecensus objects in cache. +- **DriverPackageExtended** A count of driverpackageextended objects in cache. +- **File** A count of file objects in cache. +- **FileSigningInfo** A count of file signing objects in cache. +- **Generic** A count of generic objects in cache. +- **HwItem** A count of hwitem objects in cache. +- **InventoryApplication** A count of application objects in cache. +- **InventoryApplicationFile** A count of application file objects in cache. +- **InventoryDeviceContainer** A count of device container objects in cache. +- **InventoryDeviceInterface** A count of Plug and Play device interface objects in cache. +- **InventoryDeviceMediaClass** A count of device media objects in cache. +- **InventoryDevicePnp** A count of device Plug and Play objects in cache. +- **InventoryDriverBinary** A count of driver binary objects in cache. +- **InventoryDriverPackage** A count of device objects in cache. +- **Metadata** A count of metadata objects in cache. +- **Orphan** A count of orphan file objects in cache. +- **Programs** A count of program objects in cache. ### Microsoft.Windows.Inventory.Core.AmiTelCacheVersions @@ -2054,62 +2053,48 @@ This event sends inventory component versions for the Device Inventory data. The following fields are available: - **aeinv** The version of the App inventory component. +- **aeinv.dll** The version of the App inventory component. - **devinv** The file version of the Device inventory component. +- **devinv.dll** The file version of the Device inventory component. -### Microsoft.Windows.Inventory.Core.InventoryDeviceUsbHubClassStartSync -This event indicates that a new set of InventoryDeviceUsbHubClassAdd events will be sent - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events -- -### Microsoft.Windows.Inventory.Core.InventoryDeviceUsbHubClassAdd - -This event sends basic metadata about the USB hubs on the device - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events -- **TotalUserConnectablePorts** Total number of connectable USB ports -- **TotalUserConnectableTypeCPorts** Total number of connectable USB Type C ports -- ### Microsoft.Windows.Inventory.Core.InventoryApplicationAdd This event sends basic metadata about an application on the system to help keep Windows up to date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **ProgramInstanceId** A hash of the file IDs in an app. -- **Name** The name of the application. Location pulled from depends on 'Source' field. -- **Type** One of ("Application", "Hotfix", "BOE", "Service", "Unknown"). Application indicates Win32 or Appx app, Hotfix indicates app updates (KBs), BOE indicates it's an app with no ARP or MSI entry, Service indicates that it is a service. Application and BOE are the ones most likely seen. -- **Publisher** The Publisher of the application. Location pulled from depends on the 'Source' field. -- **Version** The version number of the program. -- **Language** The language code of the program. -- **Source** How the program was installed (ARP, MSI, Appx, etc...) -- **MsiProductCode** A GUID that describe the MSI Product. -- **MsiPackageCode** A GUID that describes the MSI Package. Multiple 'Products' (apps) can make up an MsiPackage. - **HiddenArp** Indicates whether a program hides itself from showing up in ARP. -- **OSVersionAtInstallTime** The four octets from the OS version at the time of the application's install. -- **RootDirPath** The path to the root directory where the program was installed. -- **InstallDate** The date the application was installed (a best guess based on folder creation date heuristics) -- **InstallDateMsi** The install date if the application was installed via MSI. Passed as an array. -- **InstallDateFromLinkFile** The estimated date of install based on the links to the files. Passed as an array. -- **InstallDateArpLastModified** The date of the registry ARP key for a given application. Hints at install date but not always accurate. Passed as an array. -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. -- **objectInstanceId** ProgramId (a hash of Name, Version, Publisher, and Language of an application used to identify it). -- **PackageFullName** The package full name for a Store application. +- **InstallDate** The date the application was installed (a best guess based on folder creation date heuristics). +- **InstallDateArpLastModified** The date of the registry ARP key for a given application. Hints at install date but not always accurate. Passed as an array. Example: 4/11/2015 00:00:00 See [InstallDateArpLastModified](#installdatearplastmodified). +- **InstallDateFromLinkFile** The estimated date of install based on the links to the files. Passed as an array. See [InstallDateFromLinkFile](#installdatefromlinkfile). +- **InstallDateMsi** The install date if the application was installed via Microsoft Installer (MSI). Passed as an array. See [InstallDateMsi](#installdatemsi). - **InventoryVersion** The version of the inventory file generating the events. +- **Language** The language code of the program. +- **MsiPackageCode** A GUID that describes the MSI Package. Multiple 'Products' (apps) can make up an MsiPackage. +- **MsiProductCode** A GUID that describe the MSI Product. +- **Name** The name of the application. +- **OSVersionAtInstallTime** The four octets from the OS version at the time of the application's install. +- **PackageFullName** The package full name for a Store application. +- **ProgramInstanceId** A hash of the file IDs in an app. +- **Publisher** The Publisher of the application. Location pulled from depends on the 'Source' field. +- **RootDirPath** The path to the root directory where the program was installed. +- **Source** How the program was installed (for example, ARP, MSI, Appx). - **StoreAppType** A sub-classification for the type of Microsoft Store app, such as UWP or Win8StoreApp. +- **Type** One of ("Application", "Hotfix", "BOE", "Service", "Unknown"). Application indicates Win32 or Appx app, Hotfix indicates app updates (KBs), BOE indicates it's an app with no ARP or MSI entry, Service indicates that it is a service. Application and BOE are the ones most likely seen. +- **Version** The version number of the program. ### Microsoft.Windows.Inventory.Core.InventoryApplicationRemove This event indicates that a new set of InventoryDevicePnpAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. @@ -2117,43 +2102,45 @@ The following fields are available: This event indicates that a new set of InventoryApplicationAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. ### Microsoft.Windows.Inventory.Core.InventoryDeviceContainerAdd -This event sends basic metadata about a device container (such as a monitor or printer as opposed to a PNP device) to help keep Windows up-to-date. +This event sends basic metadata about a device container (such as a monitor or printer as opposed to a Plug and Play device) to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **ModelName** The model name. -- **ModelId** A model GUID. -- **PrimaryCategory** The primary category for the device container. - **Categories** A comma separated list of functional categories in which the container belongs. -- **IsConnected** For a physically attached device, this value is the same as IsPresent. For wireless a device, this value represents a communication link. -- **IsActive** Is the device connected, or has it been seen in the last 14 days? -- **IsPaired** Does the device container require pairing? -- **IsNetworked** Is this a networked device? -- **IsMachineContainer** Is the container the root device itself? -- **FriendlyName** The name of the device container. - **DiscoveryMethod** The discovery method for the device container. -- **ModelNumber** The model number for the device container. -- **Manufacturer** The manufacturer name for the device container. -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. -- **objectInstanceId** ContainerId +- **FriendlyName** The name of the device container. - **InventoryVersion** The version of the inventory file generating the events. +- **IsActive** Is the device connected, or has it been seen in the last 14 days? +- **IsConnected** For a physically attached device, this value is the same as IsPresent. For wireless a device, this value represents a communication link. +- **IsMachineContainer** Is the container the root device itself? +- **IsNetworked** Is this a networked device? +- **IsPaired** Does the device container require pairing? +- **Manufacturer** The manufacturer name for the device container. +- **ModelId** A unique model ID. +- **ModelName** The model name. +- **ModelNumber** The model number for the device container. +- **PrimaryCategory** The primary category for the device container. ### Microsoft.Windows.Inventory.Core.InventoryDeviceContainerRemove This event indicates that the InventoryDeviceContainer object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. @@ -2161,9 +2148,10 @@ The following fields are available: This event indicates that a new set of InventoryDeviceContainerAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. @@ -2171,9 +2159,10 @@ The following fields are available: This event retrieves information about what sensor interfaces are available on the device. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **InventoryVersion** The version of the inventory file generating the events. - **Accelerometer3D** Indicates if an Accelerator3D sensor is found. - **ActivityDetection** Indicates if an Activity Detection sensor is found. - **AmbientLight** Indicates if an Ambient Light sensor is found. @@ -2184,6 +2173,7 @@ The following fields are available: - **GravityVector** Indicates if a Gravity Detector sensor is found. - **Gyrometer3D** Indicates if a Gyrometer3D sensor is found. - **Humidity** Indicates if a Humidity sensor is found. +- **InventoryVersion** The version of the inventory file generating the events. - **LinearAccelerometer** Indicates if a Linear Accelerometer sensor is found. - **Magnetometer3D** Indicates if a Magnetometer3D sensor is found. - **Orientation** Indicates if an Orientation sensor is found. @@ -2192,13 +2182,14 @@ The following fields are available: - **RelativeOrientation** Indicates if a Relative Orientation sensor is found. - **SimpleDeviceOrientation** Indicates if a Simple Device Orientation sensor is found. - **Temperature** Indicates if a Temperature sensor is found. -- **EnergyMeter** Indicates if an Energy sensor is found. ### Microsoft.Windows.Inventory.Core.InventoryDeviceInterfaceStartSync This event indicates that a new set of InventoryDeviceInterfaceAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2206,23 +2197,25 @@ The following fields are available: ### Microsoft.Windows.Inventory.Core.InventoryDeviceMediaClassAdd -This event sends additional metadata about a PNP device that is specific to a particular class of devices to help keep Windows up to date while reducing overall size of data payload. +This event sends additional metadata about a Plug and Play device that is specific to a particular class of devices to help keep Windows up to date while reducing overall size of data payload. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. -- **InventoryVersion** The version of the inventory file generating the events. - **Audio_CaptureDriver** The Audio device capture driver endpoint. - **Audio_RenderDriver** The Audio device render driver endpoint. +- **InventoryVersion** The version of the inventory file generating the events. ### Microsoft.Windows.Inventory.Core.InventoryDeviceMediaClassRemove This event indicates that the InventoryDeviceMediaClassRemove object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. @@ -2230,56 +2223,58 @@ The following fields are available: This event indicates that a new set of InventoryDeviceMediaClassSAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. ### Microsoft.Windows.Inventory.Core.InventoryDevicePnpAdd -This event sends basic metadata about a PNP device and its associated driver to help keep Windows up-to-date. +This event represents the basic metadata about a plug and play (PNP) device and its associated driver. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **HWID** A JSON array that provides the value and order of the HWID tree for the device. -- **COMPID** A JSON array the provides the value and order of the compatible ID tree for the device. -- **InstallState** The device installation state. One of these values: https://msdn.microsoft.com/en-us/library/windows/hardware/ff543130.aspx -- **Enumerator** The bus that enumerated the device. +- **Class** The device setup class of the driver loaded for the device +- **ClassGuid** The device class GUID from the driver package +- **COMPID** A JSON array the provides the value and order of the compatible ID tree for the device. See [COMPID](#compid). - **ContainerId** A system-supplied GUID that uniquely groups the functional devices associated with a single-function or multifunction device installed in the device. -- **DeviceState** DeviceState is a bitmask of the following: DEVICE_IS_CONNECTED 0x0001 (currently only for container). DEVICE_IS_NETWORK_DEVICE 0x0002 (currently only for container). DEVICE_IS_PAIRED 0x0004 (currently only for container). DEVICE_IS_ACTIVE 0x0008 (currently never set). DEVICE_IS_MACHINE 0x0010 (currently only for container). DEVICE_IS_PRESENT 0x0020 (currently always set). DEVICE_IS_HIDDEN 0x0040. DEVICE_IS_PRINTER 0x0080 (currently only for container). DEVICE_IS_WIRELESS 0x0100. DEVICE_IS_WIRELESS_FAT 0x0200. The most common values are therefore: 32 (0x20)= device is present. 96 (0x60)= device is present but hidden. 288 (0x120)= device is a wireless device that is present. -- **ParentId** Device instance id of the parent of the device. -- **STACKID** A JSON array that provides the value and order of the STACKID tree for the device. -- **Description** The device description. -- **MatchingID** Represents the hardware ID or compatible ID that Windows uses to install a device instance. -- **Class** The device setup class of the driver loaded for the device. -- **ClassGuid** The device setup class guid of the driver loaded for the device. -- **Manufacturer** The device manufacturer. -- **Model** The device model. -- **Inf** The INF file name. -- **DriverVerVersion** The version of the driver loaded for the device. -- **DriverVerDate** The date of the driver loaded for the device. -- **Provider** The device provider. -- **DriverPackageStrongName** The immediate parent directory name in the Directory field of InventoryDriverPackage. -- **Service** The device service name. -- **LowerClassFilters** Lower filter class drivers IDs installed for the device. -- **LowerFilters** Lower filter drivers IDs installed for the device. -- **UpperClassFilters** Upper filter class drivers IDs installed for the device. -- **UpperFilters** Upper filter drivers IDs installed for the device. -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. +- **Description** The device description +- **DeviceState** DeviceState is a bitmask of the following: DEVICE_IS_CONNECTED 0x0001 (currently only for container). DEVICE_IS_NETWORK_DEVICE 0x0002 (currently only for container). DEVICE_IS_PAIRED 0x0004 (currently only for container). DEVICE_IS_ACTIVE 0x0008 (currently never set). DEVICE_IS_MACHINE 0x0010 (currently only for container). DEVICE_IS_PRESENT 0x0020 (currently always set). DEVICE_IS_HIDDEN 0x0040. DEVICE_IS_PRINTER 0x0080 (currently only for container). DEVICE_IS_WIRELESS 0x0100. DEVICE_IS_WIRELESS_FAT 0x0200. The most common values are therefore: 32 (0x20)= device is present. 96 (0x60)= device is present but hidden. 288 (0x120)= device is a wireless device that is present - **DriverId** A unique identifier for the installed device. - **DriverName** The name of the driver image file. +- **DriverVerDate** The date of the driver loaded for the device +- **DriverVerVersion** The version of the driver loaded for the device +- **Enumerator** The bus that enumerated the device +- **HWID** A JSON array that provides the value and order of the HWID tree for the device. See [HWID](#hwid). +- **Inf** The INF file name. +- **InstallState** The device installation state. One of these values: https://msdn.microsoft.com/en-us/library/windows/hardware/ff543130.aspx - **InventoryVersion** The version of the inventory file generating the events. +- **LowerClassFilters** Lower filter class drivers IDs installed for the device. +- **LowerFilters** Lower filter drivers IDs installed for the device +- **Manufacturer** The device manufacturer +- **MatchingID** Represents the hardware ID or compatible ID that Windows uses to install a device instance +- **Model** The device model +- **ParentId** Device instance id of the parent of the device - **ProblemCode** The current error code for the device. +- **Provider** The device provider +- **Service** The device service name +- **STACKID** A JSON array that provides the value and order of the STACKID tree for the device. See [STACKID](#stackid). +- **UpperClassFilters** Upper filter class drivers IDs installed for the device +- **UpperFilters** Upper filter drivers IDs installed for the device ### Microsoft.Windows.Inventory.Core.InventoryDevicePnpRemove This event indicates that the InventoryDevicePnpRemove object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. @@ -2287,45 +2282,48 @@ The following fields are available: This event indicates that a new set of InventoryDevicePnpAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. ### Microsoft.Windows.Inventory.Core.InventoryDriverBinaryAdd -This event sends basic metadata about driver files running on the system to help keep Windows up-to-date. +This event provides the basic metadata about driver binaries running on the system. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **DriverName** The file name of the driver. -- **Inf** The name of the INF file. -- **DriverPackageStrongName** The strong name of the driver package. -- **DriverCompany** The company name that developed the driver. - **DriverCheckSum** The checksum of the driver file. +- **DriverCompany** The company name that developed the driver. +- **DriverInBox** Is the driver included with the operating system? +- **DriverIsKernelMode** Is it a kernel mode driver? +- **DriverName** The file name of the driver. +- **DriverPackageStrongName** The strong name of the driver package +- **DriverSigned** The strong name of the driver package - **DriverTimeStamp** The low 32 bits of the time stamp of the driver file. - **DriverType** A bitfield of driver attributes: 1. define DRIVER_MAP_DRIVER_TYPE_PRINTER 0x0001. 2. define DRIVER_MAP_DRIVER_TYPE_KERNEL 0x0002. 3. define DRIVER_MAP_DRIVER_TYPE_USER 0x0004. 4. define DRIVER_MAP_DRIVER_IS_SIGNED 0x0008. 5. define DRIVER_MAP_DRIVER_IS_INBOX 0x0010. 6. define DRIVER_MAP_DRIVER_IS_WINQUAL 0x0040. 7. define DRIVER_MAP_DRIVER_IS_SELF_SIGNED 0x0020. 8. define DRIVER_MAP_DRIVER_IS_CI_SIGNED 0x0080. 9. define DRIVER_MAP_DRIVER_HAS_BOOT_SERVICE 0x0100. 10. define DRIVER_MAP_DRIVER_TYPE_I386 0x10000. 11. define DRIVER_MAP_DRIVER_TYPE_IA64 0x20000. 12. define DRIVER_MAP_DRIVER_TYPE_AMD64 0x40000. 13. define DRIVER_MAP_DRIVER_TYPE_ARM 0x100000. 14. define DRIVER_MAP_DRIVER_TYPE_THUMB 0x200000. 15. define DRIVER_MAP_DRIVER_TYPE_ARMNT 0x400000. 16. define DRIVER_MAP_DRIVER_IS_TIME_STAMPED 0x800000. -- **DriverInBox** Is the driver included with the operating system? -- **DriverSigned** Is the driver signed? -- **DriverIsKernelMode** Is it a kernel mode driver? - **DriverVersion** The version of the driver file. - **ImageSize** The size of the driver file. +- **Inf** The name of the INF file. +- **InventoryVersion** The version of the inventory file generating the events. - **Product** The product name that is included in the driver file. - **ProductVersion** The product version that is included in the driver file. -- **WdfVersion** The Windows Driver Framework version. - **Service** The name of the service that is installed for the device. -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. -- **InventoryVersion** The version of the inventory file generating the events. +- **WdfVersion** The Windows Driver Framework version. ### Microsoft.Windows.Inventory.Core.InventoryDriverBinaryRemove This event indicates that the InventoryDriverBinary object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. @@ -2333,38 +2331,40 @@ The following fields are available: This event indicates that a new set of InventoryDriverBinaryAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. ### Microsoft.Windows.Inventory.Core.InventoryDriverPackageAdd -This event sends basic metadata about drive packages installed on the system to help keep Windows up-to-date. +This event sends basic metadata about drive packages installed on the system to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **Inf** The INF name of the driver package. -- **ClassGuid** The class GUID for the device driver. - **Class** The class name for the device driver. -- **Directory** The path to the driver package. +- **ClassGuid** The class GUID for the device driver. - **Date** The driver package date. -- **Version** The version of the driver package. +- **Directory** The path to the driver package. +- **Inf** The INF name of the driver package. +- **InventoryVersion** The version of the inventory file generating the events. - **Provider** The provider for the driver package. - **SubmissionId** The HLK submission ID for the driver package. -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. -- **InventoryVersion** The version of the inventory file generating the events. -- **DriverInBox** Is the driver included with the operating system? +- **Version** The version of the driver package. ### Microsoft.Windows.Inventory.Core.InventoryDriverPackageRemove This event indicates that the InventoryDriverPackageRemove object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. @@ -2372,9 +2372,10 @@ The following fields are available: This event indicates that a new set of InventoryDriverPackageAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. - **InventoryVersion** The version of the inventory file generating the events. @@ -2384,187 +2385,83 @@ This event summarizes the counts for the InventoryMiscellaneousUexIndicatorAdd e The following fields are available: -- **ChecksumDictionary** A count of each operating system indicator. +- **ChecksumDictionary** A count of each operating system indicator. See [ChecksumDictionary](#checksumdictionary). - **PCFP** Equivalent to the InventoryId field that is found in other core events. -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBAAdd - -This event provides a summary rollup count of conditions encountered while performing a local scan of Office files, analyzing for known VBA programmability compatibility issues between legacy office version and ProPlus, and between 32 and 64-bit versions - -The following fields are available: - -- **Design** Count of files with design issues found -- **Design_x64** Count of files with 64 bit design issues found -- **DuplicateVBA** Count of files with duplicate VBA code -- **HasVBA** Count of files with VBA code -- **Inaccessible** Count of files that were inaccessible for scanning -- **Issues** Count of files with issues detected -- **Issues_x64** Count of files with 64-bit issues detected -- **IssuesNone** Count of files with no issues detected -- **IssuesNone_x64** Count of files with no 64-bit issues detected -- **Locked** Count of files that were locked, preventing scanning -- **NoVBA** Count of files with no VBA inside -- **Protected** Count of files that were password protected, preventing scanning -- **RemLimited** Count of files that require limited remediation changes -- **RemLimited_x64** Count of files that require limited remediation changes for 64-bit issues -- **RemSignificant** Count of files that require significant remediation changes -- **RemSignificant_x64** Count of files that require significant remediation changes for 64-bit issues -- **Score** Overall compatibility score calculated for scanned content -- **Score_x64** Overall 64-bit compatibility score calculated for scanned content -- **Total** Total number of files scanned -- **Validation** Count of files that require additional manual validation -- **Validation_x64** Count of files that require additional manual validation for 64-bit issues - -### Microsoft.Windows.Inventory.Core.InventoryApplicationFrameworkStartSync - -This event indicates that a new set of InventoryApplicationFrameworkAdd events will be sent - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events - -### Microsoft.Windows.Inventory.Core.InventoryApplicationFrameworkAdd - -This event provides the basic metadata about the frameworks an application may depend on - -The following fields are available: - -- **FileId** A hash that uniquely identifies a file -- **Frameworks** The list of frameworks this file depends on -- **InventoryVersion** The version of the inventory file generating the events -- **ProgramId** A hash of the Name, Version, Publisher, and Language of an application used to identify it - ### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicatorAdd -These events represent the basic metadata about the OS indicators installed on the system which are used for keeping the device up-to-date. +These events represent the basic metadata about the OS indicators installed on the system which are used for keeping the device up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. -- **IndicatorValue** The indicator value +- **IndicatorValue** The indicator value. -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBARuleViolationsStartSync - -This event indicates that a new sync is being generated for this object type. - -There are no fields in this event. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBAStartSync - -This event indicates that a new sync is being generated for this object type. - -There are no fields in this event. ### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicatorRemove -This event is a counterpart to InventoryMiscellaneousUexIndicatorAdd, indicating that the item has been removed. There are no additional unique fields in this event. +This event is a counterpart to InventoryMiscellaneousUexIndicatorAdd that indicates that the item has been removed. -The following fields are available: +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. ### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicatorStartSync This event indicates that a new set of InventoryMiscellaneousUexIndicatorAdd events will be sent. -The following fields are available: +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). -- **PartB_Ms.Device.DeviceInventoryChange** See the Common Data Fields section. -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBARuleViolationsAdd -This event provides data on Microsoft Office VBA rule violations, including a rollup count per violation type, giving an indication of remediation requirements for an organization. The event identifier is a unique GUID, associated with the validation rule +### STACKID + +This event provides the internal compatible ID for the stack. The following fields are available: -- **Count** Count of total Microsoft Office VBA rule violations +- **Order** The index of the ordered array. +- **Value** The value contained in the ordered array. -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeAddInAdd -This event provides data on the installed Office Add-ins. +## Kernel events -- **AddInCLSID** The CLSID key office the Office addin. -- **AddInId** The ID of the Office addin. -- **BinFileTimestamp** The timestamp of the Office addin. -- **BinFileVersion** The version of the Office addin. -- **Description** The description of the Office addin. -- **FileId** The file ID of the Office addin. -- **FriendlyName** The friendly name of the Office addin. -- **FullPath** The full path to the Office addin. -- **LoadBehavior** A Uint32 that describes the load behavior. -- **LoadTime** The load time for the Office addin. -- **OfficeApplication** The OIffice application for this addin. -- **OfficeArchitecture** The architecture of the addin. -- **OfficeVersion** The Office version for this addin. -- **OutlookCrashingAddin** A boolean value that indicates if crashes have been found for this addin. -- **Provider** The provider name for this addin. +### IO -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeAddInStartSync +This event indicates the number of bytes read from or read by the OS and written to or written by the OS upon system startup. -This event indicates that a new sync is being generated for this object type. +The following fields are available: -There are no fields in this event. +- **BytesRead** The total number of bytes read from or read by the OS upon system startup. +- **BytesWritten** The total number of bytes written to or written by the OS upon system startup. -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIdentifiersAdd -This event provides data on the installed Office identifiers. +### Microsoft.Windows.Kernel.BootEnvironment.OsLaunch -- **OAudienceData** The Office Audience descriptor. -- **OAudienceId** The Office Audience ID. -- **OMID** The Office machine ID. -- **OPlatform** The Office architecture. -- **OVersion** The Office version -- **OTenantId** The Office 365 Tenant GUID. -- **OWowMID** The Office machine ID. +This event includes basic data about the Operating System, collected during Boot and used to evaluate the success of the upgrade process. -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIdentifiersStartSync +The following fields are available: -This event indicates that a new sync is being generated for this object type. +- **BootApplicationId** This field tells us what the OS Loader Application Identifier is. +- **BootAttemptCount** The number of consecutive times the boot manager has attempted to boot into this operating system. +- **BootSequence** The current Boot ID, used to correlate events related to a particular boot session. +- **BootStatusPolicy** Identifies the applicable Boot Status Policy. +- **BootType** Identifies the type of boot (e.g.: "Cold", "Hiber", "Resume"). +- **EventTimestamp** Seconds elapsed since an arbitrary time point. This can be used to identify the time difference in successive boot attempts being made. +- **FirmwareResetReasonEmbeddedController** Reason for system reset provided by firmware. +- **FirmwareResetReasonEmbeddedControllerAdditional** Additional information on system reset reason provided by firmware if needed. +- **FirmwareResetReasonPch** Reason for system reset provided by firmware. +- **FirmwareResetReasonPchAdditional** Additional information on system reset reason provided by firmware if needed. +- **FirmwareResetReasonSupplied** Flag indicating that a reason for system reset was provided by firmware. +- **IO** Amount of data written to and read from the disk by the OS Loader during boot. See [IO](#io). +- **LastBootSucceeded** Flag indicating whether the last boot was successful. +- **LastShutdownSucceeded** Flag indicating whether the last shutdown was successful. +- **MenuPolicy** Type of advanced options menu that should be shown to the user (Legacy, Standard, etc.). +- **RecoveryEnabled** Indicates whether recovery is enabled. +- **UserInputTime** The amount of time the loader application spent waiting for user input. -There are no fields in this event. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIESettingsStartSync - -This event indicates that a new sync is being generated for this object type. - -There are no fields in this event. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeProductsStartSync - -This event indicates that a new sync is being generated for this object type. - -There are no fields in this event. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIESettingsAdd - -This event provides data on the installed Office-related Internet Explorer features. - -- **OIeFeatureAddon** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeMachineLockdown** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeMimeHandling** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeMimeSniffing** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeNoAxInstall** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeNoDownload** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeObjectCaching** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIePasswordDisable** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeSafeBind** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeSecurityBand** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeUncSaveCheck** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeValidateUrl** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeWebOcPopup** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeWinRestrict** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). -- **OIeZoneElevate** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/en-us/library/ee330720.aspx). - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeProductsAdd - -This event describes the Office products that are installed. - -- **OC2rApps** The Office Click-to-Run apps. -- **OC2rSkus** The Office Click-to-Run products. -- **OMsiApps** The Office MSI apps. -- **OProductCodes** The Office MSI product code. ## OneDrive events @@ -2575,10 +2472,10 @@ This event includes basic data about install and uninstall OneDrive API operatio The following fields are available: - **APIName** The name of the API. -- **ScenarioName** The name of the scenario. - **Duration** How long the operation took. -- **isSuccess** Was the operation successful? +- **IsSuccess** Was the operation successful? - **ResultCode** The result code. +- **ScenarioName** The name of the scenario. ### Microsoft.OneDrive.Sync.Setup.EndExperience @@ -2588,9 +2485,9 @@ This event includes a success or failure summary of the installation. The following fields are available: - **APIName** The name of the API. +- **HResult** Indicates the result code of the event +- **IsSuccess** Was the operation successful? - **ScenarioName** The name of the scenario. -- **Hresult** The HResult of the operation. -- **isSuccess** Was the operation successful? ### Microsoft.OneDrive.Sync.Setup.OSUpgradeInstallationOperation @@ -2599,14 +2496,14 @@ This event is related to the OS version when the OS is upgraded with OneDrive in The following fields are available: -- **HResult** The HResult of the operation. -- **SourceOSVersion** The source version of the operating system. -- **SourceOSBuildNumber** The source build number of the operating system. -- **SourceOSBuildBranch** The source branch of the operating system. -- **CurrentOSVersion** The current version of the operating system. -- **CurrentOSBuildNumber** The current build number of the operating system. -- **CurrentOSBuildBranch** The current branch of the operating system. - **CurrentOneDriveVersion** The current version of OneDrive. +- **CurrentOSBuildBranch** The current branch of the operating system. +- **CurrentOSBuildNumber** The current build number of the operating system. +- **CurrentOSVersion** The current version of the operating system. +- **HResult** The HResult of the operation. +- **SourceOSBuildBranch** The source branch of the operating system. +- **SourceOSBuildNumber** The source build number of the operating system. +- **SourceOSVersion** The source version of the operating system. ### Microsoft.OneDrive.Sync.Setup.RegisterStandaloneUpdaterAPIOperation @@ -2616,10 +2513,10 @@ This event is related to registering or unregistering the OneDrive update task. The following fields are available: - **APIName** The name of the API. +- **IsSuccess** Was the operation successful? +- **RegisterNewTaskResult** The HResult of the RegisterNewTask operation. - **ScenarioName** The name of the scenario. - **UnregisterOldTaskResult** The HResult of the UnregisterOldTask operation. -- **RegisterNewTaskResult** The HResult of the RegisterNewTask operation. -- **isSuccess** Was the operation successful? ### Microsoft.OneDrive.Sync.Setup.SetupCommonData @@ -2629,19 +2526,15 @@ This event contains basic OneDrive configuration data that helps to diagnose fai The following fields are available: - **AppVersion** The version of the app. -- **OfficeVersion** The version of Office that is installed. -- **BuildArch** Is the architecture x86 or x64? -- **Market** Which market is this in? -- **OneDriveDeviceId** The OneDrive device ID. +- **BuildArchitecture** Is the architecture x86 or x64? +- **Environment** Is the device on the production or int service? - **MachineGuid** The CEIP machine ID. -- **IsMSFTInternal** Is this an internal Microsoft device? +- **Market** Which market is this in? +- **MSFTInternal** Is this an internal Microsoft device? +- **OfficeVersionString** The version of Office that is installed. - **OSDeviceName** Only if the device is internal to Microsoft, the device name. - **OSUserName** Only if the device is internal to Microsoft, the user name. -- **Environment** Is the device on the production or int service? -- **OfficeVersionString** The version of Office that is installed. -- **BuildArchitecture** Is the architecture x86 or x64? - **UserGuid** The CEIP user ID. -- **MSFTInternal** Is this an internal Microsoft device? ### Microsoft.OneDrive.Sync.Updater.CommonData @@ -2651,21 +2544,21 @@ This event contains basic OneDrive configuration data that helps to diagnose fai The following fields are available: - **AppVersion** The version of the app. -- **OfficeVersion** The version of Office that is installed. - **BuildArch** Is the architecture x86 or x64? -- **Market** Which market is this in? -- **OneDriveDeviceId** The OneDrive device ID. -- **MachineGuid** The CEIP machine ID. +- **Environment** Is the device on the production or int service? - **IsMSFTInternal** Is this an internal Microsoft device? +- **MachineGuid** The CEIP machine ID. +- **Market** Which market is this in? +- **OfficeVersion** The version of Office that is installed. +- **OneDriveDeviceId** The OneDrive device ID. - **OSDeviceName** Only if the device is internal to Microsoft, the device name. - **OSUserName** Only if the device is internal to Microsoft, the user name. -- **Environment** Is the device on the production or int service? - **UserGuid** A unique global user identifier. ### Microsoft.OneDrive.Sync.Updater.ComponentInstallState -This event determines the installation state of dependent OneDrive components. +This event includes basic data about the installation state of dependent OneDrive components. The following fields are available: @@ -2675,7 +2568,7 @@ The following fields are available: ### Microsoft.OneDrive.Sync.Updater.OfficeRegistration -This event determines the status of the OneDrive integration with Microsoft Office. +This event indicates the status of the OneDrive integration with Microsoft Office. The following fields are available: @@ -2716,9 +2609,9 @@ This event determines the outcome of the operation. The following fields are available: -- **UpdaterVersion** The version of the updater. -- **IsLoggingEnabled** Is logging enabled? - **hr** The HResult of the operation. +- **IsLoggingEnabled** Is logging enabled? +- **UpdaterVersion** The version of the updater. ### Microsoft.OneDrive.Sync.Updater.UpdateTierReg @@ -2748,287 +2641,684 @@ The following fields are available: - **winInetError** The HResult of the operation. -## Remediation events ->[!NOTE] ->Events from this provider are sent with the installation of KB4023057 and any subsequent Windows update. For details, see [this support article](https://support.microsoft.com/help/4023057). +## Remediation events ### Microsoft.Windows.Remediation.Applicable -Reports whether a specific remediation to issues preventing security and quality updates is applicable based on detection. +This event indicates a remedial plug-in is applicable if/when such a plug-in is detected. This is used to ensure Windows is up to date. The following fields are available: -- **CV** Correlation vector. -- **DetectedCondition** Boolean true if detect condition is true and perform action will be run. -- **GlobalEventCounter** Client side counter which indicates ordering of events sent by the remediation system. -- **PackageVersion** Current package version of Remediation. -- **PluginName** Name of the remediation plugin specified for each generic plugin event. -- **Result** Result for detection or perform action phases of the remediation system. -- **RunAppraiserFailed** Rerun if the appraiser command line tool failed. +- **ActionName** The name of the action to be taken by the plug-in. +- **AppraiserBinariesValidResult** Indicates whether plug-in was appraised as valid. +- **AppraiserDetectCondition** Indicates whether the plug-in passed the appraiser's check. +- **AppraiserRegistryValidResult** Indicates whether the registry entry checks out as valid. +- **AppraiserTaskDisabled** Indicates the appraiser task is disabled. +- **AppraiserTaskValidFailed** Indicates the Appraiser task did not function and requires intervention. +- **CV** Correlation vector +- **DateTimeDifference** The difference between local and reference clock times. +- **DateTimeSyncEnabled** Indicates whether the datetime sync plug-in is enabled. +- **DaysSinceLastSIH** The number of days since the most recent SIH executed. +- **DaysToNextSIH** The number of days until the next scheduled SIH execution. +- **DetectedCondition** Indicates whether detect condition is true and the perform action will be run. +- **EvalAndReportAppraiserBinariesFailed** Indicates the EvalAndReportAppraiserBinaries event failed. +- **EvalAndReportAppraiserRegEntries** Indicates the EvalAndReportAppraiserRegEntriesFailed event failed. +- **EvalAndReportAppraiserRegEntriesFailed** Indicates the EvalAndReportAppraiserRegEntriesFailed event failed. +- **GlobalEventCounter** Client side counter that indicates ordering of events sent by the remediation system. +- **HResult** The HRESULT for detection or perform action phases of the plugin. +- **IsAppraiserLatestResult** The HRESULT from the appraiser task. +- **IsConfigurationCorrected** Indicates whether the configuration of SIH task was successfully corrected. +- **LastHresult** The HRESULT for detection or perform action phases of the plugin. +- **LastRun** The date of the most recent SIH run. +- **NextRun** Date of the next scheduled SIH run. +- **PackageVersion** The version of the current remediation package. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Reload** True if SIH reload is required. +- **RemediationNoisyHammerAcLineStatus** Event that indicates the AC Line Status of the machine. +- **RemediationNoisyHammerAutoStartCount** The number of times hammer auto-started. +- **RemediationNoisyHammerCalendarTaskEnabled** Event that indicates Update Assistant Calendar Task is enabled. +- **RemediationNoisyHammerCalendarTaskExists** Event that indicates an Update Assistant Calendar Task exists. +- **RemediationNoisyHammerCalendarTaskTriggerEnabledCount** Event that indicates calendar triggers are enabled in the task. +- **RemediationNoisyHammerDaysSinceLastTaskRunTime** The number of days since the most recent hammer task ran. +- **RemediationNoisyHammerGetCurrentSize** Size in MB of the $GetCurrent folder. +- **RemediationNoisyHammerIsInstalled** TRUE if the noisy hammer is installed. +- **RemediationNoisyHammerLastTaskRunResult** The result of the last hammer task run. +- **RemediationNoisyHammerMeteredNetwork** TRUE if the machine is on a metered network. +- **RemediationNoisyHammerTaskEnabled** Indicates whether the Update Assistant Task (Noisy Hammer) is enabled. +- **RemediationNoisyHammerTaskExists** Indicates whether the Update Assistant Task (Noisy Hammer) exists. +- **RemediationNoisyHammerTaskTriggerEnabledCount** Indicates whether counting is enabled for the Update Assistant (Noisy Hammer) task trigger. +- **RemediationNoisyHammerUAExitCode** The exit code of the Update Assistant (Noisy Hammer) task. +- **RemediationNoisyHammerUAExitState** The code for the exit state of the Update Assistant (Noisy Hammer) task. +- **RemediationNoisyHammerUserLoggedIn** TRUE if there is a user logged in. +- **RemediationNoisyHammerUserLoggedInAdmin** TRUE if there is the user currently logged in is an Admin. +- **RemediationShellDeviceManaged** TRUE if the device is WSUS managed or Windows Updated disabled. +- **RemediationShellDeviceNewOS** TRUE if the device has a recently installed OS. +- **RemediationShellDeviceSccm** TRUE if the device is managed by SCCM (Microsoft System Center Configuration Manager). +- **RemediationShellDeviceZeroExhaust** TRUE if the device has opted out of Windows Updates completely. +- **RemediationTargetMachine** Indicates whether the device is a target of the specified fix. +- **RemediationTaskHealthAutochkProxy** True/False based on the health of the AutochkProxy task. +- **RemediationTaskHealthChkdskProactiveScan** True/False based on the health of the Check Disk task. +- **RemediationTaskHealthDiskCleanup_SilentCleanup** True/False based on the health of the Disk Cleanup task. +- **RemediationTaskHealthMaintenance_WinSAT** True/False based on the health of the Health Maintenance task. +- **RemediationTaskHealthServicing_ComponentCleanupTask** True/False based on the health of the Health Servicing Component task. +- **RemediationTaskHealthUSO_ScheduleScanTask** True/False based on the health of the USO (Update Session Orchestrator) Schedule task. +- **RemediationTaskHealthWindowsUpdate_ScheduledStartTask** True/False based on the health of the Windows Update Scheduled Start task. +- **RemediationTaskHealthWindowsUpdate_SihbootTask** True/False based on the health of the Sihboot task. +- **RemediationUHServiceBitsServiceEnabled** Indicates whether BITS service is enabled. +- **RemediationUHServiceDeviceInstallEnabled** Indicates whether Device Install service is enabled. +- **RemediationUHServiceDoSvcServiceEnabled** Indicates whether DO service is enabled. +- **RemediationUHServiceDsmsvcEnabled** Indicates whether DSMSVC service is enabled. +- **RemediationUHServiceLicensemanagerEnabled** Indicates whether License Manager service is enabled. +- **RemediationUHServiceMpssvcEnabled** Indicates whether MPSSVC service is enabled. +- **RemediationUHServiceTokenBrokerEnabled** Indicates whether Token Broker service is enabled. +- **RemediationUHServiceTrustedInstallerServiceEnabled** Indicates whether Trusted Installer service is enabled. +- **RemediationUHServiceUsoServiceEnabled** Indicates whether USO (Update Session Orchestrator) service is enabled. +- **RemediationUHServicew32timeServiceEnabled** Indicates whether W32 Time service is enabled. +- **RemediationUHServiceWecsvcEnabled** Indicates whether WECSVC service is enabled. +- **RemediationUHServiceWinmgmtEnabled** Indicates whether WMI service is enabled. +- **RemediationUHServiceWpnServiceEnabled** Indicates whether WPN service is enabled. +- **RemediationUHServiceWuauservServiceEnabled** Indicates whether WUAUSERV service is enabled. +- **Result** This is the HRESULT for Detection or Perform Action phases of the plugin. +- **RunAppraiserFailed** Indicates RunAppraiser failed to run correctly. +- **RunTask** TRUE if SIH task should be run by the plug-in. +- **TimeServiceNTPServer** The URL for the NTP time server used by device. +- **TimeServiceStartType** The startup type for the NTP time service. +- **TimeServiceSyncDomainJoined** True if device domain joined and hence uses DC for clock. +- **TimeServiceSyncType** Type of sync behavior for Date & Time service on device. + ### Microsoft.Windows.Remediation.Completed -Enables tracking the completion of a process that remediates issues preventing security and quality updates. +This event enables completion tracking of a process that remediates issues preventing security and quality updates. The following fields are available: -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events sent by the remediation system. -- **HResult** Result of execution of the event. -- **LatestState** Final state of the plugin component. -- **PackageVersion** Current package version of Remediation. -- **PluginName** Name of the specific remediation for each generic plugin event. -- **RemediationNoisyHammerTaskKickOffIsSuccess** Event that indicates the Update Assistant task has been started successfully. -- **Result** This is the HRESULT for detection or perform action phases of the plugin. +- **ActionName** Name of the action to be completed by the plug-in. +- **AppraiserTaskCreationFailed** TRUE if the appraiser task creation failed to complete successfully. +- **AppraiserTaskDeleteFailed** TRUE if deletion of appraiser task failed to complete successfully. +- **AppraiserTaskExistFailed** TRUE if detection of the appraiser task failed to complete successfully. +- **AppraiserTaskLoadXmlFailed** TRUE if the Appraiser XML Loader failed to complete successfully. +- **AppraiserTaskMissing** TRUE if the Appraiser task is missing. +- **AppraiserTaskTimeTriggerUpdateFailedId** TRUE if the Appraiser Task Time Trigger failed to update successfully. +- **AppraiserTaskValidateTaskXmlFailed** TRUE if the Appraiser Task XML failed to complete successfully. +- **CrossedDiskSpaceThreshold** Indicates if cleanup resulted in hard drive usage threshold required for feature update to be exceeded. +- **CV** The Correlation Vector. +- **DateTimeDifference** The difference between the local and reference clocks. +- **DaysSinceOsInstallation** The number of days since the installation of the Operating System. +- **DiskMbCleaned** The amount of space cleaned on the hard disk, measured in Megabytes. +- **DiskMbFreeAfterCleanup** The amount of free hard disk space after cleanup, measured in Megabytes. +- **DiskMbFreeBeforeCleanup** The amount of free hard disk space before cleanup, measured in Megabytes. +- **ForcedAppraiserTaskTriggered** TRUE if Appraiser task ran from the plug-in. +- **GlobalEventCounter** Client-side counter that indicates ordering of events sent by the active user. +- **HandlerCleanupFreeDiskInMegabytes** The amount of hard disk space cleaned by the storage sense handlers, measured in Megabytes. +- **HResult** The result of the event execution. +- **LatestState** The final state of the plug-in component. +- **PackageVersion** The package version for the current Remediation. +- **PageFileCount** The number of Windows Page files. +- **PageFileCurrentSize** The size of the Windows Page file, measured in Megabytes. +- **PageFileLocation** The storage location (directory path) of the Windows Page file. +- **PageFilePeakSize** The maximum amount of hard disk space used by the Windows Page file, measured in Megabytes. +- **PluginName** The name of the plug-in specified for each generic plug-in event. +- **RanCleanup** TRUE if the plug-in ran disk cleanup. +- **RemediationConfigurationTroubleshooterExecuted** True/False based on whether the Remediation Configuration Troubleshooter executed successfully. +- **RemediationConfigurationTroubleshooterIpconfigFix** TRUE if IPConfig Fix completed successfully. +- **RemediationConfigurationTroubleshooterNetShFix** TRUE if network card cache reset ran successfully. +- **RemediationDiskCleanSizeBtWindowsFolderInMegabytes** The size of the Windows BT folder (used to store Windows upgrade files), measured in Megabytes. +- **RemediationDiskCleanupBTFolderEsdSizeInMB** The size of the Windows BT folder (used to store Windows upgrade files) ESD (Electronic Software Delivery), measured in Megabytes. +- **RemediationDiskCleanupGetCurrentEsdSizeInMB** The size of any existing ESD (Electronic Software Delivery) folder, measured in Megabytes. +- **RemediationDiskCleanupSearchFileSizeInMegabytes** The size of the Cleanup Search index file, measured in Megabytes. +- **RemediationDiskCleanupUpdateAssistantSizeInMB** The size of the Update Assistant folder, measured in Megabytes. +- **RemediationDoorstopChangeSucceeded** TRUE if Doorstop registry key was successfully modified. +- **RemediationDoorstopExists** TRUE if there is a OneSettings Doorstop value. +- **RemediationDoorstopRegkeyError** TRUE if an error occurred accessing the Doorstop registry key. +- **RemediationDRFKeyDeleteSucceeded** TRUE if the RecoveredFrom (Doorstop) registry key was successfully deleted. +- **RemediationDUABuildNumber** The build number of the DUA. +- **RemediationDUAKeyDeleteSucceeded** TRUE if the UninstallActive registry key was successfully deleted. +- **RemediationDuplicateTokenSucceeded** TRUE if the user token was successfully duplicated. +- **RemediationImpersonateUserSucceeded** TRUE if the user was successfully impersonated. +- **RemediationNoisyHammerTaskKickOffIsSuccess** TRUE if the NoisyHammer task started successfully. +- **RemediationQueryTokenSucceeded** TRUE if the user token was successfully queried. +- **RemediationRanHibernation** TRUE if the system entered Hibernation. +- **RemediationRevertToSystemSucceeded** TRUE if reversion to the system context succeeded. +- **RemediationUpdateServiceHealthRemediationResult** The result of the Update Service Health plug-in. +- **RemediationUpdateTaskHealthRemediationResult** The result of the Update Task Health plug-in. +- **RemediationUpdateTaskHealthTaskList** A list of tasks fixed by the Update Task Health plug-in. +- **RemediationWindowsLogSpaceFound** The size of the Windows log files found, measured in Megabytes. +- **RemediationWindowsLogSpaceFreed** The amount of disk space freed by deleting the Windows log files, measured in Megabytes. +- **RemediationWindowsSecondaryDriveFreeSpace** The amount of free space on the secondary drive, measured in Megabytes. +- **RemediationWindowsSecondaryDriveLetter** The letter designation of the first secondary drive with a total capacity of 10GB or more. +- **RemediationWindowsSecondaryDriveTotalSpace** The total storage capacity of the secondary drive, measured in Megabytes. +- **RemediationWindowsTotalSystemDiskSize** The total storage capacity of the System Disk Drive, measured in Megabytes. +- **Result** The HRESULT for Detection or Perform Action phases of the plug-in. +- **RunResult** The HRESULT for Detection or Perform Action phases of the plug-in. +- **ServiceHealthPlugin** The nae of the Service Health plug-in. +- **StartComponentCleanupTask** TRUE if the Component Cleanup task started successfully. +- **TotalSizeofOrphanedInstallerFilesInMegabytes** The size of any orphaned Windows Installer files, measured in Megabytes. +- **TotalSizeofStoreCacheAfterCleanupInMegabytes** The size of the Windows Store cache after cleanup, measured in Megabytes. +- **TotalSizeofStoreCacheBeforeCleanupInMegabytes** The size of the Windows Store cache (prior to cleanup), measured in Megabytes. +- **usoScanDaysSinceLastScan** The number of days since the last USO (Update Session Orchestrator) scan. +- **usoScanInProgress** TRUE if a USO (Update Session Orchestrator) scan is in progress, to prevent multiple simultaneous scans. +- **usoScanIsAllowAutoUpdateKeyPresent** TRUE if the AllowAutoUpdate registry key is set. +- **usoScanIsAllowAutoUpdateProviderSetKeyPresent** TRUE if AllowAutoUpdateProviderSet registry key is set. +- **usoScanIsAuOptionsPresent** TRUE if Auto Update Options registry key is set. +- **usoScanIsFeatureUpdateInProgress** TRUE if a USO (Update Session Orchestrator) scan is in progress, to prevent multiple simultaneous scans. +- **usoScanIsNetworkMetered** TRUE if the device is currently connected to a metered network. +- **usoScanIsNoAutoUpdateKeyPresent** TRUE if no Auto Update registry key is set/present. +- **usoScanIsUserLoggedOn** TRUE if the user is logged on. +- **usoScanPastThreshold** TRUE if the most recent USO (Update Session Orchestrator) scan is past the threshold (late). +- **usoScanType** The type of USO (Update Session Orchestrator) scan (Interactive or Background). +- **WindowsHyberFilSysSizeInMegabytes** The size of the Windows Hibernation file, measured in Megabytes. +- **WindowsInstallerFolderSizeInMegabytes** The size of the Windows Installer folder, measured in Megabytes. +- **WindowsOldFolderSizeInMegabytes** The size of the Windows.OLD folder, measured in Megabytes. +- **WindowsOldSpaceCleanedInMB** The amount of disk space freed by removing the Windows.OLD folder, measured in Megabytes. +- **WindowsPageFileSysSizeInMegabytes** The size of the Windows Page file, measured in Megabytes. +- **WindowsSoftwareDistributionFolderSizeInMegabytes** The size of the SoftwareDistribution folder, measured in Megabytes. +- **WindowsSwapFileSysSizeInMegabytes** The size of the Windows Swap file, measured in Megabytes. +- **WindowsSxsFolderSizeInMegabytes** The size of the WinSxS (Windows Side-by-Side) folder, measured in Megabytes. +- **WindowsSxsTempFolderSizeInMegabytes** The size of the WinSxS (Windows Side-by-Side) Temp folder, measured in Megabytes. + ### Microsoft.Windows.Remediation.DiskCleanUnExpectedErrorEvent -Event that indicates whether an error condition occurred while trying to clean up disk space. +This event indicates that an unexpected error occurred during an update and provides information to help address the issue. The following fields are available: -- **CV** Correlation vector. -- **ErrorMessage** Description of any error that was encountered. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **HResult** Result of execution of the event. -- **PackageVersion** Current Remediation package version. +- **CV** The Correlation vector. +- **ErrorMessage** A description of any errors encountered while the plug-in was running. +- **GlobalEventCounter** The client-side counter that indicates ordering of events. +- **Hresult** The result of the event execution. +- **PackageVersion** The version number of the current remediation package. +- **SessionGuid** GUID associated with a given execution of sediment pack. + ### Microsoft.Windows.Remediation.Error -Event for general errors in the Remediation shell. +This event indicates a Sediment Pack error (update stack failure) has been detected and provides information to help address the issue. The following fields are available: -- **HResult** Return value. -- **Message** Contains information about any error that occurred. -- **PackageVersion** Current Remediation package version. +- **HResult** The result of the event execution. +- **Message** A message containing information about the error that occurred. +- **PackageVersion** The version number of the current remediation package. + ### Microsoft.Windows.Remediation.FallbackError -Indicates whether an error occurs for a fallback in the plugin. +This event indicates an error when Self Update results in a Fallback and provides information to help address the issue. The following fields are available: -- **S0** Fallback error level. -- **wilResult** Result for Windows Installer Logging function. +- **s0** Indicates the Fallback error level. See [Microsoft.Windows.Remediation.wilResult](#microsoftwindowsremediationwilresult). +- **wilResult** The result of the Windows Installer Logging. See [wilResult](#wilresult). -### Microsoft.Windows.Remediation.RemediationShellFailedAutomaticAppUpdateModifyEventId - -Event indicates that there was a failure modifying the wsautoupdate task. - -The following fields are available: - -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **hResult** Result of the failed call. -- **PackageVersion** Current Remediation package version. - -### Microsoft.Windows.Remediation.RemediationShellUnexpectedExceptionId - -Event fires when an unexpected error occurs in the shell routine. - -The following fields are available: - -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **PackageVersion** Current package version of Remediation. -- **RemediationShellUnexpectedExceptionId** Identifier of the remediation plugin. - -### Microsoft.Windows.Remediation.RemediationUHEnableServiceFailed - -Event indicates that enabling a service failed. - -The following fields are available: - -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **hResult** Result associated with the given failure. -- **PackageVersion** Current package version of Remediation. -- **serviceName** ServiceName associated with the given operation. - -### Microsoft.Windows.Remediation.RemediationUpgradeSucceededDataEventId - -Event containing data about the upgrade process. - -The following fields are available: - -- **AppraiserPlugin** True or False depending on whether the Appraiser Plugin task fix was successful. -- **ClearAUOptionsPlugin** True or False depending on whether the AU Options regkeys were successfully deleted. -- **CV** Correlation vector. -- **DatetimeSyncPlugin** True or False depending on whether the datetime sync plugin ran. -- **DiskCleanupPlugin** Disk space free by disk cleanup plugin. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **NoisyHammerPlugin** True or False depending on whether the Noisy Hammer plugin was successful. -- **PackageVersion** Current package version of Remediation. -- **RebootRequiredPlugin** True or False depending on whether the reboot required plugin ran. -- **RemediationNotifyUserFixIssuesPlugin** True or False depending on whether notify user fix issues plugin was successful. -- **RemediationPostUpgradeDiskSpace** Disk space available after the upgrade. -- **RemediationPostUpgradeHibernationSize** Size of the hibernation file after upgrade. -- **ServiceHealthPlugin** List of services updated by the plugin. -- **SIHHealthPlugin** True or False depending on whether the service health plugin completed successfully. -- **StackDataResetPlugin** True or False depending on whether resetting the update stack completed successfully. -- **TaskHealthPlugin** List of tasks updated by the plugin. -- **UpdateApplicabilityFixerPlugin** True or False depending on whether the update applicability fixer plugin completed successfully. -- **WindowsUpdateEndpointPlugin** True or False depending on whether the windows update endpoint was successful. ### Microsoft.Windows.Remediation.RemediationNotifyUserFixIssuesInvokeUIEvent -Event occurs when notify users task executes. +This event occurs when the Notify User task executes and provides information about the cause of the notification. The following fields are available: -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **PackageVersion** Current Remediation package version. -- **RemediationNotifyUserFixIssuesCallResult** Result of calling the USO sequence of steps. -- **RemediationNotifyUserFixIssuesUsoDownloadCalledHr** Error code from USO start download call. -- **RemediationNotifyUserFixIssuesUsoInitializedHr** Error code from USO initialize call. -- **RemediationNotifyUserFixIssuesUsoProxyBlanketHr** Error code from USO proxy blanket call. -- **RemediationNotifyUserFixIssuesUsoSetSessionHr** Error code from USO set session call. +- **CV** The Correlation vector. +- **GlobalEventCounter** The client-side counter that indicates ordering of events. +- **PackageVersion** The version number of the current remediation package. +- **RemediationNotifyUserFixIssuesCallResult** The result of calling the USO (Update Session Orchestrator) sequence steps. +- **RemediationNotifyUserFixIssuesUsoDownloadCalledHr** The error code from the USO (Update Session Orchestrator) download call. +- **RemediationNotifyUserFixIssuesUsoInitializedHr** The error code from the USO (Update Session Orchestrator) initialize call. +- **RemediationNotifyUserFixIssuesUsoProxyBlanketHr** The error code from the USO (Update Session Orchestrator) proxy blanket call. +- **RemediationNotifyUserFixIssuesUsoSetSessionHr** The error code from the USO (Update Session Orchestrator) session call. + + +### Microsoft.Windows.Remediation.RemediationShellFailedAutomaticAppUpdateModifyEventId + +This event provides the modification of the date on which an Automatic App Update scheduled task failed and provides information about the failure. + +The following fields are available: + +- **CV** The Correlation Vector. +- **GlobalEventCounter** The client-side counter that indicates ordering of events. +- **hResult** The result of the event execution. +- **PackageVersion** The version number of the current remediation package. + + +### Microsoft.Windows.Remediation.RemediationShellUnexpectedExceptionId + +This event identifies the remediation plug-in that returned an unexpected exception and provides information about the exception. + +The following fields are available: + +- **CV** The Correlation Vector. +- **GlobalEventCounter** The client-side counter that indicates ordering of events. +- **PackageVersion** The version number of the current remediation package. +- **RemediationShellUnexpectedExceptionId** The ID of the remediation plug-in that caused the exception. + + +### Microsoft.Windows.Remediation.RemediationUHEnableServiceFailed + +This event tracks the health of key update (Remediation) services and whether they are enabled. + +The following fields are available: + +- **CV** The Correlation Vector. +- **GlobalEventCounter** The client-side counter that indicates ordering of events. +- **hResult** The result of the event execution. +- **PackageVersion** The version number of the current remediation package. +- **serviceName** The name associated with the operation. + + +### Microsoft.Windows.Remediation.RemediationUpgradeSucceededDataEventId + +This event returns information about the upgrade upon success to help ensure Windows is up to date. + +The following fields are available: + +- **AppraiserPlugin** TRUE / FALSE depending on whether the Appraiser plug-in task fix was successful. +- **ClearAUOptionsPlugin** TRUE / FALSE depending on whether the AU (Auto Updater) Options registry keys were successfully deleted. +- **CV** The Correlation Vector. +- **DatetimeSyncPlugin** TRUE / FALSE depending on whether the DateTimeSync plug-in ran successfully. +- **DiskCleanupPlugin** TRUE / FALSE depending on whether the DiskCleanup plug-in ran successfully. +- **GlobalEventCounter** The client-side counter that indicates ordering of events. +- **NoisyHammerPlugin** TRUE / FALSE depending on whether the NoisyHammer plug-in ran successfully. +- **PackageVersion** The version number of the current remediation package. +- **RebootRequiredPlugin** TRUE / FALSE depending on whether the Reboot plug-in ran successfully. +- **RemediationNotifyUserFixIssuesPlugin** TRUE / FALSE depending on whether the User Fix Issues plug-in ran successfully +- **RemediationPostUpgradeDiskSpace** The amount of disk space available after the upgrade. +- **RemediationPostUpgradeHibernationSize** The size of the Hibernation file after the upgrade. +- **ServiceHealthPlugin** A list of services updated by the plug-in. +- **SIHHealthPlugin** TRUE / FALSE depending on whether the SIH Health plug-in ran successfully. +- **StackDataResetPlugin** TRUE / FALSE depending on whether the update stack completed successfully. +- **TaskHealthPlugin** A list of tasks updated by the plug-in. +- **UpdateApplicabilityFixerPlugin** TRUE / FALSE depending on whether the update applicability fixer plug-in completed successfully. +- **WindowsUpdateEndpointPlugin** TRUE / FALSE depending on whether the Windows Update Endpoint was successful. + ### Microsoft.Windows.Remediation.Started -Enables tracking the start of a process that remediates issues preventing security and quality updates. +This event reports whether a plug-in started, to help ensure Windows is up to date. The following fields are available: -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events sent by the remediation system. -- **PackageVersion** Current package version of Remediation. -- **PluginName** Name of the specific remediation for each generic plugin event. -- **Result** Results of the detection or perform action phases of the remediation system. +- **CV** The Correlation Vector. +- **GlobalEventCounter** The client-side counter that indicates ordering of events. +- **PackageVersion** The version number of the current remediation package. +- **PluginName** The name of the plug-in specified for each generic plug-in event. +- **Result** The HRESULT for Detection or Perform Action phases of the plug-in. + ### Microsoft.Windows.Remediation.wilResult -Event containing self-update information. +This event provides Self Update information to help keep Windows up to date. The following fields are available: -- **callContext** List of telemetry activities containing this error. -- **currentContextId** Identifier for the newest telemetry activity containing this error. -- **currentContextMessage** Custom message associated with the newest telemetry activity containing this error (if any). -- **currentContextName** Name of the newest telemetry activity containing this error. -- **failureType** Indicates what type of failure was observed (exception, returned error, logged error or fail fast). -- **failureId** Identifier assigned to this failure -- **filename** The name of the source file where the error occurred. -- **hresult** Failure error code. -- **lineNumber** Line number within the source file where the error occurred. -- **message** Custom message associated with the failure (if any). -- **module** Name of the binary where the error occurred. -- **originatingContextId** Identifier for the oldest telemetry activity containing this error. -- **originatingContextMessage** Custom message associated with the oldest telemetry activity containing this error (if any). -- **originatingContextName** Name of the oldest telemetry activity containing this error. -- **threadId** Identifier of the thread the error occurred on. +- **callContext** A list of diagnostic activities containing this error. +- **currentContextId** An identifier for the newest diagnostic activity containing this error. +- **currentContextMessage** A message associated with the most recent diagnostic activity containing this error (if any). +- **currentContextName** Name of the most recent diagnostic activity containing this error. +- **failureCount** Number of failures seen within the binary where the error occurred. +- **failureId** The identifier assigned to this failure. +- **failureType** Indicates the type of failure observed (exception, returned, error, logged error, or fail fast). +- **fileName** The source code file name where the error occurred. +- **function** The name of the function where the error occurred. +- **hresult** The failure error code. +- **lineNumber** The Line Number within the source code file where the error occurred. +- **message** A message associated with the failure (if any). +- **module** The name of the binary module in which the error occurred. +- **originatingContextId** The identifier for the oldest diagnostic activity containing this error. +- **originatingContextMessage** A message associated with the oldest diagnostic activity containing this error (if any). +- **originatingContextName** The name of the oldest diagnostic activity containing this error. +- **threadId** The identifier of the thread the error occurred on. -## Sediment Service events ->[!NOTE] ->Events from this provider are sent with the installation of KB4023057 and any subsequent Windows update. For details, see [this support article](https://support.microsoft.com/help/4023057). +## Sediment events -### Microsoft.Windows.SedimentService.Applicable +### Microsoft.Windows.Sediment.Info.AppraiserData -Indicates whether a given plugin is applicable. +This event provides data on the current Appraiser status of the device to help ensure Windows is up to date. The following fields are available: -- **CV** Correlation vector. -- **DetectedCondition** Boolean true if detect condition is true and perform action will be run. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **IsSelfUpdateEnabledInOneSettings** True/False based on whether self update is enabled. -- **IsSelfUpdateNeeded** True/False based on whether a newer version is available. -- **PackageVersion** Version of the package. -- **PluginName** Name of the plugin specified for each generic plugin event. -- **Result** This is the HRESULT for detection or perform action phases of the plugin. +- **ErrorCode** The value of the Return Code for the registry query. +- **GStatus** The pre-upgrade GStatus value. +- **PayloadVersion** The version information for the remediation component. +- **RegKeyName** The name of the registry subkey where data was found for this event. +- **Time** The system time at which the event began. +- **UpgEx** The pre-upgrade UpgEx value. -### Microsoft.Windows.SedimentService.Completed -Indicates whether a given plugin has completed its work. +### Microsoft.Windows.Sediment.Info.BinaryInfo + +This event provides information about the binary returned by the Operating System Remediation System Service (OSRSS) to help ensure Windows is up to date. The following fields are available: -- **CV** Correlation vector. -- **FailedReasons** String reason for any plugin failures. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **PackageVersion** Current package version of Remediation. -- **PluginName** Name of the plugin specified for each generic plugin event. -- **Result** Result of the service execution. -- **SedimentServiceCheckTaskFunctional** Result of checking if the scheduled task is functional. -- **SedimentServiceCurrentBytes** Current number of bytes the service is consuming. -- **SedimentServiceKillService** True/False based on whether the service should be stopped. -- **SedimentServiceMaximumBytes** Maximum bytes the service can consume. -- **SedimentServiceRetrievedKillService** True/False whether the kill service information was retrieved. -- **SedimentServiceStopping** True/False indicating whether the service was found to be stopping. -- **SedimentServiceTaskFunctional** True/False if scheduled task is functional. If task is not functional this indicates plugins will be run. -- **SedimentServiceTotalIterations** Number of iterations service will wait before running again. +- **BinaryPath** The sanitized name of the system binary from which the data was gathered. +- **ErrorCode** The value of the return code for querying the version from the binary. +- **FileVerBuild** The binary’s build number. +- **FileVerMajor** The binary’s major version number. +- **FileVerMinor** The binary’s minor version number. +- **FileVerRev** The binary’s revision number. +- **PayloadVersion** The version information for the remediation component. +- **Time** The system time at which the event began. -### Microsoft.Windows.SedimentService.Error -Indicates whether an error condition occurs in the plugin. +### Microsoft.Windows.Sediment.Info.DownloadServiceError + +This event provides information when the Download Service returns an error. The information provided helps keep Windows up to date. The following fields are available: -- **Message** String message containing information from the service. -- **PackageVersion** Version of the package. -- **HResult** Return value from the plugin result. +- **Architecture** The platform architecture used to identify the correct download payload. +- **BuildNumber** The starting build number used to identify the correct download payload. +- **Edition** The Operating System Edition used to identify the correct download payload. +- **Error** The description of the error encountered. +- **LanguageCode** The system User Interface Language used to identify the correct download payload. +- **Stack** Details about the error encountered. +- **WorkingDirectory** The folder location (path) downloader was attempting to say the payload to. -### Microsoft.Windows.SedimentService.FallbackError -Indicates whether an error occurs for a fallback in the plugin. +### Microsoft.Windows.Sediment.Info.DownloadServiceProgress + +This event indicates the progress of the downloader in 1% increments. The following fields are available: -- **s0** Fallback error level. -- **wilResult** Result for Windows Installer Logging function. +- **Percentage** The amount successfully downloaded, measured as a percentage of the whole. -### Microsoft.Windows.SedimentService.Information -General information returned from the plugin. +### Microsoft.Windows.Sediment.Info.Error + +This event indicates an error in the updater payload. This information assists in keeping Windows up to date. The following fields are available: -- **HResult** Result of the plugin execution. -- **Message** Information collected from the plugin based on the purpose of the plugin. -- **PackageVersion** Version of the package. +- **FailureType** The type of error encountered. +- **FileName** The code file in which the error occurred. +- **HResult** The failure error code. +- **LineNumber** The line number in the code file at which the error occurred. +- **ReleaseVer** The version information for the component in which the error occurred. +- **Time** The system time at which the error occurred. -### Microsoft.Windows.SedimentService.Started -Indicates that a given plugin has started. +### Microsoft.Windows.Sediment.Info.PhaseChange + +The event indicates progress made by the updater. This information assists in keeping Windows up to date. The following fields are available: -- **CV** Correlation vector -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **PackageVersion** Version of the package. -- **PluginName** Name of the plugin running. -- **Result** Return code from the plugin result. +- **NewPhase** The phase of progress made. +- **ReleaseVer** The version information for the component in which the change occurred. +- **Time** The system time at which the phase chance occurred. -### Microsoft.Windows.SedimentService.wilResult -Result from the windows internal library. +### Microsoft.Windows.Sediment.Info.ServiceInfo + +This event provide information about the system service for which data is being gathered by the Operating System Remediation System Service (OSRSS) to help ensure Windows is up to date. The following fields are available: -- **callContext** List of telemetry activities containing this error. -- **currentContextId** Identifier for the newest telemetry activity containing this error. -- **currentContextMessage** Custom message associated with the newest telemetry activity containing this error (if any). -- **currentContextName** Name of the newest telemetry activity containing this error. -- **failureType** Indicates what type of failure was observed (exception, returned error, logged error or fail fast. -- **failureId** Identifier assigned to this failure. -- **filename** The name of the source file where the error occurred. -- **hresult** Failure error code. -- **lineNumber** Line number within the source file where the error occurred. -- **message** Custom message associated with the failure (if any). -- **module** Name of the binary where the error occurred. -- **originatingContextId** Identifier for the oldest telemetry activity containing this error. -- **originatingContextMessage** Custom message associated with the oldest telemetry activity containing this error (if any). -- **originatingContextName** Name of the oldest telemetry activity containing this error. -- **threadId** Identifier of the thread the error occurred on. +- **ErrorCode** The value returned by the error for querying the service information. +- **PayloadVersion** The version information for the remediation component. +- **ServiceName** The name of the system service for which data was gathered. +- **ServiceStatus** The status of the specified service. +- **Time** The system time at which the event occurred. -## Sediment Launcher events ->[!NOTE] ->Events from this provider are sent with the installation of KB4023057 and any subsequent Windows update. For details, see [this support article](https://support.microsoft.com/help/4023057). +### Microsoft.Windows.Sediment.Info.Uptime + +This event provides information about how long the device has been operating. This information helps ensure Windows is up to date. + +The following fields are available: + +- **Days** The number of days the device has been on. +- **Hours** The number of hours the device has been on. +- **Minutes** The number of minutes the device has been on. +- **PayloadVersion** The version information for the remediation component. +- **Seconds** The number of seconds the machine has been on. +- **Ticks** The number of system clock “ticks” the device has been on. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.OSRSS.CheckingOneSettings + +This event indicates the parameters that the Operating System Remediation System Service (OSRSS) uses for a secure ping to Microsoft to help ensure Windows is up to date. + +The following fields are available: + +- **CustomVer** The registry value for targeting. +- **IsMetered** TRUE if the machine is on a metered network. +- **LastVer** The version of the last successful run. +- **ServiceVersionMajor** The Major version information of the component. +- **ServiceVersionMinor** The Minor version information of the component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.OSRSS.DownloadingUrl + +This event provides information about the URL from which the Operating System Remediation System Service (OSRSS) is attempting to download. This information helps ensure Windows is up to date. + +The following fields are available: + +- **AttemptNumber** The count indicating which download attempt is starting. +- **ServiceVersionMajor** The Major version information of the component. +- **ServiceVersionMinor** The Minor version information of the component. +- **Time** The system time at which the event occurred. +- **Url** The URL from which data was downloaded. + + +### Microsoft.Windows.Sediment.OSRSS.DownloadSuccess + +This event indicates the Operating System Remediation System Service (OSRSS) successfully download data from the indicated URL. This information helps ensure Windows is up to date. + +The following fields are available: + +- **ServiceVersionMajor** The Major version information of the component. +- **ServiceVersionMinor** The Minor version information of the component. +- **Time** The system time at which the event occurred. +- **Url** The URL from which data was downloaded. + + +### Microsoft.Windows.Sediment.OSRSS.Error + +This event indicates an error occurred in the Operating System Remediation System Service (OSRSS). The information provided helps ensure future upgrade/update attempts are more successful. + +The following fields are available: + +- **FailureType** The type of error encountered. +- **FileName** The code file in which the error occurred. +- **HResult** The failure error code. +- **LineNumber** The line number in the code file at which the error occurred. +- **ServiceVersionMajor** The Major version information of the component. +- **ServiceVersionMinor** The Minor version information of the component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.OSRSS.ExeSignatureValidated + +This event indicates the Operating System Remediation System Service (OSRSS) successfully validated the signature of an EXE from the indicated URL. The information provided helps ensure Windows is up to date. + +The following fields are available: + +- **ServiceVersionMajor** The Major version information of the component. +- **ServiceVersionMinor** The Minor version information of the component. +- **Time** The system time at which the event occurred. +- **Url** The URL from which the validated EXE was downloaded. + + +### Microsoft.Windows.Sediment.OSRSS.ExtractSuccess + +This event indicates that the Operating System Remediation System Service (OSRSS) successfully extracted downloaded content. The information provided helps ensure Windows is up to date. + +The following fields are available: + +- **ServiceVersionMajor** The Major version information of the component. +- **ServiceVersionMinor** The Minor version information of the component. +- **Time** The system time at which the event occurred. +- **Url** The URL from which the successfully extracted content was downloaded. + + +### Microsoft.Windows.Sediment.OSRSS.NewUrlFound + +This event indicates the Operating System Remediation System Service (OSRSS) succeeded in finding a new URL to download from. This helps ensure Windows is up to date. + +The following fields are available: + +- **ServiceVersionMajor** The Major version information of the component. +- **ServiceVersionMinor** The Minor version information of the component. +- **Time** The system time at which the event occurred. +- **Url** The new URL from which content will be downloaded. + + +### Microsoft.Windows.Sediment.OSRSS.ProcessCreated + +This event indicates the Operating System Remediation System Service (OSRSS) created a new process to execute content downloaded from the indicated URL. This information helps ensure Windows is up to date. + +The following fields are available: + +- **ServiceVersionMajor** The Major version information of the component. +- **ServiceVersionMinor** The Minor version information of the component. +- **Time** The system time at which the event occurred. +- **Url** The new URL from which content will be executed. + + +### Microsoft.Windows.Sediment.OSRSS.UrlState + +This event indicates the state the Operating System Remediation System Service (OSRSS) is in while attempting a download from the URL. + +The following fields are available: + +- **Id** A number identifying the URL +- **ServiceVersionMajor** Version info for the component +- **ServiceVersionMinor** Version info for the component +- **StateData** State-specific data, such as which attempt number for the download +- **StateNumber** A number identifying which state the URL is in (found, downloading, extracted, etc.) +- **Time** System timestamp the event was fired + + +### Microsoft.Windows.Sediment.ServiceInstaller.AttemptingUpdate + +This event indicates the Operating System Remediation System Service (OSRSS) installer is attempting an update to itself. This information helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.BinaryUpdated + +This event indicates the Operating System Remediation System Service (OSRSS) updated installer binaries with new binaries as part of its self-update process. This information helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.Error + +This event indicates an error occurred in the Operating System Remediation System Service (OSRSS). The information provided helps ensure future upgrade/update attempts are more successful. + +The following fields are available: + +- **FailureType** The type of error encountered. +- **FileName** The code file in which the error occurred. +- **HResult** The failure error code. +- **InstallerVersion** The version information of the Installer component. +- **LineNumber** The line number in the code file at which the error occurred. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.InstallerLaunched + +This event indicates the Operating System Remediation System Service (OSRSS) has launched. The information provided helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.ServiceInstalled + +This event indicates the Operating System Remediation System Service (OSRSS) successfully installed the Installer Component. This information helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.ServiceRestarted + +This event indicates the Operating System Remediation System Service (OSRSS) has restarted after installing an updated version of itself. This information helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.ServiceStarted + +This event indicates the Operating System Remediation System Service (OSRSS) has started after installing an updated version of itself. This information helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.ServiceStopped + +This event indicates the Operating System Remediation System Service (OSRSS) was stopped by a self-updated to install an updated version of itself. This information helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.UninstallerCompleted + +This event indicates the Operating System Remediation System Service (OSRSS) successfully uninstalled the installed version as part of a self-update. This information helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.UninstallerLaunched + +This event indicates the Operating System Remediation System Service (OSRSS) successfully started the Uninstaller as part of a self-update. This information helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.UpdaterCompleted + +This event indicates the Operating System Remediation System Service (OSRSS) successfully completed the self-update operation. This information helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + + +### Microsoft.Windows.Sediment.ServiceInstaller.UpdaterLaunched + +This event indicates the Operating System Remediation System Service (OSRSS) successfully launched the self-updater after downloading it. This information helps ensure Windows is up to date. + +The following fields are available: + +- **InstallerVersion** The version information of the Installer component. +- **Time** The system time at which the event occurred. + ### Microsoft.Windows.SedimentLauncher.Applicable @@ -3036,14 +3326,15 @@ Indicates whether a given plugin is applicable. The following fields are available: -- **CV** Correlation vector. -- **DetectedCondition** Boolean true if detect condition is true and action will be run. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **IsSelfUpdateEnabledInOneSettings** True/False based on whether self update is enabled. -- **IsSelfUpdateNeeded** True/False based on whether a newer version is available. -- **PackageVersion** Version of the package. -- **PluginName** Name of the plugin specified for each generic plugin event. -- **Result** This is the HRESULT for detection or perform action phases of the plugin. +- **CV** Correlation vector. +- **DetectedCondition** Boolean true if detect condition is true and perform action will be run. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **IsSelfUpdateEnabledInOneSettings** True if self update enabled in Settings. +- **IsSelfUpdateNeeded** True if self update needed by device. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. + ### Microsoft.Windows.SedimentLauncher.Completed @@ -3051,97 +3342,210 @@ Indicates whether a given plugin has completed its work. The following fields are available: -- **CV** Correlation vector. -- **FailedReasons** String reason for any plugin failures. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **PackageVersion** Current package version of Remediation. -- **PluginName** Name of the plugin specified for each generic plugin event. -- **Result** Result of the service execution. -- **SedLauncherExecutionResult** Final result of launcher running the plugins from the dll. +- **CV** Correlation vector. +- **FailedReasons** Concatenated list of failure reasons. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. +- **SedLauncherExecutionResult** HRESULT for one execution of the Sediment Launcher. + ### Microsoft.Windows.SedimentLauncher.Error -Error occurred during execution of the plugin. +This event indicates an error occurred during the execution of the plug-in. The information provided helps ensure future upgrade/update attempts are more successful. The following fields are available: -- **Message** Information message returned from a plugin containing only information internal to plugin execution. -- **PackageVersion** Version of the package. -- **HResult** Return value from the plugin result. +- **HResult** The result for the Detection or Perform Action phases of the plug-in. +- **Message** A message containing information about the error that occurred (if any). +- **PackageVersion** The version number of the current remediation package. + ### Microsoft.Windows.SedimentLauncher.FallbackError -Error occurred during execution of the plugin fallback. +This event indicates that an error occurred during execution of the plug-in fallback. The following fields are available: -- **s0** Fallback error level for plugin. -- **wilResult** Result from executing Windows Installer Logging based function. +- **s0** Error occurred during execution of the plugin fallback. See [Microsoft.Windows.SedimentLauncher.wilResult](#microsoftwindowssedimentlauncherwilresult). + ### Microsoft.Windows.SedimentLauncher.Information -General information returned from the plugin. +This event provides general information returned from the plug-in. The following fields are available: -- **HResult** Result of the plugin execution. -- **Message** Information collected from the plugin based on the purpose of the plugin. -- **PackageVersion** Version of the package. +- **HResult** This is the HRESULT for detection or perform action phases of the plugin. +- **Message** Information message returned from a plugin containing only information internal to the plugins execution. +- **PackageVersion** Current package version of Remediation. + ### Microsoft.Windows.SedimentLauncher.Started -Indicates that a given plugin has started. +This event indicates that a given plug-in has started. The following fields are available: -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **PackageVersion** Version of the package. -- **PluginName** Name of the plugin running. -- **Result** Return code from the plugin result. +- **CV** Correlation vector. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. + ### Microsoft.Windows.SedimentLauncher.wilResult -Result from the windows internal library. +This event provides the result from the Windows internal library. The following fields are available: -- **callContext** List of telemetry activities containing this error. -- **currentContextId** Identifier for the newest telemetry activity containing this error. -- **currentContextMessage** Custom message associated with the newest telemetry activity containing this error (if any). -- **currentContextName** Name of the newest telemetry activity containing this error. -- **failurecount** Number of failures seen. -- **failureType** Indicates what type of failure was observed (exception, returned error, logged error or fail fast. -- **failureId** Identifier assigned to this failure. -- **filename** The name of the source file where the error occurred. -- **function** Name of the function where the error occurred. -- **hresult** Failure error code. -- **lineNumber** Line number within the source file where the error occurred. -- **message** Custom message associated with the failure (if any). -- **module** Name of the binary where the error occurred. -- **originatingContextId** Identifier for the oldest telemetry activity containing this error. -- **originatingContextMessage** Custom message associated with the oldest telemetry activity containing this error (if any). -- **originatingContextName** Name of the oldest telemetry activity containing this error. -- **threadId** Identifier of the thread the error occurred on. +- **callContext** List of telemetry activities containing this error. +- **currentContextId** Identifier for the newest telemetry activity containing this error. +- **currentContextMessage** Custom message associated with the newest telemetry activity containing this error (if any). +- **currentContextName** Name of the newest telemetry activity containing this error. +- **failureCount** Number of failures seen within the binary where the error occurred. +- **failureId** Identifier assigned to this failure. +- **failureType** Indicates what type of failure was observed (exception, returned error, logged error or fail fast). +- **fileName** Source code file name where the error occurred. +- **function** Name of the function where the error occurred. +- **hresult** Failure error code. +- **lineNumber** Line number within the source code file where the error occurred. +- **message** Custom message associated with the failure (if any). +- **module** Name of the binary where the error occurred. +- **originatingContextId** Identifier for the oldest telemetry activity containing this error. +- **originatingContextMessage** Custom message associated with the oldest telemetry activity containing this error (if any). +- **originatingContextName** Name of the oldest telemetry activity containing this error. +- **threadId** Identifier of the thread the error occurred on. + + +### Microsoft.Windows.SedimentService.Applicable + +This event indicates whether a given plug-in is applicable. + +The following fields are available: + +- **CV** Correlation vector. +- **DetectedCondition** Determine whether action needs to run based on device properties. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **IsSelfUpdateEnabledInOneSettings** Indicates if self update is enabled in One Settings. +- **IsSelfUpdateNeeded** Indicates if self update is needed. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. + + +### Microsoft.Windows.SedimentService.Completed + +This event indicates whether a given plug-in has completed its work. + +The following fields are available: + +- **CV** Correlation vector. +- **FailedReasons** List of reasons when the plugin action failed. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. +- **SedimentServiceCheckTaskFunctional** True/False if scheduled task check succeeded. +- **SedimentServiceCurrentBytes** Number of current private bytes of memory consumed by sedsvc.exe. +- **SedimentServiceKillService** True/False if service is marked for kill (Shell.KillService). +- **SedimentServiceMaximumBytes** Maximum bytes allowed for the service. +- **SedimentServiceRetrievedKillService** True/False if result of One Settings check for kill succeeded - we only send back one of these indicators (not for each call). +- **SedimentServiceStopping** True/False indicating whether the service is stopping. +- **SedimentServiceTaskFunctional** True/False if scheduled task is functional. If task is not functional this indicates plugins will be run. +- **SedimentServiceTotalIterations** Number of 5 second iterations service will wait before running again. + + +### Microsoft.Windows.SedimentService.Error + +This event indicates whether an error condition occurred in the plug-in. + +The following fields are available: + +- **HResult** This is the HRESULT for detection or perform action phases of the plugin. +- **Message** Custom message associated with the failure (if any). +- **PackageVersion** Current package version of Remediation. + + +### Microsoft.Windows.SedimentService.FallbackError + +This event indicates whether an error occurred for a fallback in the plug-in. + +The following fields are available: + +- **s0** Event returned when an error occurs for a fallback in the plugin. See [Microsoft.Windows.SedimentService.wilResult](#microsoftwindowssedimentservicewilresult). + + +### Microsoft.Windows.SedimentService.Information + +This event provides general information returned from the plug-in. + +The following fields are available: + +- **HResult** This is the HRESULT for detection or perform action phases of the plugin. +- **Message** Custom message associated with the failure (if any). +- **PackageVersion** Current package version of Remediation. + + +### Microsoft.Windows.SedimentService.Started + +This event indicates a specified plug-in has started. This information helps ensure Windows is up to date. + +The following fields are available: + +- **CV** The Correlation Vector. +- **GlobalEventCounter** The client-side counter that indicates ordering of events. +- **PackageVersion** The version number of the current remediation package. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for Detection or Perform Action phases of the plugin. + + +### Microsoft.Windows.SedimentService.wilResult + +This event provides the result from the Windows internal library. + +The following fields are available: + +- **callContext** List of telemetry activities containing this error. +- **currentContextId** Identifier for the newest telemetry activity containing this error. +- **currentContextMessage** Custom message associated with the newest telemetry activity containing this error (if any). +- **currentContextName** Name of the newest telemetry activity containing this error. +- **failureCount** Number of failures seen within the binary where the error occurred. +- **failureId** Identifier assigned to this failure. +- **failureType** Indicates what type of failure was observed (exception, returned error, logged error or fail fast). +- **fileName** Source code file name where the error occurred. +- **function** Name of the function where the error occurred. +- **hresult** Failure error code. +- **lineNumber** Line number within the source code file where the error occurred. +- **message** Custom message associated with the failure (if any). +- **module** Name of the binary where the error occurred. +- **originatingContextId** Identifier for the oldest telemetry activity containing this error. +- **originatingContextMessage** Custom message associated with the oldest telemetry activity containing this error (if any). +- **originatingContextName** Name of the oldest telemetry activity containing this error. +- **threadId** Identifier of the thread the error occurred on. + ## Setup events ### SetupPlatformTel.SetupPlatformTelActivityEvent -This event sends a unique ID that can be used to bind Setup Platform events together, to help keep Windows up to date. +This event sends basic metadata about the SetupPlatform update installation process, to help keep Windows up to date. The following fields are available: -- **FieldName** Retrieves the event name/data point. Examples: InstallStartTime, InstallEndtime, OverallResult etc. -- **GroupName** Retrieves the groupname the event belongs to. Example: Install Information, DU Information, Disk Space Information etc. -- **Value** Retrieves the value associated with the corresponding event name. For example: For time-related events, this will include the system time. - **ActivityId** Provides a unique Id to correlate events that occur between a activity start event, and a stop event - **ActivityName** Provides a friendly name of the package type that belongs to the ActivityId (Setup, LanguagePack, GDR, Driver, etc.) +- **FieldName** Retrieves the event name/data point. Examples: InstallStartTime, InstallEndtime, OverallResult etc. +- **GroupName** Retrieves the groupname the event belongs to. Example: Install Information, DU Information, Disk Space Information etc. +- **value** Value associated with the corresponding event name. For example, time-related events will include the system time +- **Value** Value associated with the corresponding event name. For example, time-related events will include the system time ### SetupPlatformTel.SetupPlatformTelActivityStarted -This event sends basic metadata about the update installation process generated by SetupPlatform to help keep Windows up to date. +This event sends basic metadata about the update installation process generated by SetupPlatform to help keep Windows up to date. The following fields are available: @@ -3161,8 +3565,8 @@ This service retrieves events generated by SetupPlatform, the engine that drives The following fields are available: - **FieldName** Retrieves the event name/data point. Examples: InstallStartTime, InstallEndtime, OverallResult etc. -- **Value** Retrieves the value associated with the corresponding event name (Field Name). For example: For time related events this will include the system time. - **GroupName** Retrieves the groupname the event belongs to. Example: Install Information, DU Information, Disk Space Information etc. +- **Value** Retrieves the value associated with the corresponding event name (Field Name). For example: For time related events this will include the system time. ## Shared PC events @@ -3173,9 +3577,9 @@ Activity for deletion of a user account for devices set up for Shared PC mode as The following fields are available: -- **wilActivity** Windows Error Reporting data collected when there is a failure in deleting a user account with the Transient Account Manager. -- **userSid** The security identifier of the account. - **accountType** The type of account that was deleted. Example: AD, AAD, or Local +- **userSid** The security identifier of the account. +- **wilActivity** Windows Error Reporting data collected when there is a failure in deleting a user account with the Transient Account Manager. See [wilActivity](#wilactivity). ### Microsoft.Windows.SharedPC.AccountManager.SinglePolicyEvaluation @@ -3184,9 +3588,59 @@ Activity for run of the Transient Account Manager that determines if any user ac The following fields are available: -- **wilActivity** Windows Error Reporting data collected when there is a failure in evaluating accounts to be deleted with the Transient Account Manager. -- **totalAccountCount** The number of accounts on a device after running the Transient Account Manager policies. - **evaluationTrigger** When was the Transient Account Manager policies ran? Example: At log off or during maintenance hours +- **totalAccountCount** The number of accounts on a device after running the Transient Account Manager policies. +- **wilActivity** Windows Error Reporting data collected when there is a failure in evaluating accounts to be deleted with the Transient Account Manager. See [wilActivity](#wilactivity). + + +### wilActivity + +This event provides a Windows Internal Library context used for Product and Service diagnostics. + +The following fields are available: + +- **callContext** The function where the failure occurred. +- **currentContextId** The ID of the current call context where the failure occurred. +- **currentContextMessage** The message of the current call context where the failure occurred. +- **currentContextName** The name of the current call context where the failure occurred. +- **failureCount** The number of failures for this failure ID. +- **failureId** The ID of the failure that occurred. +- **failureType** The type of the failure that occurred. +- **fileName** The file name where the failure occurred. +- **function** The function where the failure occurred. +- **hresult** The HResult of the overall activity. +- **lineNumber** The line number where the failure occurred. +- **message** The message of the failure that occurred. +- **module** The module where the failure occurred. +- **originatingContextId** The ID of the originating call context that resulted in the failure. +- **originatingContextMessage** The message of the originating call context that resulted in the failure. +- **originatingContextName** The name of the originating call context that resulted in the failure. +- **threadId** The ID of the thread on which the activity is executing. + + +### wilResult + +This event provides a Windows Internal Library context used for Product and Service diagnostics. + +The following fields are available: + +- **callContext** The call context stack where failure occurred. +- **currentContextId** The ID of the current call context where the failure occurred. +- **currentContextMessage** The message of the current call context where the failure occurred. +- **currentContextName** The name of the current call context where the failure occurred. +- **failureCount** The number of failures for this failure ID. +- **failureId** The ID of the failure that occurred. +- **failureType** The type of the failure that occurred. +- **fileName** The file name where the failure occurred. +- **function** The function where the failure occurred. +- **hresult** The HResult of the overall activity. +- **lineNumber** The line number where the failure occurred. +- **message** The message of the failure that occurred. +- **module** The module where the failure occurred. +- **originatingContextId** The ID of the originating call context that resulted in the failure. +- **originatingContextMessage** The message of the originating call context that resulted in the failure. +- **originatingContextName** The name of the originating call context that resulted in the failure. +- **threadId** The ID of the thread on which the activity is executing. ## Software update events @@ -3197,81 +3651,80 @@ This event sends tracking data about the software distribution client check for The following fields are available: -- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. -- **EventInstanceID** A globally unique identifier for event instance. -- **DeviceModel** What is the device model. +- **ActivityMatchingId** Contains a unique ID identifying a single CheckForUpdates session from initialization to completion. +- **AllowCachedResults** Indicates if the scan allowed using cached results. +- **ApplicableUpdateInfo** Metadata for the updates which were detected as applicable +- **BiosFamily** The family of the BIOS (Basic Input Output System). - **BiosName** The name of the device BIOS. +- **BiosReleaseDate** The release date of the device BIOS. +- **BiosSKUNumber** The sku number of the device BIOS. - **BIOSVendor** The vendor of the BIOS. - **BiosVersion** The version of the BIOS. -- **BiosReleaseDate** The release date of the device BIOS. -- **SystemBIOSMajorRelease** Major version of the BIOS. -- **SystemBIOSMinorRelease** Minor version of the BIOS. -- **BiosFamily** The family of the BIOS (Basic Input Output System). -- **BiosSKUNumber** The sku number of the device BIOS. -- **ClientVersion** The version number of the software distribution client. -- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. -- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. -- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. -- **ServiceGuid** An ID which represents which service the software distribution client is checking for content (Windows Update, Microsoft Store, etc.). -- **StatusCode** Indicates the result of a CheckForUpdates event (success, cancellation, failure code HResult). -- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. -- **FlightRing** The ring (speed of getting builds) that a device is on if participating in flighting (pre-release builds). -- **FlightBranch** The branch that a device is on if participating in flighting (pre-release builds). -- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one -- **IsWUfBEnabled** Indicates if Windows Update for Business is enabled on the device. -- **IsWUfBDualScanEnabled** Indicates if Windows Update for Business dual scan is enabled on the device. -- **ShippingMobileOperator** The mobile operator that a device shipped on. -- **CurrentMobileOperator** The mobile operator the device is currently connected to. -- **HomeMobileOperator** The mobile operator that the device was originally intended to work with. -- **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting (pre-release builds) being introduced. -- **ActivityMatchingId** Contains a unique ID identifying a single CheckForUpdates session from initialization to completion. -- **SyncType** Describes the type of scan the event was -- **IPVersion** Indicates whether the download took place over IPv4 or IPv6 -- **NumberOfApplicationsCategoryScanEvaluated** The number of categories (apps) for which an app update scan checked -- **ScanDurationInSeconds** The number of seconds a scan took -- **ScanEnqueueTime** The number of seconds it took to initialize a scan -- **NumberOfLoop** The number of round trips the scan required -- **NumberOfUpdatesEvaluated** The total number of updates which were evaluated as a part of the scan -- **NumberOfNewUpdatesFromServiceSync** The number of updates which were seen for the first time in this scan -- **ServiceUrl** The environment URL a device is configured to scan with -- **Online** Indicates if this was an online scan. -- **AllowCachedResults** Indicates if the scan allowed using cached results. -- **MetadataIntegrityMode** The mode of the update transport metadata integrity check. 0-Unknown, 1-Ignoe, 2-Audit, 3-Enforce -- **TotalNumMetadataSignatures** The total number of metadata signatures checks done for new metadata that was synced down. -- **NumFailedMetadataSignatures** The number of metadata signatures checks which failed for new metadata synced down. -- **MSIError** The last error that was encountered during a scan for updates. -- **DriverError** The error code hit during a driver scan. This is 0 if no error was encountered. -- **FailedUpdatesCount** The number of updates that failed to be evaluated during the scan. -- **FailedUpdateGuids** The GUIDs for the updates that failed to be evaluated during the scan. -- **CapabilityDetectoidGuid** The GUID for a hardware applicability detectoid that could not be evaluated. -- **ExtendedMetadataCabUrl** Hostname that is used to download an update. -- **CDNId** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. -- **CDNCountryCode** Two letter country abbreviation for the CDN's location. -- **NetworkConnectivityDetected** Indicates the type of network connectivity that was detected. 0 - IPv4, 1 - IPv6 -- **NumberOfApplicableUpdates** The number of updates which were ultimately deemed applicable to the system after the detection process is complete -- **ApplicableUpdateInfo** Metadata for the updates which were detected as applicable -- **WebServiceRetryMethods** Web service method requests that needed to be retried to complete operation. -- **DeferredUpdates** Update IDs which are currently being deferred until a later time - **BranchReadinessLevel** The servicing branch configured on the device. +- **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. +- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. +- **CapabilityDetectoidGuid** The GUID for a hardware applicability detectoid that could not be evaluated. +- **CDNCountryCode** Two letter country abbreviation for the Content Distribution Network (CDN) location. +- **CDNId** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. +- **ClientVersion** The version number of the software distribution client. +- **Context** Gives context on where the error has occurred. Example: AutoEnable, GetSLSData, AddService, Misc, or Unknown +- **CurrentMobileOperator** The mobile operator the device is currently connected to. - **DeferralPolicySources** Sources for any update deferral policies defined (GPO = 0x10, MDM = 0x100, Flight = 0x1000, UX = 0x10000). -- **QualityUpdateDeferral** The deferral period configured for quality OS updates on the device (in days). -- **QualityUpdatePause** Indicates whether quality OS updates are paused on the device. -- **QualityUpdatePausePeriod** The pause duration configured for quality OS updates on the device (in days). +- **DeferredUpdates** Update IDs which are currently being deferred until a later time +- **DeviceModel** What is the device model. +- **DriverError** The error code hit during a driver scan. This is 0 if no error was encountered. +- **DriverExclusionPolicy** Indicates if the policy for not including drivers with Windows Update is enabled. +- **DriverSyncPassPerformed** Were drivers scanned this time? +- **EventInstanceID** A globally unique identifier for event instance. +- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **ExtendedMetadataCabUrl** Hostname that is used to download an update. +- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. +- **FailedUpdateGuids** The GUIDs for the updates that failed to be evaluated during the scan. +- **FailedUpdatesCount** The number of updates that failed to be evaluated during the scan. - **FeatureUpdateDeferral** The deferral period configured for feature OS updates on the device (in days). - **FeatureUpdatePause** Indicates whether feature OS updates are paused on the device. - **FeatureUpdatePausePeriod** The pause duration configured for feature OS updates on the device (in days). -- **DriverExclusionPolicy** Indicates if the policy for not including drivers with Windows Update is enabled. -- **TargetMetadataVersion** For self-initiated healing, this is the target version of the SIH engine to download (if needed). If not, the value is null. -- **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. -- **SearchFilter** Contains information indicating filters applied while checking for content applicable to the device. For example, to filter out all content which may require a reboot. +- **FlightBranch** The branch that a device is on if participating in flighting (pre-release builds). +- **FlightRing** The ring (speed of getting builds) that a device is on if participating in flighting (pre-release builds). +- **HomeMobileOperator** The mobile operator that the device was originally intended to work with. - **IntentPFNs** Intended application-set metadata for atomic update scenarios. +- **IPVersion** Indicates whether the download took place over IPv4 or IPv6 +- **IsWUfBDualScanEnabled** Indicates if Windows Update for Business dual scan is enabled on the device. +- **IsWUfBEnabled** Indicates if Windows Update for Business is enabled on the device. +- **MetadataIntegrityMode** The mode of the update transport metadata integrity check. 0-Unknown, 1-Ignoe, 2-Audit, 3-Enforce +- **MSIError** The last error that was encountered during a scan for updates. +- **NetworkConnectivityDetected** Indicates the type of network connectivity that was detected. 0 - IPv4, 1 - IPv6 +- **NumberOfApplicableUpdates** The number of updates which were ultimately deemed applicable to the system after the detection process is complete +- **NumberOfApplicationsCategoryScanEvaluated** The number of categories (apps) for which an app update scan checked +- **NumberOfLoop** The number of round trips the scan required +- **NumberOfNewUpdatesFromServiceSync** The number of updates which were seen for the first time in this scan +- **NumberOfUpdatesEvaluated** The total number of updates which were evaluated as a part of the scan +- **NumFailedMetadataSignatures** The number of metadata signatures checks which failed for new metadata synced down. +- **Online** Indicates if this was an online scan. - **PausedUpdates** A list of UpdateIds which that currently being paused. -- **PauseQualityUpdatesStartTime** If quality OS updates are paused on the device, this is the date and time for the beginning of the pause time window. -- **PauseQualityUpdatesEndTime** If quality OS updates are paused on the device, this is the date and time for the end of the pause time window. -- **PauseFeatureUpdatesStartTime** If feature OS updates are paused on the device, this is the date and time for the beginning of the pause time window. - **PauseFeatureUpdatesEndTime** If feature OS updates are paused on the device, this is the date and time for the end of the pause time window. -- **Context** Gives context on where the error has occurred. Example: AutoEnable, GetSLSData, AddService, Misc, or Unknown -- **DriverSyncPassPerformed** Were drivers scanned this time? +- **PauseFeatureUpdatesStartTime** If feature OS updates are paused on the device, this is the date and time for the beginning of the pause time window. +- **PauseQualityUpdatesEndTime** If quality OS updates are paused on the device, this is the date and time for the end of the pause time window. +- **PauseQualityUpdatesStartTime** If quality OS updates are paused on the device, this is the date and time for the beginning of the pause time window. +- **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting (pre-release builds) being introduced. +- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. +- **QualityUpdateDeferral** The deferral period configured for quality OS updates on the device (in days). +- **QualityUpdatePause** Indicates whether quality OS updates are paused on the device. +- **QualityUpdatePausePeriod** The pause duration configured for quality OS updates on the device (in days). +- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one +- **ScanDurationInSeconds** The number of seconds a scan took +- **ScanEnqueueTime** The number of seconds it took to initialize a scan +- **ServiceGuid** An ID which represents which service the software distribution client is checking for content (Windows Update, Windows Store, etc.). +- **ServiceUrl** The environment URL a device is configured to scan with +- **ShippingMobileOperator** The mobile operator that a device shipped on. +- **StatusCode** Indicates the result of a CheckForUpdates event (success, cancellation, failure code HResult). +- **SyncType** Describes the type of scan the event was +- **SystemBIOSMajorRelease** Major version of the BIOS. +- **SystemBIOSMinorRelease** Minor version of the BIOS. +- **TargetMetadataVersion** For self-initiated healing, this is the target version of the SIH engine to download (if needed). If not, the value is null. +- **TotalNumMetadataSignatures** The total number of metadata signatures checks done for new metadata that was synced down. +- **WebServiceRetryMethods** Web service method requests that needed to be retried to complete operation. +- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. ### SoftwareUpdateClientTelemetry.Commit @@ -3280,28 +3733,28 @@ This event sends data on whether the Update Service has been called to execute a The following fields are available: -- **EventScenario** State of call -- **EventInstanceID** A globally unique identifier for event instance. -- **DeviceModel** What is the device model. +- **BiosFamily** The family of the BIOS (Basic Input Output System). - **BiosName** The name of the device BIOS. +- **BiosReleaseDate** The release date of the device BIOS. +- **BiosSKUNumber** The sku number of the device BIOS. - **BIOSVendor** The vendor of the BIOS. - **BiosVersion** The version of the BIOS. -- **BiosReleaseDate** The release date of the device BIOS. +- **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. +- **BundleRevisionNumber** Identifies the revision number of the content bundle +- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client +- **ClientVersion** The version number of the software distribution client. +- **DeviceModel** What is the device model. +- **EventInstanceID** A globally unique identifier for event instance. +- **EventScenario** State of call +- **EventType** Possible values are "Child", "Bundle", or "Driver". +- **FlightId** The specific id of the flight the device is getting +- **HandlerType** Indicates the kind of content (app, driver, windows patch, etc.) +- **RevisionNumber** Unique revision number of Update +- **ServerId** Identifier for the service to which the software distribution client is connecting, such as Windows Update and Windows Store. - **SystemBIOSMajorRelease** Major version of the BIOS. - **SystemBIOSMinorRelease** Minor version of the BIOS. -- **BiosFamily** The family of the BIOS (Basic Input Output System). -- **BiosSKUNumber** The sku number of the device BIOS. -- **ClientVersion** The version number of the software distribution client. -- **WUDeviceID** UniqueDeviceID -- **ServerId** Identifier for the service to which the software distribution client is connecting, such as Windows Update and Microsoft Store. -- **EventType** Possible values are "Child", "Bundle", or "Driver". - **UpdateId** Unique Update ID -- **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. -- **RevisionNumber** Unique revision number of Update -- **HandlerType** Indicates the kind of content (app, driver, windows patch, etc.) -- **BundleRevisionNumber** Identifies the revision number of the content bundle -- **FlightId** The specific id of the flight the device is getting -- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client +- **WUDeviceID** UniqueDeviceID ### SoftwareUpdateClientTelemetry.Download @@ -3310,82 +3763,105 @@ This event sends tracking data about the software distribution client download o The following fields are available: -- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started downloading content, or whether it was cancelled, succeeded, or failed. -- **EventInstanceID** A globally unique identifier for event instance. -- **DeviceModel** What is the device model. +- **ActiveDownloadTime** How long the download took, in seconds, excluding time where the update wasn't actively being downloaded. +- **AppXBlockHashValidationFailureCount** A count of the number of blocks that have failed validation after being downloaded. +- **AppXDownloadScope** Indicates the scope of the download for application content. For streaming install scenarios, AllContent - non-streaming download, RequiredOnly - streaming download requested content required for launch, AutomaticOnly - streaming download requested automatic streams for the app, and Unknown - for events sent before download scope is determined by the Windows Update client. +- **BiosFamily** The family of the BIOS (Basic Input Output System). - **BiosName** The name of the device BIOS. +- **BiosReleaseDate** The release date of the device BIOS. +- **BiosSKUNumber** The sku number of the device BIOS. - **BIOSVendor** The vendor of the BIOS. - **BiosVersion** The version of the BIOS. -- **BiosReleaseDate** The release date of the device BIOS. -- **SystemBIOSMajorRelease** Major version of the BIOS. -- **SystemBIOSMinorRelease** Minor version of the BIOS. -- **BiosFamily** The family of the BIOS (Basic Input Output System). -- **BiosSKUNumber** The sku number of the device BIOS. -- **ClientVersion** The version number of the software distribution client. -- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. +- **BundleBytesDownloaded** How many bytes were downloaded for the specific content bundle. +- **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. +- **BundleRepeatFailFlag** Indicates whether this particular update bundle had previously failed to download. +- **BundleRevisionNumber** Identifies the revision number of the content bundle. +- **BytesDownloaded** How many bytes were downloaded for an individual piece of content (not the entire bundle). +- **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. - **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. -- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. -- **ServiceGuid** An ID which represents which service the software distribution client is installing content for (Windows Update, Microsoft Store, etc.). -- **StatusCode** Indicates the result of a Download event (success, cancellation, failure code HResult). -- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. -- **FlightRing** The ring (speed of getting builds) that a device is on if participating in flighting (pre-release builds). -- **FlightBranch** The branch that a device is on if participating in flighting (pre-release builds). -- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one -- **IsWUfBEnabled** Indicates if Windows Update for Business is enabled on the device. -- **IsWUfBDualScanEnabled** Indicates if Windows Update for Business dual scan is enabled on the device. -- **ShippingMobileOperator** The mobile operator that a device shipped on. +- **CbsDownloadMethod** Indicates whether the download was a full-file download or a partial/delta download. +- **CDNCountryCode** Two letter country abbreviation for the Content Distribution Network (CDN) location. +- **CDNId** ID which defines which CDN the software distribution client downloaded the content from. +- **ClientManagedByWSUSServer** Indicates whether the client is managed by Windows Server Update Services (WSUS). +- **ClientVersion** The version number of the software distribution client. - **CurrentMobileOperator** The mobile operator the device is currently connected to. +- **DeviceModel** What is the device model. +- **DeviceOEM** What OEM does this device belong to. +- **DownloadPriority** Indicates whether a download happened at background, normal, or foreground priority. +- **DownloadScenarioId** A unique ID for a given download used to tie together WU and DO events. +- **DownloadType** Differentiates the download type of SIH downloads between Metadata and Payload downloads. +- **Edition** Indicates the edition of Windows being used. +- **EventInstanceID** A globally unique identifier for event instance. +- **EventNamespaceID** Indicates whether the event succeeded or failed. Has the format EventType+Event where Event is Succeeded, Cancelled, Failed, etc. +- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started downloading content, or whether it was cancelled, succeeded, or failed. +- **EventType** Possible values are Child, Bundle, or Driver. +- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. +- **FeatureUpdatePause** Indicates whether feature OS updates are paused on the device. +- **FlightBranch** The branch that a device is on if participating in flighting (pre-release builds). +- **FlightBuildNumber** If this download was for a flight (pre-release build), this indicates the build number of that flight. +- **FlightId** The specific id of the flight (pre-release build) the device is getting. +- **FlightRing** The ring (speed of getting builds) that a device is on if participating in flighting (pre-release builds). +- **HandlerType** Indicates what kind of content is being downloaded (app, driver, windows patch, etc.). +- **HardwareId** If this download was for a driver targeted to a particular device model, this ID indicates the model of the device. - **HomeMobileOperator** The mobile operator that the device was originally intended to work with. -- **PhonePreviewEnabled** Indicates whether a phone was opted-in to getting preview builds, prior to flighting (pre-release builds) being introduced. +- **HostName** The hostname URL the content is downloading from. - **IPVersion** Indicates whether the download took place over IPv4 or IPv6. +- **IsAOACDevice** Is it Always On, Always Connected? +- **IsDependentSet** Indicates whether a driver is a part of a larger System Hardware/Firmware Update +- **IsWUfBDualScanEnabled** Indicates if Windows Update for Business dual scan is enabled on the device. +- **IsWUfBEnabled** Indicates if Windows Update for Business is enabled on the device. - **NetworkCostBitMask** Indicates what kind of network the device is connected to (roaming, metered, over data cap, etc.) - **NetworkRestrictionStatus** More general version of NetworkCostBitMask, specifying whether Windows considered the current network to be "metered." -- **TimeToEstablishConnection** Time (in ms) it took to establish the connection prior to beginning downloaded. -- **HostName** The hostname URL the content is downloading from. -- **CDNId** ID which defines which CDN the software distribution client downloaded the content from. -- **CDNCountryCode** Two letter country abbreviation for the CDN's location. -- **ActiveDownloadTime** How long the download took, in seconds, excluding time where the update wasn't actively being downloaded. -- **IsDependentSet** Indicates whether a driver is a part of a larger System Hardware/Firmware Update -- **TargetingVersion** For drivers targeted to a specific device model, this is the version number of the drivers being distributed to the device. -- **HardwareId** If this download was for a driver targeted to a particular device model, this ID indicates the model of the device. -- **UpdateImportance** Indicates whether a piece of content was marked as Important, Recommended, or Optional. -- **TargetGroupId** For drivers targeted to a specific device model, this ID indicates the distribution group of devices receiving that driver. -- **RepeatFailFlag** Indicates whether this specific piece of content had previously failed to download. -- **BytesDownloaded** How many bytes were downloaded for an individual piece of content (not the entire bundle). -- **TotalExpectedBytes** The total count of bytes that the download is expected to be. -- **ThrottlingServiceHResult** Result code (success/failure) while contacting a web service to determine whether this device should download content yet. -- **EventType** Possible values are Child, Bundle, or Driver. -- **UpdateId** An identifier associated with the specific piece of content. -- **RevisionNumber** Identifies the revision number of this specific piece of content. -- **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. -- **BundleRevisionNumber** Identifies the revision number of the content bundle. -- **HandlerType** Indicates what kind of content is being downloaded (app, driver, windows patch, etc.). -- **DownloadPriority** Indicates whether a download happened at background, normal, or foreground priority. -- **FlightId** The specific id of the flight (pre-release build) the device is getting. -- **Setup360Phase** If the download is for an operating system upgrade, this datapoint indicates which phase of the upgrade is underway. -- **UsedDO** Whether the download used the delivery optimization service. -- **CbsDownloadMethod** Indicates whether the download was a full-file download or a partial/delta download. -- **UsedSystemVolume** Indicates whether the content was downloaded to the device's main system storage drive, or an alternate storage drive. -- **FlightBuildNumber** If this download was for a flight (pre-release build), this indicates the build number of that flight. -- **BundleBytesDownloaded** How many bytes were downloaded for the specific content bundle. -- **BundleRepeatFailFlag** Indicates whether this particular update bundle had previously failed to download. -- **DownloadScenarioId** A unique ID for a given download used to tie together WU and DO events. - **PackageFullName** The package name of the content. -- **AppXBlockHashValidationFailureCount** A count of the number of blocks that have failed validation after being downloaded. -- **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. -- **TargetMetadataVersion** For self-initiated healing, this is the target version of the SIH engine to download (if needed). If not, the value is null. -- **DownloadType** Differentiates the download type of SIH downloads between Metadata and Payload downloads. -- **WUSetting** Indicates the users' current updating settings. -- **ProcessorArchitecture** Processor architecture of the system (x86, AMD64, ARM). +- **PhonePreviewEnabled** Indicates whether a phone was opted-in to getting preview builds, prior to flighting (pre-release builds) being introduced. - **PlatformRole** The PowerPlatformRole as defined on MSDN -- **IsAOACDevice** Is it Always On, Always Connected? -- **EventNamespaceID** Indicates whether the event succeeded or failed. Has the format EventType+Event where Event is Succeeded, Cancelled, Failed, etc. -- **Edition** Indicates the edition of Windows being used. -- **DeviceOEM** What OEM does this device belong to. -- **ClientManagedByWSUSServer** Indicates whether the client is managed by Windows Server Update Services (WSUS). +- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. +- **ProcessorArchitecture** Processor architecture of the system (x86, AMD64, ARM). - **QualityUpdatePause** Indicates whether quality OS updates are paused on the device. -- **FeatureUpdatePause** Indicates whether feature OS updates are paused on the device. -- **AppXDownloadScope** Indicates the scope of the download for application content. For streaming install scenarios, AllContent - non-streaming download, RequiredOnly - streaming download requested content required for launch, AutomaticOnly - streaming download requested automatic streams for the app, and Unknown - for events sent before download scope is determined by the Windows Update client. +- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one +- **RepeatFailFlag** Indicates whether this specific piece of content had previously failed to download. +- **RevisionNumber** Identifies the revision number of this specific piece of content. +- **ServiceGuid** An ID which represents which service the software distribution client is installing content for (Windows Update, Microsoft Store, etc.). +- **Setup360Phase** If the download is for an operating system upgrade, this datapoint indicates which phase of the upgrade is underway. +- **ShippingMobileOperator** The mobile operator that a device shipped on. +- **StatusCode** Indicates the result of a Download event (success, cancellation, failure code HResult). +- **SystemBIOSMajorRelease** Major version of the BIOS. +- **SystemBIOSMinorRelease** Minor version of the BIOS. +- **TargetGroupId** For drivers targeted to a specific device model, this ID indicates the distribution group of devices receiving that driver. +- **TargetingVersion** For drivers targeted to a specific device model, this is the version number of the drivers being distributed to the device. +- **TargetMetadataVersion** For self-initiated healing, this is the target version of the SIH engine to download (if needed). If not, the value is null. +- **ThrottlingServiceHResult** Result code (success/failure) while contacting a web service to determine whether this device should download content yet. +- **TimeToEstablishConnection** Time (in ms) it took to establish the connection prior to beginning downloaded. +- **TotalExpectedBytes** The total count of bytes that the download is expected to be. +- **UpdateId** An identifier associated with the specific piece of content. +- **UpdateID** An identifier associated with the specific piece of content. +- **UpdateImportance** Indicates whether a piece of content was marked as Important, Recommended, or Optional. +- **UsedDO** Whether the download used the delivery optimization service. +- **UsedSystemVolume** Indicates whether the content was downloaded to the device's main system storage drive, or an alternate storage drive. +- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. +- **WUSetting** Indicates the users' current updating settings. + + +### SoftwareUpdateClientTelemetry.DownloadCheckpoint + +This event provides a checkpoint between each of the Windows Update download phases for UUP content + +The following fields are available: + +- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client +- **ClientVersion** The version number of the software distribution client +- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed +- **EventType** Possible values are "Child", "Bundle", "Relase" or "Driver" +- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough +- **FileId** A hash that uniquely identifies a file +- **FileName** Name of the downloaded file +- **FlightId** The unique identifier for each flight +- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one +- **RevisionNumber** Unique revision number of Update +- **ServiceGuid** An ID which represents which service the software distribution client is checking for content (Windows Update, Microsoft Store, etc.) +- **StatusCode** Indicates the result of a CheckForUpdates event (success, cancellation, failure code HResult) +- **UpdateId** Unique Update ID +- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue ### SoftwareUpdateClientTelemetry.Install @@ -3394,78 +3870,79 @@ This event sends tracking data about the software distribution client installati The following fields are available: -- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started installing content, or whether it was cancelled, succeeded, or failed. -- **EventInstanceID** A globally unique identifier for event instance. -- **DeviceModel** What is the device model. +- **BiosFamily** The family of the BIOS (Basic Input Output System). - **BiosName** The name of the device BIOS. +- **BiosReleaseDate** The release date of the device BIOS. +- **BiosSKUNumber** The sku number of the device BIOS. - **BIOSVendor** The vendor of the BIOS. - **BiosVersion** The version of the BIOS. -- **BiosReleaseDate** The release date of the device BIOS. -- **SystemBIOSMajorRelease** Major version of the BIOS. -- **SystemBIOSMinorRelease** Minor version of the BIOS. -- **BiosFamily** The family of the BIOS (Basic Input Output System). -- **BiosSKUNumber** The sku number of the device BIOS. -- **ClientVersion** The version number of the software distribution client. -- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. -- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. -- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. -- **ServiceGuid** An ID which represents which service the software distribution client is installing content for (Windows Update, Microsoft Store, etc.). -- **StatusCode** Indicates the result of an installation event (success, cancellation, failure code HResult). -- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. -- **FlightRing** The ring that a device is on if participating in the Windows Insider Program. -- **FlightBranch** The branch that a device is on if participating in the Windows Insider Program. -- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one -- **IsWUfBEnabled** Is Windows Update for Business enabled on the device? -- **IsWUfBDualScanEnabled** Is Windows Update for Business dual scan enabled on the device? -- **ShippingMobileOperator** The mobile operator that a device shipped on. -- **CurrentMobileOperator** Mobile operator that device is currently connected to. -- **HomeMobileOperator** The mobile operator that the device was originally intended to work with. -- **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting being introduced. -- **TargetGroupId** For drivers targeted to a specific device model, this ID indicates the distribution group of devices receiving that driver. -- **RepeatFailFlag** Indicates whether this specific piece of content had previously failed to install. -- **EventType** Possible values are Child, Bundle, or Driver. -- **TargetingVersion** For drivers targeted to a specific device model, this is the version number of the drivers being distributed to the device. -- **UpdateImportance** Indicates whether a piece of content was marked as Important, Recommended, or Optional. -- **IsFirmware** Is this update a firmware update? -- **IsFinalOutcomeEvent** Does this event signal the end of the update/upgrade process? -- **IsDependentSet** Is the driver part of a larger System Hardware/Firmware update? -- **DriverPingBack** Contains information about the previous driver and system state. -- **ExtendedErrorCode** The extended error code. -- **CSIErrorType** The stage of CBS installation where it failed. -- **MsiAction** The stage of MSI installation where it failed. -- **MsiProductCode** The unique identifier of the MSI installer. -- **TransactionCode** The ID which represents a given MSI installation -- **HardwareId** If this install was for a driver targeted to a particular device model, this ID indicates the model of the device. -- **IsSuccessFailurePostReboot** Did it succeed and then fail after a restart? -- **UpdateId** Unique update ID -- **RevisionNumber** The revision number of this specific piece of content. -- **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. -- **BundleRevisionNumber** Identifies the revision number of the content bundle. -- **HandlerType** Indicates what kind of content is being installed. Example: app, driver, Windows update -- **FlightId** The specific ID of the Windows Insider build the device is getting. -- **Setup360Phase** If the install is for an operating system upgrade, indicates which phase of the upgrade is underway. -- **UsedSystemVolume** Indicates whether the content was downloaded and then installed from the device's main system storage drive, or an alternate storage drive. -- **FlightBuildNumber** If this installation was for a Windows Insider build, this is the build number of that build. -- **BundleRepeatFailFlag** Has this particular update bundle previously failed to install? -- **PackageFullName** The package name of the content being installed. -- **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. - **BundleBytesDownloaded** How many bytes were downloaded for the specific content bundle? +- **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. +- **BundleRepeatFailFlag** Has this particular update bundle previously failed to install? +- **BundleRevisionNumber** Identifies the revision number of the content bundle. +- **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. +- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. - **CbsDownloadMethod** Was the download a full download or a partial download? - **ClientManagedByWSUSServer** Is the client managed by Windows Server Update Services (WSUS)? +- **ClientVersion** The version number of the software distribution client. +- **CSIErrorType** The stage of CBS installation where it failed. +- **CurrentMobileOperator** Mobile operator that device is currently connected to. +- **DeviceModel** What is the device model. - **DeviceOEM** What OEM does this device belong to. - **DownloadPriority** The priority of the download activity. - **DownloadScenarioId** A unique ID for a given download used to tie together WU and DO events. +- **DriverPingBack** Contains information about the previous driver and system state. - **Edition** Indicates the edition of Windows being used. +- **EventInstanceID** A globally unique identifier for event instance. - **EventNamespaceID** Indicates whether the event succeeded or failed. Has the format EventType+Event where Event is Succeeded, Cancelled, Failed, etc. -- **IsAOACDevice** Is it Always On, Always Connected? (Mobile device usage model) -- **PlatformRole** The PowerPlatformRole as defined on MSDN. -- **ProcessorArchitecture** Processor architecture of the system (x86, AMD64, ARM). -- **RepeatSuccessInstallFlag** Indicates whether this specific piece of content had previously installed successful, for example if another user had already installed it. -- **WUSetting** Indicates the user's current updating settings. -- **IntentPFNs** Intended application-set metadata for atomic update scenarios. -- **QualityUpdatePause** Are quality OS updates paused on the device? +- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started installing content, or whether it was cancelled, succeeded, or failed. +- **EventType** Possible values are Child, Bundle, or Driver. +- **ExtendedErrorCode** The extended error code. +- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. - **FeatureUpdatePause** Are feature OS updates paused on the device? +- **FlightBranch** The branch that a device is on if participating in the Windows Insider Program. +- **FlightBuildNumber** If this installation was for a Windows Insider build, this is the build number of that build. +- **FlightId** The specific ID of the Windows Insider build the device is getting. +- **FlightRing** The ring that a device is on if participating in the Windows Insider Program. +- **HandlerType** Indicates what kind of content is being installed. Example: app, driver, Windows update +- **HardwareId** If this install was for a driver targeted to a particular device model, this ID indicates the model of the device. +- **HomeMobileOperator** The mobile operator that the device was originally intended to work with. +- **IntentPFNs** Intended application-set metadata for atomic update scenarios. +- **IsAOACDevice** Is it Always On, Always Connected? (Mobile device usage model) +- **IsDependentSet** Is the driver part of a larger System Hardware/Firmware update? +- **IsFinalOutcomeEvent** Does this event signal the end of the update/upgrade process? +- **IsFirmware** Is this update a firmware update? +- **IsSuccessFailurePostReboot** Did it succeed and then fail after a restart? +- **IsWUfBDualScanEnabled** Is Windows Update for Business dual scan enabled on the device? +- **IsWUfBEnabled** Is Windows Update for Business enabled on the device? - **MergedUpdate** Was the OS update and a BSP update merged for installation? +- **MsiAction** The stage of MSI installation where it failed. +- **MsiProductCode** The unique identifier of the MSI installer. +- **PackageFullName** The package name of the content being installed. +- **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting being introduced. +- **PlatformRole** The PowerPlatformRole as defined on MSDN. +- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. +- **ProcessorArchitecture** Processor architecture of the system (x86, AMD64, ARM). +- **QualityUpdatePause** Are quality OS updates paused on the device? +- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one +- **RepeatFailFlag** Indicates whether this specific piece of content had previously failed to install. +- **RepeatSuccessInstallFlag** Indicates whether this specific piece of content had previously installed successful, for example if another user had already installed it. +- **RevisionNumber** The revision number of this specific piece of content. +- **ServiceGuid** An ID which represents which service the software distribution client is installing content for (Windows Update, Windows Store, etc.). +- **Setup360Phase** If the install is for an operating system upgrade, indicates which phase of the upgrade is underway. +- **ShippingMobileOperator** The mobile operator that a device shipped on. +- **StatusCode** Indicates the result of an installation event (success, cancellation, failure code HResult). +- **SystemBIOSMajorRelease** Major version of the BIOS. +- **SystemBIOSMinorRelease** Minor version of the BIOS. +- **TargetGroupId** For drivers targeted to a specific device model, this ID indicates the distribution group of devices receiving that driver. +- **TargetingVersion** For drivers targeted to a specific device model, this is the version number of the drivers being distributed to the device. +- **TransactionCode** The ID which represents a given MSI installation +- **UpdateId** Unique update ID +- **UpdateID** An identifier associated with the specific piece of content. +- **UpdateImportance** Indicates whether a piece of content was marked as Important, Recommended, or Optional. +- **UsedSystemVolume** Indicates whether the content was downloaded and then installed from the device's main system storage drive, or an alternate storage drive. +- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. +- **WUSetting** Indicates the user's current updating settings. ### SoftwareUpdateClientTelemetry.SLSDiscovery @@ -3475,13 +3952,13 @@ This event sends data about the ability of Windows to discover the location of a The following fields are available: - **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed -- **SusClientId** The unique device ID controlled by the software distribution client -- **WUAVersion** The version number of the software distribution client -- **ServiceID** An ID which represents which service the software distribution client is connecting to (Windows Update, Microsoft Store, etc.) -- **UrlPath** Path to the SLS cab that was downloaded - **HResult** Indicates the result code of the event (success, cancellation, failure code HResult) - **IsBackground** Indicates whether the SLS discovery event took place in the foreground or background - **NextExpirationTime** Indicates when the SLS cab expires +- **ServiceID** An ID which represents which service the software distribution client is connecting to (Windows Update, Microsoft Store, etc.) +- **SusClientId** The unique device ID controlled by the software distribution client +- **UrlPath** Path to the SLS cab that was downloaded +- **WUAVersion** The version number of the software distribution client ### SoftwareUpdateClientTelemetry.UpdateDetected @@ -3490,44 +3967,13 @@ This event sends data about an AppX app that has been updated from the Microsoft The following fields are available: -- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client -- **ApplicableUpdateInfo** Metadata for the updates which were detected as applicable -- **NumberOfApplicableUpdates** The number of updates which were ultimately deemed applicable to the system after the detection process is complete -- **WUDeviceID** The unique device ID controlled by the software distribution client -- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one -- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed -- **EventInstanceID** A globally unique identifier for event instance -- **DeviceModel** The device's model as defined in system bios -- **BiosName** The name of the device's system bios -- **BIOSVendor** The vendor of the device's system bios -- **BiosVersion** The version of the device's system bios -- **BiosReleaseDate** The release date of the device's system bios -- **SystemBIOSMajorRelease** The major release version of the device's system bios -- **SystemBIOSMinorRelease** The minor release version of the device's system bios -- **BiosFamily** The device's family as defined in system bios -- **BiosSKUNumber** The device's SKU as defined in system bios -- **ClientVersion** The version number of the software distribution client -- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided -- **ServiceGuid** An ID which represents which service the software distribution client is connecting to (Windows Update, Microsoft Store, etc.) -- **StatusCode** Indicates the result code of the event (success, cancellation, failure code HResult) -- **ExtendedStatusCode** Secondary status code for certain scenarios where StatusCode wasn't specific enough -- **FlightRing** The ring (speed of getting builds) that a device is on if participating in flighting (pre-release builds). -- **FlightBranch** The branch that a device is on if participating in flighting (pre-release builds). -- **ShippingMobileOperator** The mobile operator that a device shipped on. -- **CurrentMobileOperator** The mobile operator the device is currently connected to. -- **HomeMobileOperator** The mobile operator that the device was originally intended to work with -- **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting (pre-release builds) being introduced. -- **ActivityMatchingId** Contains a unique ID identifying a single CheckForUpdates session from initialization to completion -- **SyncType** Describes the type of scan the event was -- **IPVersion** Indicates whether the download took place over IPv4 or IPv6 -- **NumberOfApplicationsCategoryScanEvaluated** The number of categories (apps) for which an app update scan checked -- **ScanDurationInSeconds** The number of seconds a scan took -- **ScanEnqueueTime** The number of seconds it took to initialize a scan -- **NumberOfLoop** The number of round trips the scan required -- **NumberOfUpdatesEvaluated** The total number of updates which were evaluated as a part of the scan -- **NumberOfNewUpdatesFromServiceSync** The number of updates which were seen for the first time in this scan -- **ServiceUrl** The environment URL a device is configured to scan with +- **ApplicableUpdateInfo** Metadata for the updates which were detected as applicable. +- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. - **IntentPFNs** Intended application-set metadata for atomic update scenarios. +- **NumberOfApplicableUpdates** The number of updates ultimately deemed applicable to the system after the detection process is complete. +- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one. +- **ServiceGuid** An ID that represents which service the software distribution client is connecting to (Windows Update, Windows Store, etc.). +- **WUDeviceID** The unique device ID controlled by the software distribution client. ### SoftwareUpdateClientTelemetry.UpdateMetadataIntegrity @@ -3536,94 +3982,112 @@ This event identifies whether updates have been tampered with and protects again The following fields are available: +- **EndpointUrl** The endpoint URL where the device obtains update metadata. This is used to distinguish between test, staging, and production environments. - **EventScenario** The purpose of this event, such as scan started, scan succeeded, or scan failed. -- **ServiceGuid** Identifies the service to which the software distribution client is connected, Example: Windows Update or Microsoft Store -- **MetadataIntegrityMode** The mode of the transport metadata integrity check. 0 = unknown; 1 = ignore; 2 = audit; 3 = enforce -- **StatusCode** The status code of the event. - **ExtendedStatusCode** The secondary status code of the event. -- **RevisionId** The revision ID for a specific piece of content. -- **UpdateId** The update ID for a specific piece of content. -- **RevisionNumber** The revision number for a specific piece of content. -- **TimestampTokenId** The time this was created. It is encoded in a timestamp blob and will be zero if the token is malformed. - **LeafCertId** Integral ID from the FragmentSigning data for certificate that failed. -- **SHA256OfLeafCertPublicKey** A base64 encoding of the hash of the Base64CertData in the FragmentSigning data of the leaf certificate. +- **ListOfSHA256OfIntermediateCerData** A semicolon delimited list of base64 encoding of hashes for the Base64CerData in the FragmentSigning data of an intermediate certificate. +- **MetadataIntegrityMode** The mode of the transport metadata integrity check. 0 = unknown; 1 = ignore; 2 = audit; 3 = enforce - **MetadataSignature** A base64-encoded string of the signature associated with the update metadata (specified by revision ID). -- **SignatureAlgorithm** The hash algorithm for the metadata signature. -- **SHA256OfTimestampToken** A base64-encoded string of hash of the timestamp token blob. -- **ValidityWindowInDays** The validity window that's in effect when verifying the timestamp. -- **TimestampTokenCertThumbprint** The thumbprint of the encoded timestamp token. - **RawMode** The raw unparsed mode string from the SLS response. This field is null if not applicable. - **RawValidityWindowInDays** The raw unparsed validity window string in days of the timestamp token. This field is null if not applicable. +- **RevisionId** The revision ID for a specific piece of content. +- **RevisionNumber** The revision number for a specific piece of content. +- **ServiceGuid** Identifies the service to which the software distribution client is connected, Example: Windows Update or Windows Store - **SHA256OfLeafCerData** A base64 encoding of the hash for the Base64CerData in the FragmentSigning data of the leaf certificate. -- **ListOfSHA256OfIntermediateCerData** A semicolon delimited list of base64 encoding of hashes for the Base64CerData in the FragmentSigning data of an intermediate certificate. -- **EndpointUrl** The endpoint URL where the device obtains update metadata. This is used to distinguish between test, staging, and production environments. +- **SHA256OfLeafCertPublicKey** A base64 encoding of the hash of the Base64CertData in the FragmentSigning data of the leaf certificate. +- **SHA256OfTimestampToken** A base64-encoded string of hash of the timestamp token blob. +- **SignatureAlgorithm** The hash algorithm for the metadata signature. - **SLSPrograms** A test program to which a device may have opted in. Example: Insider Fast +- **StatusCode** The status code of the event. +- **TimestampTokenCertThumbprint** The thumbprint of the encoded timestamp token. +- **TimestampTokenId** The time this was created. It is encoded in a timestamp blob and will be zero if the token is malformed. +- **UpdateId** The update ID for a specific piece of content. +- **ValidityWindowInDays** The validity window that's in effect when verifying the timestamp. -## Update Assistant Orchestrator events ->[!NOTE] ->Events from this provider are sent with the installation of KB4023814. For details, see [this support article](https://support.microsoft.com/help/4023814). +## Update Assistant events ### Microsoft.Windows.UpdateAssistant.Orchestrator.BlockingEventId -Event sends basic info on the reason that Windows 10 was not updated due to compatibility issues, previous rollbacks, or admin policies.. +The event sends basic info on the reason that Windows 10 was not updated due to compatibility issues, previous rollbacks, or admin policies. The following fields are available: -- **ApplicabilityBlockedReason** Blocked due to an applicability issue. -- **ClientId** Identification of the current installed version of Update Assistant. -- **TriggerTaskSource** Describes which task launched this instance of Update Assistant. +- **ApplicabilityBlockedReason** Blocked due to an applicability issue. +- **BlockWuUpgrades** The upgrade assistant is currently blocked. +- **clientID** An identification of the current release of Update Assistant. +- **CloverTrail** This device is Clovertrail. +- **DeviceIsMdmManaged** This device is MDM managed. +- **IsNetworkAvailable** If the device network is not available. +- **IsNetworkMetered** If network is metered. +- **IsSccmManaged** This device is SCCM managed. +- **NewlyInstalledOs** OS is newly installed quiet period. +- **PausedByPolicy** Updates are paused by policy. +- **RecoveredFromRS3** Previously recovered from RS3. +- **RS1UninstallActive** Blocked due to an active RS1 uninstall. +- **RS3RollBacks** Exceeded number of allowable RS3 rollbacks. +- **triggerTaskSource** Describe which task launches this instance. +- **WsusManaged** This device is WSUS managed. +- **ZeroExhaust** This device is zero exhaust. + ### Microsoft.Windows.UpdateAssistant.Orchestrator.DeniedLaunchEventId -Event sends basic info on the reason the Windows 10 update was blocked or prevented. +The event sends basic info when a device was blocked or prevented from updating to the latest Windows 10 version. The following fields are available: -- **ClientId** Identification of the current installed version of Update Assistant. -- **DenyReason** Reasons why Update Assistant was prevented from launching. -- **TriggerTaskSource** Describes which task launched this instance of Update Assistant. +- **clientID** An identification of the current release of Update Assistant. +- **denyReason** All the reasons why the Update Assistant was prevented from launching. Bitmask with values from UpdateAssistant.cpp eUpgradeModeReason. +- **triggerTaskSource** Describe which task launches this instance. + ### Microsoft.Windows.UpdateAssistant.Orchestrator.FailedLaunchEventId -Event sends basic info when the Windows 10 Update Assistant tool could not be launched due to an error.. +Event to mark that Update Assistant Orchestrator failed to launch Update Assistant. The following fields are available: -- **ClientId** Identification of the current installed version of Update Assistant. -- **HResult** Error code of the Update Assistant Orchestrator error. -- **TriggerTaskSource** Describes which task launched this instance of Update Assistant. +- **clientID** An identification of the current release of Update Assistant. +- **hResult** Error code of the Update Assistant Orchestrator failure. +- **triggerTaskSource** Describe which task launches this instance. + ### Microsoft.Windows.UpdateAssistant.Orchestrator.FailedOneSettingsQueryEventId -Event sends basic info to signal when the settings related to the Windows 10 update could not be downloaded. +Event indicating One Settings was not queried by update assistant. The following fields are available: -- **ClientId** Identification of the current installed version of Update Assistant. -- **HResult** Error code of the attempted query for the settings. +- **clientID** An identification of the current release of Update Assistant. +- **hResult** Error code of One Settings query failure. + ### Microsoft.Windows.UpdateAssistant.Orchestrator.LaunchEventId -Event sends basic info on whether the device should or should not be updated to the latest Windows 10 version. +This event sends basic information on whether the device should be updated to the latest Windows 10 version. The following fields are available: -- **ClientId** Identification of the current installed version of Update Assistant. -- **LaunchMode** Type of launch performed. -- **LaunchTypeReason** All of the reasons for the type of launch performed. -- **TriggerTaskSource** Describes which task launched this instance of Update Assistant. -- **UALaunchRunCount** Total number of times Update Assistant was launched. +- **autoStartRunCount** The auto start run count of Update Assistant. +- **clientID** The ID of the current release of Update Assistant. +- **launchMode** Indicates the type of launch performed. +- **launchTypeReason** A bitmask of all the reasons for type of launch. +- **triggerTaskSource** Indicates which task launches this instance. +- **UALaunchRunCount** Total number of times Update Assistant launched. + ### Microsoft.Windows.UpdateAssistant.Orchestrator.RestoreEventId -Event sends basic info on whether the Windows 10 update notification had launched previously. +The event sends basic info on whether the Windows 10 update notification has previously launched. The following fields are available: -- **ClientId** Identification of the current installed version of Update Assistant. -- **RestoreReason** All of the reasons for being restored. -- **TriggerTaskSource** Describes which task launched this instance of Update Assistant. +- **clientID** ID of the current release of Update Assistant. +- **restoreReason** All the reasons for the restore. +- **triggerTaskSource** Indicates which task launches this instance. + ## Update events @@ -3633,25 +4097,25 @@ This event sends data during the download request phase of updating Windows. The following fields are available: +- **DeletedCorruptFiles** Indicates if UpdateAgent found any corrupt payload files and whether the payload was deleted. - **ErrorCode** The error code returned for the current download request phase. -- **PackageCountTotal** Total number of packages needed. -- **PackageCountRequired** Number of required packages requested. -- **PackageCountOptional** Number of optional packages requested. -- **ObjectId** Unique value for each Update Agent mode. -- **SessionId** Unique value for each Update Agent mode attempt. -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **Result** Result of the download request phase of update. -- **PackageSizeCanonical** Size of canonical packages in bytes -- **PackageSizeDiff** Size of diff packages in bytes -- **PackageSizeExpress** Size of express packages in bytes - **FlightId** Unique ID for each flight. -- **UpdateId** Unique ID for each update. +- **ObjectId** Unique value for each Update Agent mode. +- **PackageCountOptional** Number of optional packages requested. +- **PackageCountRequired** Number of required packages requested. +- **PackageCountTotal** Total number of packages needed. - **PackageCountTotalCanonical** Total number of canonical packages. - **PackageCountTotalDiff** Total number of diff packages. - **PackageCountTotalExpress** Total number of express packages. +- **PackageSizeCanonical** Size of canonical packages in bytes +- **PackageSizeDiff** Size of diff packages in bytes +- **PackageSizeExpress** Size of express packages in bytes - **RangeRequestState** Represents the state of the download range request. -- **DeletedCorruptFiles** Indicates if UpdateAgent found any corrupt payload files and whether the payload was deleted. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **Result** Result of the download request phase of update. +- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate +- **SessionId** Unique value for each Update Agent mode attempt. +- **UpdateId** Unique ID for each update. ### Update360Telemetry.UpdateAgent_Initialize @@ -3661,15 +4125,15 @@ This event sends data during the initialize phase of updating Windows. The following fields are available: - **ErrorCode** The error code returned for the current initialize phase. -- **SessionData** Contains instructions to update agent for processing FODs and DUICs (Null for other scenarios). -- **UpdateId** Unique ID for each update. - **FlightId** Unique ID for each flight. - **FlightMetadata** Contains the FlightId and the build being flighted. - **ObjectId** Unique value for each Update Agent mode. -- **SessionId** Unique value for each Update Agent mode attempt . -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate - **RelatedCV** Correlation vector value generated from the latest USO scan. - **Result** Result of the initialize phase of update. 0 = Succeeded, 1 = Failed, 2 = Cancelled, 3 = Blocked, 4 = BlockCancelled +- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate +- **SessionData** Contains instructions to update agent for processing FODs and DUICs (Null for other scenarios). +- **SessionId** Unique value for each Update Agent mode attempt . +- **UpdateId** Unique ID for each update. ### Update360Telemetry.UpdateAgent_Install @@ -3679,12 +4143,12 @@ This event sends data during the install phase of updating Windows. The following fields are available: - **ErrorCode** The error code returned for the current install phase. -- **ObjectId** Unique value for each Update Agent mode. -- **SessionId** Unique value for each Update Agent mode attempt. -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **RelatedCV** Correlation vector value generated from the latest scan. -- **Result** Result of the install phase of update. 0 = Succeeded 1 = Failed, 2 = Cancelled, 3 = Blocked, 4 = BlockCancelled - **FlightId** Unique ID for each flight. +- **ObjectId** Unique value for each Update Agent mode. +- **RelatedCV** Correlation vector value generated from the latest scan. +- **Result** Result of the install phase of update. 0 = Succeeded 1 = Failed, 2 = Cancelled, 3 = Blocked, 4 = BlockCancelled +- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate +- **SessionId** Unique value for each Update Agent mode attempt. - **UpdateId** Unique ID for each update. @@ -3694,12 +4158,12 @@ This event sends data for the start of each mode during the process of updating The following fields are available: +- **FlightId** Unique ID for each flight. - **Mode** Indicates that the Update Agent mode that has started. 1 = Initialize, 2 = DownloadRequest, 3 = Install, 4 = Commit - **ObjectId** Unique value for each Update Agent mode. -- **SessionId** Unique value for each Update Agent mode attempt. -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate - **RelatedCV** The correlation vector value generated from the latest scan. -- **FlightId** Unique ID for each flight. +- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate +- **SessionId** Unique value for each Update Agent mode attempt. - **UpdateId** Unique ID for each update. @@ -3709,101 +4173,101 @@ This event sends data during the launching of the setup box when updating Window The following fields are available: -- **Quiet** Indicates whether setup is running in quiet mode. 0 = false 1 = true -- **ObjectId** Unique value for each Update Agent mode. -- **SessionId** Unique value for each Update Agent mode attempt. -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **RelatedCV** Correlation vector value generated from the latest scan. - **FlightId** Unique ID for each flight. -- **UpdateId** Unique ID for each update. -- **SetupMode** Setup mode 1 = predownload, 2 = install, 3 = finalize +- **ObjectId** Unique value for each Update Agent mode. +- **Quiet** Indicates whether setup is running in quiet mode. 0 = false 1 = true +- **RelatedCV** Correlation vector value generated from the latest scan. - **SandboxSize** The size of the sandbox folder on the device. +- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate +- **SessionId** Unique value for each Update Agent mode attempt. +- **SetupMode** Setup mode 1 = predownload, 2 = install, 3 = finalize +- **UpdateId** Unique ID for each update. ## Upgrade events ### Setup360Telemetry.Downlevel -This event sends data indicating that the device has invoked the downlevel phase of the upgrade. It's used to help keep Windows up-to-date and secure. +This event sends data indicating that the device has started the downlevel phase of the upgrade, to help keep Windows up-to-date and secure. The following fields are available: - **ClientId** If using Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, the default value is Media360, but it can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the downlevel OS. +- **HostOsSkuName** The operating system edition which is running Setup360 instance (downlevel OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe. - **ReportId** In the Windows Update scenario, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **WuId** This is the Windows Update Client ID. In the Windows Update scenario, this is the same as the clientId. -- **TestId** A string that uniquely identifies a group of events. -- **State** Exit state of given Setup360 run. Example: succeeded, failed, blocked, cancelled -- **HostOsSkuName** The operating system edition which is running Setup360 instance (downlevel OS). -- **HostOSBuildNumber** The build number of the downlevel OS. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback -- **Setup360Result** The result of Setup360. It's an HRESULT error code that can be used to diagnose errors. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened +- **Setup360Extended** More detailed information about phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360 (for example, Predownload, Install, Finalize, Rollback). +- **Setup360Result** The result of Setup360 (HRESULT used to diagnose errors). +- **Setup360Scenario** The Setup360 flow type (for example, Boot, Media, Update, MCT). - **SetupVersionBuildNumber** The build number of Setup360 (build number of the target OS). +- **State** Exit state of given Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** An ID that uniquely identifies a group of events. +- **WuId** This is the Windows Update Client ID. In the Windows Update scenario, this is the same as the clientId. ### Setup360Telemetry.Finalize -This event sends data indicating that the device has invoked the finalize phase of the upgrade, to help keep Windows up-to-date. +This event sends data indicating that the device has started the phase of finalizing the upgrade, to help keep Windows up-to-date and secure. The following fields are available: - **ClientId** With Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the previous OS. +- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe - **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. -- **TestId** A string to uniquely identify a group of events. -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). -- **HostOSBuildNumber** The build number of the previous OS. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** More detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** ID that uniquely identifies a group of events. +- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. ### Setup360Telemetry.OsUninstall -The event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, the Setup360Telemetry.OSUninstall indicates the outcome of an OS uninstall. +This event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, it indicates the outcome of an OS uninstall. The following fields are available: - **ClientId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the previous OS. +- **HostOsSkuName** The OS edition which is running the Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe. - **ReportId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, this is the GUID for the install.wim. -- **WuId** Windows Update client ID. -- **TestId** A string to uniquely identify a group of events. -- **State** Exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **HostOsSkuName** The OS edition which is running the Setup360 instance (previous OS). -- **HostOSBuildNumber** The build number of the previous OS. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** Detailed information about the phase or action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). +- **State** Exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** ID that uniquely identifies a group of events. +- **WuId** Windows Update client ID. ### Setup360Telemetry.PostRebootInstall -This event sends data indicating that the device has invoked the postrebootinstall phase of the upgrade, to help keep Windows up-to-date. +This event sends data indicating that the device has invoked the post reboot install phase of the upgrade, to help keep Windows up-to-date. The following fields are available: - **ClientId** With Windows Update, this is the Windows Update client ID that is passed to Setup. In Media setup, the default value is Media360, but can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the previous OS. +- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe. - **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as ClientId. -- **TestId** A string to uniquely identify a group of events. -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). -- **HostOSBuildNumber** The build number of the previous OS. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT +- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened - **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback - **Setup360Result** The result of Setup360. This is an HRESULT error code that's used to diagnose errors. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled +- **TestId** A string to uniquely identify a group of events. +- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as ClientId. ### Setup360Telemetry.PreDownloadQuiet @@ -3813,81 +4277,81 @@ This event sends data indicating that the device has invoked the predownload qui The following fields are available: - **ClientId** Using Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. -- **InstanceId** A unique GUID that identifies each instance of setuphost.exe -- **ReportId** Using Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **WuId** This is the Windows Update Client ID. Using Windows Update, this is the same as the clientId. -- **TestId** A string to uniquely identify a group of events. -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, canceled -- **HostOsSkuName** The OS edition which is running Setup360 instance (previous operating system). - **HostOSBuildNumber** The build number of the previous OS. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **HostOsSkuName** The OS edition which is running Setup360 instance (previous operating system). +- **InstanceId** A unique GUID that identifies each instance of setuphost.exe. +- **ReportId** Using Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, canceled. +- **TestId** ID that uniquely identifies a group of events. +- **WuId** This is the Windows Update Client ID. Using Windows Update, this is the same as the clientId. ### Setup360Telemetry.PreDownloadUX -The event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, the Setup360Telemetry.PredownloadUX indicates the outcome of the PredownloadUX portion of the update process. +This event sends data regarding OS Updates and Upgrades from Windows 7.X, Windows 8.X, Windows 10 and RS, to help keep Windows up-to-date and secure. Specifically, it indicates the outcome of the PredownloadUX portion of the update process. The following fields are available: - **ClientId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the previous operating system. +- **HostOsSkuName** The OS edition which is running the Setup360 instance (previous operating system). - **InstanceId** Unique GUID that identifies each instance of setuphost.exe. - **ReportId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, this is the GUID for the install.wim. -- **WuId** Windows Update client ID. -- **TestId** A string to uniquely identify a group of events. -- **State** The exit state of the Setup360 run. Example: succeeded, failed, blocked, cancelled -- **HostOsSkuName** The OS edition which is running the Setup360 instance (previous operating system). -- **HostOSBuildNumber** The build number of the previous operating system. -- **Setup360Scenario** The Setup360 flow type. Examplle: Boot, Media, Update, MCT -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of the target OS). +- **State** The exit state of the Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** ID that uniquely identifies a group of events. +- **WuId** Windows Update client ID. ### Setup360Telemetry.PreInstallQuiet -This event sends data indicating that the device has invoked the preinstall quiet phase of the upgrade, to help keep Windows up to date. +This event sends data indicating that the device has invoked the preinstall quiet phase of the upgrade, to help keep Windows up-to-date. The following fields are available: - **ClientId** With Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the previous OS. +- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe - **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. -- **TestId** A string to uniquely identify a group of events. -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). -- **HostOSBuildNumber** The build number of the previous OS. -- **Setup360Scenario** Setup360 flow type (Boot, Media, Update, MCT) -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback etc. +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened +- **Setup360Scenario** Setup360 flow type (Boot, Media, Update, MCT). - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** A string to uniquely identify a group of events. +- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. ### Setup360Telemetry.PreInstallUX -This event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, the Setup360Telemetry.PreinstallUX indicates the outcome of the PreinstallUX portion of the update process. +This event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10, to help keep Windows up-to-date. Specifically, it indicates the outcome of the PreinstallUX portion of the update process. The following fields are available: - **ClientId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the previous OS. +- **HostOsSkuName** The OS edition which is running the Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe. - **ReportId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, this is the GUID for the install.wim. -- **WuId** Windows Update client ID. -- **TestId** A string to uniquely identify a group of events. -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **HostOsSkuName** The OS edition which is running the Setup360 instance (previous OS). -- **HostOSBuildNumber** The build number of the previous OS. -- **Setup360Scenario** The Setup360 flow type, Example: Boot, Media, Update, MCT -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened +- **Setup360Scenario** The Setup360 flow type, Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** A string to uniquely identify a group of events. +- **WuId** Windows Update client ID. ### Setup360Telemetry.Setup360 @@ -3896,13 +4360,19 @@ This event sends data about OS deployment scenarios, to help keep Windows up-to- The following fields are available: +- **ClientId** Retrieves the upgrade ID. In the Windows Update scenario, this will be the Windows Update client ID. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **FieldName** Retrieves the data point. +- **FlightData** Specifies a unique identifier for each group of Windows Insider builds. - **InstanceId** Retrieves a unique identifier for each instance of a setup session. - **ReportId** Retrieves the report ID. -- **FlightData** Specifies a unique identifier for each group of Windows Insider builds. - **ScenarioId** Retrieves the deployment scenario. -- **FieldName** Retrieves the data point. - **Value** Retrieves the value associated with the corresponding FieldName. -- **ClientId** Retrieves the upgrade ID: Upgrades via Windows Update - specifies the WU clientID. All other deployment - static string. + + +### Setup360Telemetry.Setup360DynamicUpdate + +This event helps determine whether the device received supplemental content during an operating system upgrade, to help keep Windows up-to-date. + ### Setup360Telemetry.UnexpectedEvent @@ -3912,18 +4382,18 @@ This event sends data indicating that the device has invoked the unexpected even The following fields are available: - **ClientId** With Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the previous OS. +- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe - **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. -- **TestId** A string to uniquely identify a group of events. -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). -- **HostOSBuildNumber** The build number of the previous OS. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback -- **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. +- **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used used to diagnose errors. +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** A string to uniquely identify a group of events. +- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. ## Windows Error Reporting events @@ -3934,19 +4404,25 @@ This event sends binary data from the collected dump file wheneveer a bug check The following fields are available: -- **ReportId** WER Report Id associated with this bug check (used for finding the corresponding report archive in Watson). +- **BootId** Uint32 identifying the boot number for this device. - **BugCheckCode** Uint64 "bugcheck code" that identifies a proximate cause of the bug check. - **BugCheckParameter1** Uint64 parameter providing additional information. -- **BootId** Uint32 identifying the boot number for this device. - **BugCheckParameter2** Uint64 parameter providing additional information. -- **BugCheckParameter4** Uint64 parameter providing additional information. - **BugCheckParameter3** Uint64 parameter providing additional information. -- **IsValidDumpFile** True if the dump file is valid for the debugger, false otherwise -- **DumpFileSize** Size of the dump file +- **BugCheckParameter4** Uint64 parameter providing additional information. - **DumpFileAttributes** Codes that identify the type of data contained in the dump file +- **DumpFileSize** Size of the dump file +- **IsValidDumpFile** True if the dump file is valid for the debugger, false otherwise +- **ReportId** WER Report Id associated with this bug check (used for finding the corresponding report archive in Watson). + + +## Windows Store events + +### Microsoft.Windows.Store.Partner.ReportApplication + +Report application event for Windows Store client. -## Microsoft Store events ### Microsoft.Windows.StoreAgent.Telemetry.AbortedInstallation @@ -3954,24 +4430,24 @@ This event is sent when an installation or update is canceled by a user or the s The following fields are available: -- **PFN** The product family name of the product being installed. +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** Number of retry attempts before it was canceled. +- **BundleId** The Item Bundle ID. +- **CategoryId** The Item Category ID. - **ClientAppId** The identity of the app that initiated this operation. - **HResult** The result code of the last action performed before this operation. -- **IsUpdate** Flag indicating if this is an update. -- **AttemptNumber** Number of retry attempts before it was canceled. -- **CategoryId** The Item Category ID. -- **ProductId** The identity of the package or packages being installed. +- **IsBundle** Is this a bundle? - **IsInteractive** Was this requested by a user? -- **IsRemediation** Was this a remediation install? -- **BundleId** The Item Bundle ID. - **IsMandatory** Was this a mandatory update? +- **IsRemediation** Was this a remediation install? +- **IsRestore** Is this automatically restoring a previously acquired product? +- **IsUpdate** Flag indicating if this is an update. +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The product family name of the product being installed. +- **ProductId** The identity of the package or packages being installed. - **SystemAttemptNumber** The total number of automatic attempts at installation before it was canceled. - **UserAttemptNumber** The total number of user attempts at installation before it was canceled. -- **IsRestore** Is this automatically restoring a previously acquired product? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **IsBundle** Is this a bundle? -- **WUContentId** The Windows Update content ID -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **WUContentId** Licensing identity of this package. ### Microsoft.Windows.StoreAgent.Telemetry.BeginGetInstalledContentIds @@ -3992,40 +4468,40 @@ This event is sent when an app update or installation is canceled while in inter The following fields are available: -- **IsInteractive** Was this requested by a user? +- **AggregatedPackageFullNames** The names of all package or packages to be downloaded and installed. - **AttemptNumber** Total number of installation attempts. - **BundleId** The identity of the Windows Insider build that is associated with this product. -- **PreviousHResult** The previous HResult code. -- **ClientAppId** The identity of the app that initiated this operation. - **CategoryId** The identity of the package or packages being installed. -- **PFN** The name of all packages to be downloaded and installed. -- **ProductId** The name of the package or packages requested for installation. -- **IsUpdate** Is this a product update? -- **IsRemediation** Is this repairing a previous installation? -- **RelatedCV** Correlation Vector of a previous performed action on this product. -- **PreviousInstallState** Previous installation state before it was canceled. +- **ClientAppId** The identity of the app that initiated this operation. +- **IsBundle** Is this a bundle? +- **IsInteractive** Was this requested by a user? - **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this an automatic restore of a previously acquired product? +- **IsUpdate** Is this a product update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of all packages to be downloaded and installed. +- **PreviousHResult** The previous HResult code. +- **PreviousInstallState** Previous installation state before it was canceled. +- **ProductId** The name of the package or packages requested for installation. +- **RelatedCV** Correlation Vector of a previous performed action on this product. - **SystemAttemptNumber** Total number of automatic attempts to install before it was canceled. - **UserAttemptNumber** Total number of user attempts to install before it was canceled. -- **IsRestore** Is this an automatic restore of a previously acquired product? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **IsBundle** Is this a bundle? -- **WUContentId** The Windows Update content ID -- **AggregatedPackageFullNames** The names of all package or packages to be downloaded and installed. +- **WUContentId** The Windows Update content ID. ### Microsoft.Windows.StoreAgent.Telemetry.CompleteInstallOperationRequest -This event is sent after the app installations or updates. It's used to help keep Windows up-to-date and secure +This event is sent at the end of app installations or updates to help keep Windows up-to-date and secure. The following fields are available: +- **CatalogId** The Store Product ID of the app being installed. +- **HResult** HResult code of the action being performed. - **IsBundle** Is this a bundle? +- **PackageFamilyName** The name of the package being installed. - **ProductId** The Store Product ID of the product being installed. - **SkuId** Specific edition of the item being installed. -- **CatalogId** The Store Product ID of the app being installed. -- **PackageFamilyName** The name of the package being installed. -- **HResult** HResult code of the action being performed. ### Microsoft.Windows.StoreAgent.Telemetry.EndAcquireLicense @@ -4034,57 +4510,57 @@ This event is sent after the license is acquired when a product is being install The following fields are available: -- **PFN** Product Family Name of the product being installed. -- **HResult** HResult code to show the result of the operation (success/failure). -- **ProductId** The Store Product ID for the product being installed. -- **IsInteractive** Did the user initiate the installation? +- **AggregatedPackageFullNames** Includes a set of package full names for each app that is part of an atomic set. +- **AttemptNumber** The total number of attempts to acquire this product. - **CategoryId** The identity of the package or packages being installed. - **ClientAppId** The identity of the app that initiated this operation. -- **IsRemediation** Is this repairing a previous installation? -- **UpdateId** The update ID (if this is an update) -- **AttemptNumber** The total number of attempts to acquire this product. -- **IsUpdate** Is this an update? -- **IsMandatory** Is this a mandatory update? -- **SystemAttemptNumber** The number of attempts by the system to acquire this product. -- **UserAttemptNumber** The number of attempts by the user to acquire this product -- **IsRestore** Is this happening after a device restore? +- **HResult** HResult code to show the result of the operation (success/failure). - **IsBundle** Is this a bundle? -- **WUContentId** The Windows Update content ID +- **IsInteractive** Did the user initiate the installation? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this happening after a device restore? +- **IsUpdate** Is this an update? - **ParentBundledId** The product's parent bundle ID. -- **AggregatedPackageFullNames** Includes a set of package full names for each app that is part of an atomic set. +- **PFN** Product Family Name of the product being installed. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The number of attempts by the system to acquire this product. +- **UpdateId** The update ID (if this is an update) +- **UserAttemptNumber** The number of attempts by the user to acquire this product +- **WUContentId** The Windows Update content ID. ### Microsoft.Windows.StoreAgent.Telemetry.EndDownload -This event happens during the app update or installation when content is being downloaded at the end of the process to report success or failure. It's used to help keep Windows up-to-date and secure. +This event is sent after an app is downloaded to help keep Windows up-to-date and secure. The following fields are available: -- **PFN** The Product Family Name of the app being download. -- **IsRemediation** Is this repairing a previous installation? -- **DownloadSize** The total size of the download. -- **ClientAppId** The identity of the app that initiated this operation. -- **CategoryId** The identity of the package or packages being installed. -- **IsUpdate** Is this an update? -- **HResult** The result code of the last action performed. -- **IsInteractive** Is this initiated by the user? +- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. - **AttemptNumber** Number of retry attempts before it was canceled. - **BundleId** The identity of the Windows Insider build associated with this product. -- **ProductId** The Store Product ID for the product being installed. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **DownloadSize** The total size of the download. +- **ExtendedHResult** Any extended HResult error codes. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this initiated by the user? - **IsMandatory** Is this a mandatory installation? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this a restore of a previously acquired product? +- **IsUpdate** Is this an update? +- **ParentBundleId** The parent bundle ID (if it's part of a bundle). +- **PFN** The Product Family Name of the app being download. +- **ProductId** The Store Product ID for the product being installed. - **SystemAttemptNumber** The number of attempts by the system to download. - **UserAttemptNumber** The number of attempts by the user to download. -- **IsRestore** Is this a restore of a previously acquired product? -- **ParentBundleId** The parent bundle ID (if it's part of a bundle). -- **IsBundle** Is this a bundle? - **WUContentId** The Windows Update content ID. -- **ExtendedHResult** Any extended HResult error codes. -- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. ### Microsoft.Windows.StoreAgent.Telemetry.EndFrameworkUpdate -This event happens when an app update requires an updated Framework package and the process starts to download it. It's used to help keep Windows up-to-date and secure. +This event is sent when an app update requires an updated Framework package and the process starts to download it. It is used to help keep Windows up-to-date and secure. The following fields are available: @@ -4102,29 +4578,29 @@ The following fields are available: ### Microsoft.Windows.StoreAgent.Telemetry.EndInstall -This event is sent after a product has been installed. It's used to help keep Windows up-to-date and secure. +This event is sent after a product has been installed to help keep Windows up-to-date and secure. The following fields are available: -- **BundleId** The identity of the build associated with this product. -- **PFN** Product Family Name of the product being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **CategoryId** The identity of the package or packages being installed. -- **ProductId** The Store Product ID for the product being installed. +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. - **AttemptNumber** The number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **ExtendedHResult** The extended HResult error code. - **HResult** The result code of the last action performed. -- **IsRemediation** Is this repairing a previous installation? +- **IsBundle** Is this a bundle? - **IsInteractive** Is this an interactive installation? -- **IsUpdate** Is this an update? - **IsMandatory** Is this a mandatory installation? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this automatically restoring a previously acquired product? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** Product Family Name of the product being installed. +- **ProductId** The Store Product ID for the product being installed. - **SystemAttemptNumber** The total number of system attempts. - **UserAttemptNumber** The total number of user attempts. -- **IsRestore** Is this automatically restoring a previously acquired product? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **IsBundle** Is this a bundle? -- **WUContentId** The Windows Update content ID -- **ExtendedHResult** The extended HResult error code. -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **WUContentId** The Windows Update content ID. ### Microsoft.Windows.StoreAgent.Telemetry.EndScanForUpdates @@ -4133,63 +4609,63 @@ This event is sent after a scan for product updates to determine if there are pa The following fields are available: +- **ClientAppId** The identity of the app that initiated this operation. - **HResult** The result code of the last action performed. - **IsApplicability** Is this request to only check if there are any applicable packages to install? - **IsInteractive** Is this user requested? -- **ClientAppId** The identity of the app that initiated this operation. - **IsOnline** Is the request doing an online check? ### Microsoft.Windows.StoreAgent.Telemetry.EndSearchUpdatePackages -This event is sent after searching for update packages to install. It's used to help keep Windows up-to-date and secure. +This event is sent after searching for update packages to install. It is used to help keep Windows up-to-date and secure. The following fields are available: -- **IsRemediation** Is this repairing a previous installation? -- **IsUpdate** Is this an update? -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** The result code of the last action performed. -- **ProductId** The Store Product ID for the product being installed. +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. - **AttemptNumber** The total number of retry attempts before it was canceled. -- **IsInteractive** Is this user requested? -- **PFN** The name of the package or packages requested for install. - **BundleId** The identity of the build associated with this product. - **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this user requested? - **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of the package or packages requested for install. +- **ProductId** The Store Product ID for the product being installed. - **SystemAttemptNumber** The total number of system attempts. - **UserAttemptNumber** The total number of user attempts. -- **IsRestore** Is this restoring previously acquired content? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **IsBundle** Is this a bundle? -- **WUContentId** The Windows Update content ID -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **WUContentId** The Windows Update content ID. ### Microsoft.Windows.StoreAgent.Telemetry.EndStageUserData -This event is sent between download and installation to see if there is app data that needs to be restored from the cloud. It's used to keep Windows up-to-date and secure. +This event is sent after restoring user data (if any) that needs to be restored following a product install. It is used to keep Windows up-to-date and secure. The following fields are available: -- **IsInteractive** Is this user requested? -- **PFN** The name of the package or packages requested for install. -- **IsUpdate** Is this an update? -- **CategoryId** The identity of the package or packages being installed. -- **HResult** The result code of the last action performed. +- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. - **AttemptNumber** The total number of retry attempts before it was canceled. -- **ProductId** The Store Product ID for the product being installed. - **BundleId** The identity of the build associated with this product. -- **IsRemediation** Is this repairing a previous installation? +- **CategoryId** The identity of the package or packages being installed. - **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this user requested? - **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of the package or packages requested for install. +- **ProductId** The Store Product ID for the product being installed. - **SystemAttemptNumber** The total number of system attempts. - **UserAttemptNumber** The total number of system attempts. -- **IsRestore** Is this restoring previously acquired content? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **IsBundle** Is this a bundle? -- **WUContentId** The Windows Update content ID -- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. +- **WUContentId** The Windows Update content ID. ### Microsoft.Windows.StoreAgent.Telemetry.EndUpdateMetadataPrepare @@ -4203,100 +4679,100 @@ The following fields are available: ### Microsoft.Windows.StoreAgent.Telemetry.FulfillmentComplete -This event is sent at the end of an app install or update and is used to track the very end of the install or update process. +This event is sent at the end of an app install or update to help keep Windows up-to-date and secure. The following fields are available: -- **ProductId** The product ID of the app that is being updated or installed. -- **PFN** The Package Family Name of the app that is being installed or updated. -- **FailedRetry** Was the installation or update retry successful? +- **FailedRetry** Indicates whether the installation or update retry was successful. - **HResult** The HResult code of the operation. +- **PFN** The Package Family Name of the app that is being installed or updated. +- **ProductId** The product ID of the app that is being updated or installed. ### Microsoft.Windows.StoreAgent.Telemetry.FulfillmentInitiate -This event is sent at the beginning of an app install or update and is used to track the very beginning of the install or update process. +This event is sent at the beginning of an app install or update to help keep Windows up-to-date and secure. The following fields are available: -- **ProductId** The product ID of the app that is being updated or installed. - **PFN** The Package Family Name of the app that is being installed or updated. +- **ProductId** The product ID of the app that is being updated or installed. ### Microsoft.Windows.StoreAgent.Telemetry.InstallOperationRequest -This event happens at the beginning of the install process when an app update or new app is installed. It's used to help keep Windows up-to-date and secure. +This event is sent when a product install or update is initiated, to help keep Windows up-to-date and secure. The following fields are available: -- **CatalogId** If this product is from a private catalog, the Store Product ID for the product being installed. - **BundleId** The identity of the build associated with this product. -- **SkuId** Specific edition ID being installed. +- **CatalogId** If this product is from a private catalog, the Store Product ID for the product being installed. - **ProductId** The Store Product ID for the product being installed. +- **SkuId** Specific edition ID being installed. - **VolumePath** The disk path of the installation. ### Microsoft.Windows.StoreAgent.Telemetry.PauseInstallation -This event is sent when a product install or update is paused either by a user or the system. It's used to help keep Windows up-to-date and secure. +This event is sent when a product install or update is paused (either by a user or the system), to help keep Windows up-to-date and secure. The following fields are available: -- **RelatedCV** Correlation Vector of a previous performed action on this product. -- **IsRemediation** Is this repairing a previous installation? -- **PreviousHResult** The result code of the last action performed before this operation. -- **ProductId** The Store Product ID for the product being installed. -- **IsUpdate** Is this an update? -- **PreviousInstallState** Previous state before the installation or update was paused. +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** The total number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. - **CategoryId** The identity of the package or packages being installed. - **ClientAppId** The identity of the app that initiated this operation. -- **AttemptNumber** The total number of retry attempts before it was canceled. +- **IsBundle** Is this a bundle? - **IsInteractive** Is this user requested? -- **BundleId** The identity of the build associated with this product. -- **PFN** The Product Full Name. - **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The Product Full Name. +- **PreviousHResult** The result code of the last action performed before this operation. +- **PreviousInstallState** Previous state before the installation or update was paused. +- **ProductId** The Store Product ID for the product being installed. +- **RelatedCV** Correlation Vector of a previous performed action on this product. - **SystemAttemptNumber** The total number of system attempts. - **UserAttemptNumber** The total number of user attempts. -- **IsRestore** Is this restoring previously acquired content? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **IsBundle** Is this a bundle? -- **WUContentId** The Windows Update content ID -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **WUContentId** The Windows Update content ID. ### Microsoft.Windows.StoreAgent.Telemetry.ResumeInstallation -This event happens when a product install or update is resumed either by a user or the system. It's used to help keep Windows up-to-date and secure. +This event is sent when a product install or update is resumed (either by a user or the system), to help keep Windows up-to-date and secure. The following fields are available: -- **RelatedCV** Correlation Vector for the original install before it was resumed. +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. - **AttemptNumber** The number of retry attempts before it was canceled. - **BundleId** The identity of the build associated with this product. -- **PreviousHResult** The previous HResult error code. -- **ClientAppId** The identity of the app that initiated this operation. - **CategoryId** The identity of the package or packages being installed. -- **PFN** The name of the package or packages requested for install. -- **IsUpdate** Is this an update? -- **PreviousInstallState** Previous state before the installation was paused. -- **IsRemediation** Is this repairing a previous installation? +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed before this operation. +- **IsBundle** Is this a bundle? - **IsInteractive** Is this user requested? -- **ProductId** The Store Product ID for the product being installed. - **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **IsUserRetry** Did the user initiate the retry? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of the package or packages requested for install. +- **PreviousHResult** The previous HResult error code. +- **PreviousInstallState** Previous state before the installation was paused. +- **ProductId** The Store Product ID for the product being installed. +- **RelatedCV** Correlation Vector for the original install before it was resumed. - **SystemAttemptNumber** The total number of system attempts. - **UserAttemptNumber** The total number of user attempts. -- **IsRestore** Is this restoring previously acquired content? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **IsBundle** Is this a bundle? -- **WUContentId** The Windows Update content ID -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. -- **IsUserRetry** Did the user initiate the retry? -- **HResult** The result code of the last action performed before this operation. +- **WUContentId** The Windows Update content ID. ### Microsoft.Windows.StoreAgent.Telemetry.ResumeOperationRequest -This event happens when a product install or update is resumed by a user and on installation retries. It's used to help keep Windows up-to-date and secure. +This event is sent when a product install or update is resumed by a user or on installation retries, to help keep Windows up-to-date and secure. The following fields are available: @@ -4305,22 +4781,22 @@ The following fields are available: ### Microsoft.Windows.StoreAgent.Telemetry.SearchForUpdateOperationRequest -This event is sent when searching for update packages to install. It's used to help keep Windows up-to-date and secure. +This event is sent when searching for update packages to install, to help keep Windows up-to-date and secure. The following fields are available: +- **CatalogId** The Store Catalog ID for the product being installed. - **ProductId** The Store Product ID for the product being installed. - **SkuId** Specfic edition of the app being updated. -- **CatalogId** The Store Product ID for the product being installed. ### Microsoft.Windows.StoreAgent.Telemetry.UpdateAppOperationRequest -This event happens an app for a user needs to be updated. It's used to help keep Windows up-to-date and secure. +This event occurs when an update is requested for an app, to help keep Windows up-to-date and secure. The following fields are available: -- **PFamN** The name of the product that is requested for update. +- **PFamN** The name of the app that is requested for update. ## Windows Update Delivery Optimization events @@ -4331,22 +4807,22 @@ This event describes when a download was canceled with Delivery Optimization. It The following fields are available: -- **bytesFromIntPeers** The number of bytes received from peers not in the same LAN or in the same group. -- **fileID** The ID of the file being downloaded. -- **sessionID** The ID of the file download session. -- **scenarioID** The ID of the scenario. -- **bytesFromCDN** The number of bytes received from a CDN source. -- **updateID** The ID of the update being downloaded. - **background** Is the download being done in the background? -- **bytesFromPeers** The number of bytes received from a peer in the same LAN. -- **clientTelId** A random number used for device sampling. +- **bytesFromCDN** The number of bytes received from a CDN source. - **bytesFromGroupPeers** The number of bytes received from a peer in the same group. -- **errorCode** The error code that was returned. -- **doErrorCode** The Delivery Optimization error code that was returned. +- **bytesFromIntPeers** The number of bytes received from peers not in the same LAN or in the same group. +- **bytesFromPeers** The number of bytes received from a peer in the same LAN. - **cdnErrorCodes** A list of CDN connection errors since the last FailureCDNCommunication event. - **cdnErrorCounts** The number of times each error in cdnErrorCodes was encountered. +- **clientTelId** A random number used for device sampling. +- **doErrorCode** The Delivery Optimization error code that was returned. +- **errorCode** The error code that was returned. - **experimentId** When running a test, this is used to correlate events that are part of the same test. +- **fileID** The ID of the file being downloaded. - **isVpn** Is the device connected to a Virtual Private Network? +- **scenarioID** The ID of the scenario. +- **sessionID** The ID of the file download session. +- **updateID** The ID of the update being downloaded. - **usedMemoryStream** Did the download use memory streaming? @@ -4356,37 +4832,36 @@ This event describes when a download has completed with Delivery Optimization. I The following fields are available: -- **sessionID** The ID of the download session. -- **scenarioID** The ID of the scenario. -- **bytesFromIntPeers** The number of bytes received from peers not in the same LAN or in the same domain group. -- **updateID** The ID of the update being downloaded. -- **fileSize** The size of the file being downloaded. -- **bytesFromCDN** The number of bytes received from a CDN source. -- **fileID** The ID of the file being downloaded. - **background** Is the download a background download? -- **bytesFromPeers** The number of bytes received from a peer in the same LAN. -- **totalTime** How long did the download take (in seconds)? -- **restrictedUpload** Is the upload restricted? -- **clientTelId** A random number used for device sampling. +- **bytesFromCDN** The number of bytes received from a CDN source. - **bytesFromGroupPeers** The number of bytes received from a peer in the same domain group. -- **downloadMode** The download mode used for this file download session. -- **doErrorCode** The Delivery Optimization error code that was returned. -- **numPeers** The total number of peers used for this download. +- **bytesFromIntPeers** The number of bytes received from peers not in the same LAN or in the same domain group. +- **bytesFromPeers** The number of bytes received from a peer in the same LAN. +- **bytesRequested** The total number of bytes requested for download. - **cdnConnectionCount** The total number of connections made to the CDN. -- **lanConnectionCount** The total number of connections made to peers in the same LAN. -- **groupConnectionCount** The total number of connections made to peers in the same group. -- **internetConnectionCount** The total number of connections made to peers not in the same LAN or the same group. -- **cdnIp** The IP address of the source CDN. -- **downlinkBps** The maximum measured available download bandwidth (in bytes per second). -- **uplinkBps** The maximum measured available upload bandwidth (in bytes per second). -- **downlinkUsageBps** The download speed (in bytes per second). -- **uplinkUsageBps** The upload speed (in bytes per second). -- **totalTimeMs** Duration of the download (in seconds). - **cdnErrorCodes** A list of CDN connection errors since the last FailureCDNCommunication event. - **cdnErrorCounts** The number of times each error in cdnErrorCodes was encountered. -- **bytesRequested** The total number of bytes requested for download. +- **cdnIp** The IP address of the source CDN. +- **clientTelId** A random number used for device sampling. +- **doErrorCode** The Delivery Optimization error code that was returned. +- **downlinkBps** The maximum measured available download bandwidth (in bytes per second). +- **downlinkUsageBps** The download speed (in bytes per second). +- **downloadMode** The download mode used for this file download session. - **experimentId** When running a test, this is used to correlate with other events that are part of the same test. +- **fileID** The ID of the file being downloaded. +- **fileSize** The size of the file being downloaded. +- **groupConnectionCount** The total number of connections made to peers in the same group. +- **internetConnectionCount** The total number of connections made to peers not in the same LAN or the same group. - **isVpn** Is the device connected to a Virtual Private Network? +- **lanConnectionCount** The total number of connections made to peers in the same LAN. +- **numPeers** The total number of peers used for this download. +- **restrictedUpload** Is the upload restricted? +- **scenarioID** The ID of the scenario. +- **sessionID** The ID of the download session. +- **totalTimeMs** Duration of the download (in seconds). +- **updateID** The ID of the update being downloaded. +- **uplinkBps** The maximum measured available upload bandwidth (in bytes per second). +- **uplinkUsageBps** The upload speed (in bytes per second). - **usedMemoryStream** Did the download use memory streaming? @@ -4396,48 +4871,48 @@ This event represents a temporary suspension of a download with Delivery Optimiz The following fields are available: -- **updateID** The ID of the update being paused. -- **errorCode** The error code that was returned. -- **scenarioID** The ID of the scenario. - **background** Is the download a background download? -- **sessionID** The ID of the download session. - **clientTelId** A random number used for device sampling. -- **reasonCode** The reason for pausing the download. -- **fileID** The ID of the file being paused. +- **errorCode** The error code that was returned. - **experimentId** When running a test, this is used to correlate with other events that are part of the same test. +- **fileID** The ID of the file being paused. - **isVpn** Is the device connected to a Virtual Private Network? +- **reasonCode** The reason for pausing the download. +- **scenarioID** The ID of the scenario. +- **sessionID** The ID of the download session. +- **updateID** The ID of the update being paused. ### Microsoft.OSG.DU.DeliveryOptClient.DownloadStarted -This event describes the start of a new download with Delivery Optimization. It's used to understand and address problems regarding downloads. +This event sends data describing the start of a new download to enable Delivery Optimization. It's used to understand and address problems regarding downloads. The following fields are available: -- **experimentId** When running a test, this is used to correlate with other events that are part of the same test. -- **errorCode** The error code that was returned. -- **doErrorCode** The Delivery Optimization error code that was returned. -- **peerID** The ID for this Delivery Optimization client. -- **doClientVersion** The version of the Delivery Optimization client. -- **jobID** The ID of the Windows Update job. -- **sessionID** The ID of the download session. -- **updateID** The ID of the update being downloaded. -- **scenarioID** The ID of the scenario. -- **fileID** The ID of the file being downloaded. -- **cdnUrl** The URL of the CDN. -- **filePath** The path where the file will be written. -- **groupID** ID for the group. -- **background** Is the download a background download? -- **downloadMode** The download mode used for this file download session. -- **minFileSizePolicy** The minimum content file size policy to allow the download using Peering. -- **diceRoll** The dice roll value used in sampling events. -- **deviceProfile** Identifies the usage or form factor. Example: Desktop or Xbox -- **isVpn** Is the device connected to a Virtual Private Network? -- **usedMemoryStream** Did the download use memory streaming? -- **minDiskSizePolicyEnforced** Is the minimum disk size enforced via policy? -- **minDiskSizeGB** The minimum disk size (in GB) required for Peering. +- **background** Indicates whether the download is happening in the background. +- **cdnUrl** The URL of the source CDN. - **clientTelId** A random number used for device sampling. - **costFlags** A set of flags representing network cost. +- **deviceProfile** Identifies the usage or form factor (such as Desktop, Xbox, or VM). +- **diceRoll** Random number used for determining if a client will use peering. +- **doClientVersion** The version of the Delivery Optimization client. +- **doErrorCode** The Delivery Optimization error code that was returned. +- **downloadMode** The download mode used for this file download session (CdnOnly = 0, Lan = 1, Group = 2, Internet = 3, Simple = 99, Bypass = 100). +- **errorCode** The error code that was returned. +- **experimentId** ID used to correlate client/services calls that are part of the same test during A/B testing. +- **fileID** The ID of the file being downloaded. +- **filePath** The path to where the downloaded file will be written. +- **groupID** ID for the group. +- **isVpn** Indicates whether the device is connected to a Virtual Private Network. +- **jobID** The ID of the Windows Update job. +- **minDiskSizeGB** The minimum disk size (in GB) policy set for the device to allow peering with delivery optimization. +- **minDiskSizePolicyEnforced** Indicates whether there is an enforced minimum disk size requirement for peering. +- **minFileSizePolicy** The minimum content file size policy to allow the download using peering with delivery optimization. +- **peerID** The ID for this delivery optimization client. +- **scenarioID** The ID of the scenario. +- **sessionID** The ID for the file download session. +- **updateID** The ID of the update being downloaded. +- **usedMemoryStream** Indicates whether the download used memory streaming. ### Microsoft.OSG.DU.DeliveryOptClient.FailureCdnCommunication @@ -4446,19 +4921,19 @@ This event represents a failure to download from a CDN with Delivery Optimizatio The following fields are available: +- **cdnHeaders** The HTTP headers returned by the CDN. +- **cdnIp** The IP address of the CDN. +- **cdnUrl** The URL of the CDN. +- **clientTelId** A random number used for device sampling. +- **errorCode** The error code that was returned. +- **errorCount** The total number of times this error code was seen since the last FailureCdnCommunication event was encountered. - **experimentId** When running a test, this is used to correlate with other events that are part of the same test. - **fileID** The ID of the file being downloaded. -- **errorCode** The error code that was returned. - **httpStatusCode** The HTTP status code returned by the CDN. -- **errorCount** The total number of times this error code was seen since the last FailureCdnCommunication event was encountered. -- **sessionID** The ID of the download session. -- **cdnUrl** The URL of the CDN. -- **cdnIp** The IP address of the CDN. -- **cdnHeaders** The HTTP headers returned by the CDN. -- **clientTelId** A random number used for device sampling. - **isHeadRequest** The type of HTTP request that was sent to the CDN. Example: HEAD or GET - **requestSize** The size of the range requested from the CDN. - **responseSize** The size of the range response received from the CDN. +- **sessionID** The ID of the download session. ### Microsoft.OSG.DU.DeliveryOptClient.JobError @@ -4467,11 +4942,11 @@ This event represents a Windows Update job error. It allows for investigation of The following fields are available: -- **jobID** The Windows Update job ID. -- **fileID** The ID of the file being downloaded. -- **errorCode** The error code returned. - **clientTelId** A random number used for device sampling. +- **errorCode** The error code returned. - **experimentId** When running a test, this is used to correlate with other events that are part of the same test. +- **fileID** The ID of the file being downloaded. +- **jobID** The Windows Update job ID. ## Windows Update events @@ -4482,11 +4957,11 @@ This event sends data collected at the end of the Data Migration Framework (DMF) The following fields are available: -- **MigrationEndtime** A system timestamp of when the DMF migration completed. -- **UpdateIds** A collection of GUIDs for updates that are associated with the DMF session. -- **WuClientid** The GUID of the Windows Update client responsible for triggering the DMF migration. -- **MigrationDurationinmilliseconds** How long the DMF migration took (in milliseconds). +- **MigrationDurationInMilliseconds** How long the DMF migration took (in milliseconds) +- **MigrationEndTime** A system timestamp of when the DMF migration completed. - **RevisionNumbers** A collection of revision numbers for the updates associated with the DMF session. +- **UpdateIds** A collection of GUIDs for updates that are associated with the DMF session. +- **WuClientId** The GUID of the Windows Update client responsible for triggering the DMF migration ### Microsoft.Windows.Update.DataMigrationFramework.DmfMigrationStarted @@ -4495,12 +4970,12 @@ This event sends data collected at the beginning of the Data Migration Framework The following fields are available: -- **UpdateIds** A collection of GUIDs identifying the upgrades that are running. -- **MigrationStarttime** The timestamp representing the beginning of the DMF migration. -- **MigrationOEMphases** The number of OEM-authored migrators scheduled to be ran by DMF for this upgrade. -- **WuClientid** The GUID of the Windows Update client invoking DMF. -- **MigrationMicrosoftphases** The number of Microsoft-authored migrators scheduled to be ran by DMF for this upgrade. +- **MigrationMicrosoftPhases** Revision numbers for the updates that were installed. +- **MigrationOEMPhases** WU Update IDs for the updates that were installed. +- **MigrationStartTime** The timestamp representing the beginning of the DMF migration - **RevisionNumbers** A collection of the revision numbers associated with the UpdateIds. +- **UpdateIds** A collection of GUIDs identifying the upgrades that are running. +- **WuClientId** The GUID of the Windows Update client invoking DMF ### Microsoft.Windows.Update.DataMigrationFramework.MigratorResult @@ -4509,42 +4984,185 @@ This event sends DMF migrator data to help keep Windows up to date. The following fields are available: -- **MigratorGuid** A GUID identifying the migrator that just completed. -- **RunDurationInSeconds** The time it took for the migrator to complete. - **CurrentStep** This is the last step the migrator reported before returning a result. This tells us how far through the individual migrator the device was before failure. -- **MigratorName** The name of the migrator that just completed. -- **MigratorId** A GUID identifying the migrator that just completed. - **ErrorCode** The result (as an HRESULT) of the migrator that just completed. +- **MigratorId** A GUID identifying the migrator that just completed. +- **MigratorName** The name of the migrator that just completed. +- **RunDurationInSeconds** The time it took for the migrator to complete. - **TotalSteps** Migrators report progress in number of completed steps against the total steps. This is the total number of steps. +### Microsoft.Windows.Update.NotificationUx.DialogNotificationToBeDisplayed + +This event indicates that a notification dialog box is about to be displayed to user. + +The following fields are available: + +- **AcceptAutoModeLimit** The maximum number of days for a device to automatically enter Auto Reboot mode. +- **AutoToAutoFailedLimit** The maximum number of days for Auto Reboot mode to fail before the RebootFailed dialog box is shown. +- **DeviceLocalTime** The local time on the device sending the event. +- **EngagedModeLimit** The number of days to switch between DTE dialog boxes. +- **EnterAutoModeLimit** The maximum number of days for a device to enter Auto Reboot mode. +- **ETag** OneSettings versioning value. +- **IsForcedEnabled** Indicates whether Forced Reboot mode is enabled for this device. +- **IsUltimateForcedEnabled** Indicates whether Ultimate Forced Reboot mode is enabled for this device. +- **NotificationUxState** Indicates which dialog box is shown. +- **NotificationUxStateString** Indicates which dialog box is shown. +- **RebootUxState** Indicates the state of the restart (Engaged, Auto, Forced, or UltimateForced). +- **RebootUxStateString** Indicates the state of the restart (Engaged, Auto, Forced, or UltimateForced). +- **RebootVersion** Version of DTE. +- **SkipToAutoModeLimit** The minimum length of time to pass in restart pending before a device can be put into auto mode. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. + + +### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootAcceptAutoDialog + +This event indicates that the Enhanced Engaged restart "accept automatically" dialog box was displayed. + +The following fields are available: + +- **DeviceLocalTime** The local time on the device sending the event. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that user chose on this dialog box. + + +### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootFirstReminderDialog + +This event indicates that the Enhanced Engaged restart "first reminder" dialog box was displayed. + +The following fields are available: + +- **DeviceLocalTime** The local time on the device sending the event. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that user chose in this dialog box. + + +### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootForcedPrecursorDialog + +This event indicates that the Enhanced Engaged restart "forced precursor" dialog box was displayed. + +The following fields are available: + +- **DeviceLocalTime** The local time on the device sending the event. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that the user chose in this dialog box. + + +### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootForcedWarningDialog + +This event indicates that the Enhanced Engaged "forced warning" dialog box was displayed. + +The following fields are available: + +- **DeviceLocalTime** The local time on the device sending the event. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that the user chose in this dialog box. + + +### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootRebootFailedDialog + +This event indicates that the Enhanced Engaged restart "restart failed" dialog box was displayed. + +The following fields are available: + +- **DeviceLocalTime** The local time of the device sending the event. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that the user chose in this dialog box. + + +### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootRebootImminentDialog + +This event indicates that the Enhanced Engaged restart "restart imminent" dialog box was displayed. + +The following fields are available: + +- **DeviceLocalTime** Time the dialog box was shown on the local device. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that user chose in this dialog box. + + +### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootSecondReminderDialog + +This event indicates that the second reminder dialog box was displayed for Enhanced Engaged restart. + +The following fields are available: + +- **DeviceLocalTime** The time the dialog box was shown on the local device. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that the user chose in this dialog box. + + +### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootThirdReminderDialog + +This event indicates that the third reminder dialog box for Enhanced Engaged restart was displayed. + +The following fields are available: + +- **DeviceLocalTime** The time the dialog box was shown on the local device. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that the user chose in this dialog box. + + ### Microsoft.Windows.Update.Orchestrator.CommitFailed -This events tracks when a device needs to restart after an update but did not. +This event indicates that a device was unable to restart after an update. The following fields are available: -- **wuDeviceid** The Windows Update device GUID. - **errorCode** The error code that was returned. +- **wuDeviceid** The Windows Update device GUID. ### Microsoft.Windows.Update.Orchestrator.Detection -This event sends launch data for a Windows Update scan to help keep Windows up to date. +This event indicates that a scan for a Windows Update occurred. The following fields are available: -- **wuDeviceid** Unique device ID used by Windows Update. -- **revisionNumber** Update revision number. -- **eventScenario** End to end update session ID, or indicates the purpose of sending this event - whether because the software distribution just started installing content, or whether it was cancelled, succeeded, or failed. - **deferReason** Reason why the device could not check for updates. - **detectionBlockreason** Reason for detection not completing. -- **interactive** Identifies if session is User Initiated. -- **updateId** Update ID. - **detectionDeferreason** A log of deferral reasons for every update state. -- **flightID** A unique update ID. -- **updateScenarioType** The update session type. - **errorCode** The returned error code. +- **eventScenario** End-to-end update session ID, or indicates the purpose of sending this event - whether because the software distribution just started installing content, or whether it was cancelled, succeeded, or failed. +- **flightID** The specific ID of the Windows Insider build the device is getting. +- **interactive** Indicates whether the session was user initiated. +- **revisionNumber** Update revision number. +- **updateId** Update ID. +- **updateScenarioType** The update session type. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.Download @@ -4553,31 +5171,31 @@ This event sends launch data for a Windows Update download to help keep Windows The following fields are available: +- **deferReason** Reason for download not completing. - **detectionDeferreason** Reason for download not completing -- **wuDeviceid** Unique device ID used by Windows Update. -- **interactive** Identifies if session is user initiated. +- **errorCode** An error code represented as a hexadecimal value. +- **eventScenario** End-to-end update session ID. +- **flightID** The specific ID of the Windows Insider build the device is getting. +- **interactive** Indicates whether the session is user initiated. - **revisionNumber** Update revision number. -- **deferReason** Reason for download not completing - **updateId** Update ID. -- **eventScenario** End to end update session ID. -- **errorCode** An error code represented as a hexadecimal value -- **flightID** Unique update ID. - **updateScenarioType** The update session type. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.FlightInapplicable -This event sends data on whether the update was applicable to the device, to help keep Windows up to date. +This event indicates that the update is no longer applicable to this device. The following fields are available: -- **updateId** Unique Update ID -- **revisionNumber** Revision Number of the Update -- **UpdateStatus** Integer that describes Update state -- **EventPublishedTime** time that the event was generated -- **wuDeviceid** Unique Device ID -- **flightID** Unique Update ID -- **updateScenarioType** The update session type. +- **EventPublishedTime** Time when this event was generated. +- **flightID** The specific ID of the Windows Insider build. +- **revisionNumber** Update revision number. +- **updateId** Unique Windows Update ID. +- **updateScenarioType** Update session type. +- **UpdateStatus** Last status of update. +- **wuDeviceid** Unique Device ID. ### Microsoft.Windows.Update.Orchestrator.InitiatingReboot @@ -4586,15 +5204,15 @@ This event sends data about an Orchestrator requesting a reboot from power manag The following fields are available: -- **revisionNumber** Revision number of the update. - **EventPublishedTime** Time of the event. -- **updateId** Update ID. -- **wuDeviceid** Unique device ID used by Windows Update. - **flightID** Unique update ID -- **interactive** Indicates the reboot initiation stage of the update process was entered as a result of user action or not. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. +- **interactive** Indicates whether the reboot initiation stage of the update process was entered as a result of user action. +- **rebootOutsideOfActiveHours** Indicates whether the reboot was to occur outside of active hours. +- **revisionNumber** Revision number of the update. +- **updateId** Update ID. - **updateScenarioType** The update session type. +- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.Install @@ -4603,59 +5221,59 @@ This event sends launch data for a Windows Update install to help keep Windows u The following fields are available: -- **eventScenario** End to end update session ID. -- **deferReason** Reason for install not completing. -- **interactive** Identifies if session is user initiated. -- **wuDeviceid** Unique device ID used by Windows Update. - **batteryLevel** Current battery capacity in mWh or percentage left. -- **installCommitfailedtime** The time it took for a reboot to happen but the upgrade failed to progress. +- **deferReason** Reason for install not completing. - **errorCode** The error code reppresented by a hexadecimal value. -- **updateId** Update ID. -- **revisionNumber** Update revision number. -- **flightID** Unique update ID -- **installRebootinitiatetime** The time it took for a reboot to be attempted. -- **flightUpdate** Flight update -- **minutesToCommit** The time it took to install updates. +- **eventScenario** End-to-end update session ID. +- **flightID** The specific ID of the Windows Insider build the device is getting. +- **flightUpdate** Indicates whether the update is a Windows Insider build. - **ForcedRebootReminderSet** A boolean value that indicates if a forced reboot will happen for updates. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. +- **installCommitfailedtime** The time it took for a reboot to happen but the upgrade failed to progress. +- **installRebootinitiatetime** The time it took for a reboot to be attempted. +- **interactive** Identifies if session is user initiated. +- **minutesToCommit** The time it took to install updates. +- **rebootOutsideOfActiveHours** Indicates whether a reboot is scheduled outside of active hours. +- **revisionNumber** Update revision number. +- **updateId** Update ID. - **updateScenarioType** The update session type. +- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.PostInstall -This event sends data about lite stack devices (mobile, IOT, anything non-PC) immediately before data migration is launched to help keep Windows up to date. +This event is sent after a Windows update install completes. The following fields are available: -- **wuDeviceid** Unique device ID used by Windows Update. -- **eventScenario** End to end update session ID. -- **sessionType** Interactive vs. Background. -- **bundleRevisionnumber** Bundle revision number. - **batteryLevel** Current battery capacity in mWh or percentage left. -- **bundleId** Update grouping ID. -- **errorCode** Hex code for the error message, to allow lookup of the specific error. +- **bundleId** Identifier associated with the specific content bundle. +- **bundleRevisionnumber** Identifies the revision number of the content bundle. +- **errorCode** The error code returned for the current phase. +- **eventScenario** State of update action. - **flightID** Unique update ID. +- **sessionType** The Windows Update session type (Interactive or Background). +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.RebootFailed -This event sends information about whether an update required a reboot and reasons for failure to help keep Windows up to date. +This event sends information about whether an update required a reboot and reasons for failure, to help keep Windows up to date. The following fields are available: -- **updateId** Update ID. - **batteryLevel** Current battery capacity in mWh or percentage left. -- **RebootResults** Hex code indicating failure reason. Typically, we expect this to be a specific USO generated hex code. -- **installRebootDeferreason** Reason for reboot not occurring. -- **revisionNumber** Update revision number. -- **EventPublishedTime** The time that the reboot failure occurred. - **deferReason** Reason for install not completing. -- **wuDeviceid** Unique device ID used by Windows Update. +- **EventPublishedTime** The time that the reboot failure occurred. - **flightID** Unique update ID. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. +- **installRebootDeferreason** Reason for reboot not occurring. +- **rebootOutsideOfActiveHours** Indicates whether a reboot was scheduled outside of active hours. +- **RebootResults** Hex code indicating failure reason. Typically, we expect this to be a specific USO generated hex code. +- **revisionNumber** Update revision number. +- **updateId** Update ID. - **updateScenarioType** The update session type. +- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.RestoreRebootTask @@ -4665,9 +5283,9 @@ This event sends data indicating that a reboot task is missing unexpectedly on a The following fields are available: - **RebootTaskRestoredTime** Time at which this reboot task was restored. -- **wuDeviceid** Device id on which the reboot is restored - **revisionNumber** Update revision number. - **updateId** Update ID. +- **wuDeviceid** Device ID for the device on which the reboot is restored. ### Microsoft.Windows.Update.Orchestrator.SystemNeeded @@ -4676,14 +5294,14 @@ This event sends data about why a device is unable to reboot, to help keep Windo The following fields are available: -- **eventScenario** End to end update session ID. -- **wuDeviceid** Unique device ID used by Windows Update. -- **systemNeededReason** Reason ID -- **updateId** Update ID. +- **eventScenario** End-to-end update session ID. +- **rebootOutsideOfActiveHours** Indicates whether a reboot is scheduled outside of active hours. - **revisionNumber** Update revision number. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. +- **systemNeededReason** List of apps or tasks that are preventing the system from restarting. +- **updateId** Update ID. - **updateScenarioType** The update session type. +- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.UpdatePolicyCacheRefresh @@ -4692,11 +5310,11 @@ This event sends data on whether Update Management Policies were enabled on a de The following fields are available: +- **configuredPoliciescount** Number of policies on the device. +- **policiesNamevaluesource** Policy name and source of policy (group policy, MDM or flight). +- **policyCacherefreshtime** Time when policy cache was refreshed. +- **updateInstalluxsetting** Indicates whether a user has set policies via a user experience option. - **wuDeviceid** Unique device ID used by Windows Update. -- **policyCacherefreshtime** Refresh time -- **policiesNamevaluesource** Policy Name -- **updateInstalluxsetting** This shows whether a user has set policies via UX option -- **configuredPoliciescount** Policy Count ### Microsoft.Windows.Update.Orchestrator.UpdateRebootRequired @@ -4705,13 +5323,13 @@ This event sends data about whether an update required a reboot to help keep Win The following fields are available: -- **updateId** Update ID. +- **flightID** The specific ID of the Windows Insider build the device is getting. +- **interactive** Indicates whether the reboot initiation stage of the update process was entered as a result of user action. - **revisionNumber** Update revision number. -- **wuDeviceid** Unique device ID used by Windows Update. -- **flightID** Unique update ID. -- **interactive** Indicates the reboot initiation stage of the update process was entered as a result of user action or not. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. +- **updateId** Update ID. - **updateScenarioType** The update session type. +- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.UpdateStackServicing.CheckForUpdates @@ -4720,18 +5338,18 @@ This event sends data about the UpdateStackServicing check for updates, to help The following fields are available: -- **EventScenario** The scenario of the event. Example: Started, Failed, or Succeeded -- **StatusCode** The HRESULT code of the operation. +- **BspVersion** The version of the BSP. - **CallerApplicationName** The name of the USS scheduled task. Example UssScheduled or UssBoot - **ClientVersion** The version of the client. -- **EventInstanceID** The USS session ID. -- **WUDeviceID** The Windows Update device ID. -- **ServiceGuid** The GUID of the service. -- **BspVersion** The version of the BSP. -- **OemName** The name of the manufacturer. -- **DeviceName** The name of the device. - **CommercializationOperator** The name of the operator. - **DetectionVersion** The string returned from the GetDetectionVersion export of the downloaded detection DLL. +- **DeviceName** The name of the device. +- **EventInstanceID** The USS session ID. +- **EventScenario** The scenario of the event. Example: Started, Failed, or Succeeded +- **OemName** The name of the manufacturer. +- **ServiceGuid** The GUID of the service. +- **StatusCode** The HRESULT code of the operation. +- **WUDeviceID** The Windows Update device ID. ### Microsoft.Windows.Update.Ux.MusNotification.RebootNoLongerNeeded @@ -4749,16 +5367,16 @@ This event sends data about a required reboot that is scheduled with no user int The following fields are available: -- **updateId** Update ID of the update that is getting installed with this reboot. -- **ScheduledRebootTime** Time of the scheduled reboot. -- **wuDeviceid** Unique device ID used by Windows Update. -- **revisionNumber** Revision number of the update that is getting installed with this reboot. -- **forcedreboot** True, if a reboot is forced on the device. False, otherwise. +- **activeHoursApplicable** Indicates whether Active Hours applies on this device. +- **forcedReboot** True, if a reboot is forced on the device. Otherwise, this is False - **rebootArgument** Argument for the reboot task. It also represents specific reboot related action. -- **rebootScheduledByUser** True, if a reboot is scheduled by user. False, if a reboot is scheduled automatically. -- **activeHoursApplicable** True, If Active Hours applicable on this device. False, otherwise. - **rebootOutsideOfActiveHours** True, if a reboot is scheduled outside of active hours. False, otherwise. -- **rebootState** The state of the reboot. +- **rebootScheduledByUser** True, if a reboot is scheduled by user. False, if a reboot is scheduled automatically. +- **rebootState** Current state of the reboot. +- **revisionNumber** Revision number of the OS. +- **scheduledRebootTime** Time scheduled for the reboot. +- **updateId** Identifies which update is being scheduled. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Ux.MusNotification.ToastDisplayedToScheduleReboot @@ -4776,16 +5394,16 @@ This event sends basic information for scheduling a device restart to install se The following fields are available: -- **ScheduledRebootTime** The time that the device was restarted. -- **updateId** The Windows Update device GUID. -- **revisionNumber** The revision number of the OS being updated. -- **wuDeviceid** The Windows Update device GUID. -- **forcedreboot** Is the restart that's being scheduled a forced restart? -- **rebootArgument** The arguments that are passed to the OS for the restarted. -- **rebootScheduledByUser** Was the restart scheduled by the user? If the value is false, the restart was scheduled by the device. - **activeHoursApplicable** Is the restart respecting Active Hours? +- **forcedReboot** True, if a reboot is forced on the device. Otherwise, this is False +- **rebootArgument** The arguments that are passed to the OS for the restarted. - **rebootOutsideOfActiveHours** Was the restart scheduled outside of Active Hours? +- **rebootScheduledByUser** Was the restart scheduled by the user? If the value is false, the restart was scheduled by the device. - **rebootState** The state of the restart. +- **revisionNumber** The revision number of the OS being updated. +- **scheduledRebootTime** Time of the scheduled reboot +- **updateId** The Windows Update device GUID. +- **wuDeviceid** The Windows Update device GUID. ## Winlogon events @@ -4796,3 +5414,4 @@ This event signals the completion of the setup process. It happens only once dur + diff --git a/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1709.md b/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1709.md index d9719bbdd6..665450f693 100644 --- a/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1709.md +++ b/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1709.md @@ -1,27 +1,26 @@ --- -description: Learn more about the Windows diagnostic data that is gathered at the basic level. +description: Use this article to learn more about what Windows diagnostic data is gathered at the basic level. title: Windows 10, version 1709 basic diagnostic events and fields (Windows 10) -keywords: privacy, diagnostic data +keywords: privacy, telemetry ms.prod: w10 ms.mktglfcycl: manage ms.sitesec: library ms.pagetype: security localizationpriority: high -author: danihalfin -ms.author: daniha -ms.date: 06/20/2018 +author: brianlic-msft +ms.author: brianlic +ms.date: 09/10/2018 --- # Windows 10, version 1709 basic level Windows diagnostic events and fields - **Applies to** - Windows 10, version 1709 -The Basic level gathers a limited set of information that is critical for understanding the device and its configuration including: basic device information, quality-related information, app compatibility, and Microsoft Store. When the level is set to Basic, it also includes the Security level information. +The Basic level gathers a limited set of information that is critical for understanding the device and its configuration including: basic device information, quality-related information, app compatibility, and Windows Store. When the level is set to Basic, it also includes the Security level information. The Basic level helps to identify problems that can occur on a particular device hardware or software configuration. For example, it can help determine if crashes are more frequent on devices with a specific amount of memory or that are running a particular driver version. This helps Microsoft fix operating system or app problems. @@ -30,340 +29,315 @@ Use this article to learn about diagnostic events, grouped by event area, and th You can learn more about Windows functional and diagnostic data through these articles: -- [Windows 10, version 1803 basic diagnostic events and fields](https://docs.microsoft.com/windows/configuration/basic-level-windows-diagnostic-events-and-fields-1803) -- [Windows 10, version 1703 basic diagnostic events and fields](https://docs.microsoft.com/windows/configuration/basic-level-windows-diagnostic-events-and-fields-1703) -- [Manage connections from Windows operating system components to Microsoft services](https://docs.microsoft.com/windows/configuration/manage-connections-from-windows-operating-system-components-to-microsoft-services) -- [Configure Windows diagnostic data in your organization](https://docs.microsoft.com/windows/configuration/configure-windows-diagnostic-data-in-your-organization) +- [Windows 10, version 1803 basic diagnostic events and fields](basic-level-windows-diagnostic-events-and-fields-1803.md) +- [Windows 10, version 1703 basic diagnostic events and fields](basic-level-windows-diagnostic-events-and-fields-1703.md) +- [Manage connections from Windows operating system components to Microsoft services](manage-connections-from-windows-operating-system-components-to-microsoft-services.md) +- [Configure Windows diagnostic data in your organization](configure-windows-diagnostic-data-in-your-organization.md) -## Common data extensions - -### Common Data Extensions.App - - - -The following fields are available: - -- **expId** Associates a flight, such as an OS flight, or an experiment, such as a web site UX experiment, with an event. -- **userId** The userID as known by the application. -- **env** The environment from which the event was logged. -- **asId** An integer value that represents the app session. This value starts at 0 on the first app launch and increments after each subsequent app launch per boot session. - - -### Common Data Extensions.CS - - - -The following fields are available: - -- **sig** A common schema signature that identifies new and modified event schemas. - - -### Common Data Extensions.CUET - - - -The following fields are available: - -- **stId** Represents the Scenario Entry Point ID. This is a unique GUID for each event in a diagnostic scenario. This used to be Scenario Trigger ID. -- **aId** Represents the ETW ActivityId. Logged via TraceLogging or directly via ETW. -- **raId** Represents the ETW Related ActivityId. Logged via TraceLogging or directly via ETW. -- **op** Represents the ETW Op Code. -- **cat** Represents a bitmask of the ETW Keywords associated with the event. -- **flags** Represents the bitmap that captures various Windows specific flags. -- **cpId** The composer ID, such as Reference, Desktop, Phone, Holographic, Hub, IoT Composer. -- **tickets** A list of strings that represent entries in the HTTP header of the web request that includes this event. -- **bseq** Upload buffer sequence number in the format \:\ -- **mon** Combined monitor and event sequence numbers in the format \:\ - - -### Common Data Extensions.Device - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **localId** Represents a locally defined unique ID for the device, not the human readable device name. Most likely equal to the value stored at HKLM\Software\Microsoft\SQMClient\MachineId -- **deviceClass** Represents the classification of the device, the device “family”.  For example, Desktop, Server, or Mobile. - - -### Common Data Extensions.Envelope - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **name** Represents the uniquely qualified name for the event. -- **time** Represents the event date time in Coordinated Universal Time (UTC) when the event was generated on the client. This should be in ISO 8601 format. -- **popSample** Represents the effective sample rate for this event at the time it was generated by a client. -- **epoch** Represents the epoch and seqNum fields, which help track how many events were fired and how many events were uploaded, and enables identification of data lost during upload and de-duplication of events on the ingress server. -- **seqNum** Represents the sequence field used to track absolute order of uploaded events. It is an incrementing identifier for each event added to the upload queue.  The Sequence helps track how many events were fired and how many events were uploaded and enables identification of data lost during upload and de-duplication of events on the ingress server. -- **iKey** Represents an ID for applications or other logical groupings of events. -- **flags** Represents a collection of bits that describe how the event should be processed by the Connected User Experiences and Telemetry component pipeline. The lowest-order byte is the event persistence. The next byte is the event latency. -- **os** Represents the operating system name. -- **osVer** Represents the OS version, and its format is OS dependent. -- **appId** Represents a unique identifier of the client application currently loaded in the process producing the event; and is used to group events together and understand usage pattern, errors by application. -- **appVer** Represents the version number of the application. Used to understand errors by Version, Usage by Version across an app. -- **cV** Represents the Correlation Vector: A single field for tracking partial order of related diagnostic data events across component boundaries. - - -### Common Data Extensions.OS - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **expId** Represents the experiment ID. The standard for associating a flight, such as an OS flight (pre-release build), or an experiment, such as a web site UX experiment, with an event is to record the flight / experiment IDs in Part A of the common schema. -- **locale** Represents the locale of the operating system. -- **bootId** An integer value that represents the boot session. This value starts at 0 on first boot after OS install and increments after every reboot. - - -### Common Data Extensions.User - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **localId** Represents a unique user identity that is created locally and added by the client. This is not the user's account ID. - - -### Common Data Extensions.XBL - - - -The following fields are available: - -- **nbf** Not before time -- **expId** Expiration time -- **sbx** XBOX sandbox identifier -- **dty** XBOX device type -- **did** XBOX device ID -- **xid** A list of base10-encoded XBOX User IDs. -- **uts** A bit field, with 2 bits being assigned to each user ID listed in xid. This field is omitted if all users are retail accounts. - - -### Common Data Extensions.Consent UI Event - -This User Account Control (UAC) diagnostic data point collects information on elevations that originate from low integrity levels. This occurs when a process running at low integrity level (IL) requires higher (administrator) privileges, and therefore requests for elevation via UAC (consent.exe). By better understanding the processes requesting these elevations, Microsoft can in turn improve the detection and handling of potentially malicious behavior in this path. - -The following fields are available: - -- **eventType** Represents the type of elevation: If it succeeded, was cancelled, or was auto-approved. -- **splitToken** Represents the flag used to distinguish between administrators and standard users. -- **friendlyName** Represents the name of the file requesting elevation from low IL. -- **elevationReason** Represents the distinction between various elevation requests sources (appcompat, installer, COM, MSI and so on). -- **exeName** Represents the name of the file requesting elevation from low IL. -- **signatureState** Represents the state of the signature, if it signed, unsigned, OS signed and so on. -- **publisherName** Represents the name of the publisher of the file requesting elevation from low IL. -- **cmdLine** Represents the full command line arguments being used to elevate. -- **Hash.Length** Represents the length of the hash of the file requesting elevation from low IL. -- **Hash** Represents the hash of the file requesting elevation from low IL. -- **HashAlgId** Represents the algorithm ID of the hash of the file requesting elevation from low IL. -- **telemetryFlags** Represents the details about the elevation prompt for CEIP data. -- **timeStamp** Represents the time stamp on the file requesting elevation. -- **fileVersionMS** Represents the major version of the file requesting elevation. -- **fileVersionLS** Represents the minor version of the file requesting elevation. - - -## Common data fields - -### Common Data Fields.MS.Device.DeviceInventory.Change - -These fields are added whenever Ms.Device.DeviceInventoryChange is included in the event. - -The following fields are available: - -- **syncId** A string used to group StartSync, EndSync, Add, and Remove operations that belong together. This field is unique by Sync period and is used to disambiguate in situations where multiple agents perform overlapping inventories for the same object. -- **objectType** Indicates the object type that the event applies to. -- **Action** The change that was invoked on a device inventory object. -- **inventoryId** Device ID used for Compatibility testing - - -### Common Data Fields.TelClientSynthetic.PrivacySettingsAfterCreatorsUpdate.PreUpgradeSettings - -These fields are added whenever PreUpgradeSettings is included in the event. - -The following fields are available: - -- **HKLM_SensorPermissionState.SensorPermissionState** The state of the Location service before the feature update completed. -- **HKLM_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the device. -- **HKCU_SensorPermissionState.SensorPermissionState** The state of the Location service when a user signs on before the feature update completed. -- **HKCU_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the current user. -- **HKLM_LocationPlatform.Status** The state of the location platform after the feature update has completed. -- **HKLM_LocationPlatform.HRESULT** The error code returned when trying to query the location platform for the device. -- **HKLM_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the device before the feature update completed. -- **HKLM_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the device. -- **HKCU_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the current user before the feature update completed. -- **HKCU_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the current user. -- **HKLM_AllowTelemetry.AllowTelemetry** The state of the Connected User Experiences and Telemetry component for the device before the feature update. -- **HKLM_AllowTelemetry.HRESULT** The error code returned when trying to query the Connected User Experiences and Telemetry conponent for the device. -- **HKLM_TIPC.Enabled** The state of TIPC for the device. -- **HKLM_TIPC.HRESULT** The error code returned when trying to query TIPC for the device. -- **HKCU_TIPC.Enabled** The state of TIPC for the current user. -- **HKCU_TIPC.HRESULT** The error code returned when trying to query TIPC for the current user. -- **HKLM_FlipAhead.FPEnabled** Is Flip Ahead enabled for the device before the feature update was completed? -- **HKLM_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the device. -- **HKCU_FlipAhead.FPEnabled** Is Flip Ahead enabled for the current user before the feature update was completed? -- **HKCU_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the current user. -- **HKLM_TailoredExperiences.TailoredExperiencesWithDiagnosticDataEnabled** Is Tailored Experiences with Diagnostics Data enabled for the current user after the feature update had completed? -- **HKCU_TailoredExperiences.HRESULT** The error code returned when trying to query Tailored Experiences with Diagnostics Data for the current user. -- **HKLM_AdvertisingID.Enabled** Is the adveristing ID enabled for the device? -- **HKLM_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the device. -- **HKCU_AdvertisingID.Enabled** Is the adveristing ID enabled for the current user? -- **HKCU_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the user. - - -### Common Data Fields.TelClientSynthetic.PrivacySettingsAfterCreatorsUpdate.PostUpgradeSettings - -These fields are added whenever PostUpgradeSettings is included in the event. - -The following fields are available: - -- **HKLM_SensorPermissionState.SensorPermissionState** The state of the Location service after the feature update has completed. -- **HKLM_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the device. -- **HKCU_SensorPermissionState.SensorPermissionState** The state of the Location service when a user signs on after a feature update has completed. -- **HKCU_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the current user. -- **HKLM_LocationPlatform.Status** The state of the location platform after the feature update has completed. -- **HKLM_LocationPlatform.HRESULT** The error code returned when trying to query the location platform for the device. -- **HKLM_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the device after the feature update has completed. -- **HKLM_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the device. -- **HKCU_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the current user after the feature update has completed. -- **HKCU_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the current user. -- **HKLM_AllowTelemetry.AllowTelemetry** The state of the Connected User Experiences and Telemetry component for the device after the feature update. -- **HKLM_AllowTelemetry.HRESULT** The error code returned when trying to query the Connected User Experiences and Telemetry conponent for the device. -- **HKLM_TIPC.Enabled** The state of TIPC for the device. -- **HKLM_TIPC.HRESULT** The error code returned when trying to query TIPC for the device. -- **HKCU_TIPC.Enabled** The state of TIPC for the current user. -- **HKCU_TIPC.HRESULT** The error code returned when trying to query TIPC for the current user. -- **HKLM_FlipAhead.FPEnabled** Is Flip Ahead enabled for the device after the feature update has completed? -- **HKLM_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the device. -- **HKCU_FlipAhead.FPEnabled** Is Flip Ahead enabled for the current user after the feature update has completed? -- **HKCU_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the current user. -- **HKLM_TailoredExperiences.TailoredExperiencesWithDiagnosticDataEnabled** Is Tailored Experiences with Diagnostics Data enabled for the current user after the feature update had completed? -- **HKCU_TailoredExperiences.HRESULT** The error code returned when trying to query Tailored Experiences with Diagnostics Data for the current user. -- **HKLM_AdvertisingID.Enabled** Is the adveristing ID enabled for the device? -- **HKLM_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the device. -- **HKCU_AdvertisingID.Enabled** Is the adveristing ID enabled for the current user? -- **HKCU_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the user. - ## Appraiser events -### Microsoft.Windows.Appraiser.General.RunContext +### Microsoft.Windows.Appraiser.General.ChecksumTotalPictureCount -This event indicates what should be expected in the data payload. +Invalid Signature - This event is superseded by an event that contains additional fields. The following fields are available: -- **AppraiserBranch** The source branch in which the currently running version of Appraiser was built. -- **AppraiserProcess** The name of the process that launched Appraiser. -- **AppraiserVersion** The version of the Appraiser file generating the events. -- **Context** Indicates what mode Appraiser is running in. Example: Setup or Diagnostic Data. -- **PCFP** An ID for the system calculated by hashing hardware identifiers. -- **Time** The client time of the event. +- **DatasourceApplicationFile_RS1** An ID for the system, calculated by hashing hardware identifiers. +- **DatasourceApplicationFile_RS4** An ID for the system, calculated by hashing hardware identifiers. +- **DatasourceDevicePnp_RS4** An ID for the system, calculated by hashing hardware identifiers. +- **DatasourceDriverPackage_RS4** The count of the number of this particular object type present on this device. +- **DataSourceMatchingInfoBlock_RS4** The count of the number of this particular object type present on this device. +- **DataSourceMatchingInfoPassive_RS4** The count of the number of this particular object type present on this device. +- **DataSourceMatchingInfoPostUpgrade_RS4** The count of the number of this particular object type present on this device. +- **DatasourceSystemBios_RS4** The count of the number of this particular object type present on this device. +- **DecisionApplicationFile_RS1** An ID for the system, calculated by hashing hardware identifiers. +- **DecisionApplicationFile_RS4** The count of the number of this particular object type present on this device. +- **DecisionDevicePnp_RS4** The count of the number of this particular object type present on this device. +- **DecisionDriverPackage_RS4** The count of the number of this particular object type present on this device. +- **DecisionMatchingInfoBlock_RS4** The count of the number of this particular object type present on this device. +- **DecisionMatchingInfoPassive_RS4** The count of the number of this particular object type present on this device. +- **DecisionMatchingInfoPostUpgrade_RS4** The count of the number of this particular object type present on this device. +- **DecisionMediaCenter_RS4** The count of the number of this particular object type present on this device. +- **DecisionSystemBios_RS4** The total DecisionSystemBios objects targeting Windows 10 version, 1803 present on this device. +- **DecisionTest_RS1** An ID for the system, calculated by hashing hardware identifiers. +- **InventoryApplicationFile** The count of the number of this particular object type present on this device. +- **InventoryLanguagePack** The count of InventoryLanguagePack objects present on this machine. +- **InventoryMediaCenter** The count of the number of this particular object type present on this device. +- **InventorySystemBios** The count of the number of this particular object type present on this device. +- **InventoryTest** The count of the number of this particular object type present on this device. +- **InventoryUplevelDriverPackage** The count of the number of this particular object type present on this device. +- **PCFP** An ID for the system, calculated by hashing hardware identifiers. +- **SystemMemory** The count of the number of this particular object type present on this device. +- **SystemProcessorCompareExchange** The count of the number of this particular object type present on this device. +- **SystemProcessorLahfSahf** The count of the number of this particular object type present on this device. +- **SystemProcessorNx** The count of the number of this particular object type present on this device. +- **SystemProcessorPrefetchW** The count of SystemProcessorPrefetchW objects present on this machine. +- **SystemProcessorSse2** The count of SystemProcessorSse2 objects present on this machine. +- **SystemTouch** The count of SystemTouch objects present on this machine. +- **SystemWim** The count of SystemWim objects present on this machine. +- **SystemWindowsActivationStatus** The count of SystemWindowsActivationStatus objects present on this machine. +- **SystemWlan** The count of the number of this particular object type present on this device. +- **Wmdrm_RS1** An ID for the system, calculated by hashing hardware identifiers. +- **Wmdrm_RS4** The total Wmdrm objects targeting Windows 10, version 1803 present on this device. -### Microsoft.Windows.Appraiser.General.TelemetryRunHealth +### Microsoft.Windows.Appraiser.General.DatasourceApplicationFileAdd -A summary event indicating the parameters and result of a diagnostic data run. This allows the rest of the data sent over the course of the run to be properly contextualized and understood, which is then used to keep Windows up-to-date. +Represents the basic metadata about specific application files installed on the system. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **AppraiserBranch** The source branch in which the version of Appraiser that is running was built. -- **AppraiserDataVersion** The version of the data files being used by the Appraiser diagnostic data run. -- **AppraiserProcess** The name of the process that launched Appraiser. -- **AppraiserVersion** The file version (major, minor and build) of the Appraiser DLL, concatenated without dots. -- **AuxFinal** Obsolete, always set to false -- **AuxInitial** Obsolete, indicates if Appraiser is writing data files to be read by the Get Windows 10 app. -- **DeadlineDate** A timestamp representing the deadline date, which is the time until which appraiser will wait to do a full scan. -- **EnterpriseRun** Indicates if the diagnostic data run is an enterprise run, which means appraiser was run from the command line with an extra enterprise parameter. -- **FullSync** Indicates if Appraiser is performing a full sync, which means that full set of events representing the state of the machine are sent. Otherwise, only the changes from the previous run are sent. -- **InventoryFullSync** Indicates if inventory is performing a full sync, which means that the full set of events representing the inventory of machine are sent. -- **PCFP** An ID for the system calculated by hashing hardware identifiers. -- **PerfBackoff** Indicates if the run was invoked with logic to stop running when a user is present. Helps to understand why a run may have a longer elapsed time than normal. -- **PerfBackoffInsurance** Indicates if appraiser is running without performance backoff because it has run with perf backoff and failed to complete several times in a row. -- **RunAppraiser** Indicates if Appraiser was set to run at all. If this if false, it is understood that data events will not be received from this device. -- **RunDate** The date that the diagnostic data run was stated, expressed as a filetime. -- **RunGeneralTel** Indicates if the generaltel.dll component was run. Generaltel collects additional diagnostic data on an infrequent schedule and only from machines at diagnostic data levels higher than Basic. -- **RunOnline** Indicates if appraiser was able to connect to Windows Update and theefore is making decisions using up-to-date driver coverage information. -- **RunResult** The hresult of the Appraiser diagnostic data run. -- **SendingUtc** Indicates if the Appraiser client is sending events during the current diagnostic data run. -- **StoreHandleIsNotNull** Obsolete, always set to false -- **TelementrySent** Indicates if diagnostic data was successfully sent. -- **ThrottlingUtc** Indicates if the Appraiser client is throttling its output of CUET events to avoid being disabled. This increases runtime but also diagnostic data reliability. -- **Time** The client time of the event. -- **VerboseMode** Indicates if appraiser ran in Verbose mode, which is a test-only mode with extra logging. -- **WhyFullSyncWithoutTablePrefix** Indicates the reason or reasons that a full sync was generated. +- **AppraiserVersion** The version of the appraiser file that is generating the events. +- **AvDisplayName** If the app is an anti-virus app, this is its display name. +- **CompatModelIndex** The compatibility prediction for this file. +- **HasCitData** Indicates whether the file is present in CIT data. +- **HasUpgradeExe** Indicates whether the anti-virus app has an upgrade.exe file. +- **IsAv** Is the file an anti-virus reporting EXE? +- **ResolveAttempted** This will always be an empty string when sending telemetry. +- **SdbEntries** An array of fields that indicates the SDB entries that apply to this file. -### Microsoft.Windows.Appraiser.General.EnterpriseScenarioWithDiagTrackServiceRunning +### Microsoft.Windows.Appraiser.General.DatasourceApplicationFileRemove -The event that indicates that Appraiser has been triggered to run an enterprise scenario while the DiagTrack service is installed. This event can only be sent if a special flag is used to trigger the enterprise scenario. +This event indicates that the DatasourceApplicationFile object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **PCFP** An ID for the system calculated by hashing hardware identifiers. -- **Time** The client time of the event. +- **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.InventoryApplicationFileAdd +### Microsoft.Windows.Appraiser.General.DatasourceApplicationFileStartSync -This event represents the basic metadata about a file on the system. The file must be part of an app and either have a block in the compatibility database or are part of an anti-virus program. +This event indicates that a new set of DatasourceApplicationFileAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DatasourceDevicePnpAdd + +This event sends compatibility data for a Plug and Play device, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **ActiveNetworkConnection** Indicates whether the device is an active network device. +- **AppraiserVersion** The version of the appraiser file generating the events. +- **IsBootCritical** Indicates whether the device boot is critical. +- **WuDriverCoverage** Indicates whether there is a driver uplevel for this device, according to Windows Update. +- **WuDriverUpdateId** The Windows Update ID of the applicable uplevel driver. +- **WuPopulatedFromId** The expected uplevel driver matching ID based on driver coverage from Windows Update. + + +### Microsoft.Windows.Appraiser.General.DatasourceDevicePnpRemove + +This event indicates that the DatasourceDevicePnp object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DatasourceDevicePnpStartSync + +This event indicates that a new set of DatasourceDevicePnpAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DatasourceDriverPackageAdd + +This event sends compatibility database data about driver packages to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the appraiser file generating the events. + + +### Microsoft.Windows.Appraiser.General.DatasourceDriverPackageRemove + +This event indicates that the DatasourceDriverPackage object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DatasourceDriverPackageStartSync + +This event indicates that a new set of DatasourceDriverPackageAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockAdd + +This event sends blocking data about any compatibility blocking entries hit on the system that are not directly related to specific applications or devices, to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the appraiser file generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockRemove + +This event indicates that the DataSourceMatchingInfoBlock object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockStartSync + +This event indicates that a full set of DataSourceMatchingInfoBlockStAdd events have been sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveAdd + +This event sends compatibility database information about non-blocking compatibility entries on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the appraiser file generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveRemove + +This event indicates that the DataSourceMatchingInfoPassive object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveStartSync + +This event indicates that a new set of DataSourceMatchingInfoPassiveAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeAdd + +This event sends compatibility database information about entries requiring reinstallation after an upgrade on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the appraiser file generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeRemove + +This event indicates that the DataSourceMatchingInfoPostUpgrade object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeStartSync + +This event indicates that a new set of DataSourceMatchingInfoPostUpgradeAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DatasourceSystemBiosAdd + +This event sends compatibility database information about the BIOS to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file generating the events. -- **AvDisplayName** If the app is an anti-virus app, this is its display name. -- **AvProductState** Represents state of antivirus program with respect to whether it's turned on and the signatures are up-to-date. -- **BinaryType** A binary type. Example: UNINITIALIZED, ZERO_BYTE, DATA_ONLY, DOS_MODULE, NE16_MODULE, PE32_UNKNOWN, PE32_I386, PE32_ARM, PE64_UNKNOWN, PE64_AMD64, PE64_ARM64, PE64_IA64, PE32_CLR_32, PE32_CLR_IL, PE32_CLR_IL_PREFER32, PE64_CLR_64 -- **BinFileVersion** An attempt to clean up FileVersion at the client that tries to place the version into 4 octets. -- **BinProductVersion** An attempt to clean up ProductVersion at the client that tries to place the version into 4 octets. -- **BoeProgramId** If there is no entry in Add/Remove Programs, this is the ProgramID that is generated from the file metadata. -- **CompanyName** The company name of the vendor who developed this file. -- **FileId** A hash that uniquely identifies a file. -- **FileVersion** The File version field from the file metadata under Properties -> Details. -- **HasUpgradeExe** Does the anti-virus app have an upgrade.exe file? -- **IsAv** Is the file an anti-virus reporting EXE? -- **LinkDate** The date and time that this file was linked on. -- **LowerCaseLongPath** The full file path to the file that was inventoried on the device. -- **Name** The name of the file that was inventoried. -- **ProductName** The Product name field from the file metadata under Properties -> Details. -- **ProductVersion** The Product version field from the file metadata under Properties -> Details. -- **ProgramId** A hash of the Name, Version, Publisher, and Language of an application used to identify it. -- **Size** The size of the file (in hexadecimal bytes). -### Microsoft.Windows.Inventory.Core.InventoryApplicationDriverAdd -This event represents the drivers that an application installs. +### Microsoft.Windows.Appraiser.General.DatasourceSystemBiosRemove + +This event indicates that the DatasourceSystemBios object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **InventoryVersion** The version of the inventory component -- **Programids** The unique program identifier the driver is associated with. +- **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Inventory.Core.InventoryApplicationDriverStartSync +### Microsoft.Windows.Appraiser.General.DatasourceSystemBiosStartSync -This event indicates that a new set of InventoryApplicationDriverStartAdd events will be sent. +This event indicates that a new set of DatasourceSystemBiosAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **InventoryVersion** The version of the inventory component. +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + ### Microsoft.Windows.Appraiser.General.DecisionApplicationFileAdd This event sends compatibility decision data about a file to help keep Windows up-to-date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **AppraiserVersion** The version of the appraiser file generating the events. +- **AppraiserVersion** The version of the appraiser file that is generating the events. - **BlockAlreadyInbox** The uplevel runtime block on the file already existed on the current OS. -- **BlockingApplication** Are there any application issues that interfere with upgrade due to the file in question? +- **BlockingApplication** Indicates whether there are any application issues that interfere with the upgrade due to the file in question. - **DisplayGenericMessage** Will be a generic message be shown for this file? - **HardBlock** This file is blocked in the SDB. - **HasUxBlockOverride** Does the file have a block that is overridden by a tag in the SDB? @@ -381,93 +355,40 @@ The following fields are available: - **SdbReinstallUpgradeWarn** The file is tagged as needing to be reinstalled after upgrade with a warning in the SDB. It does not block upgrade. - **SoftBlock** The file is softblocked in the SDB and has a warning. -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockAdd -This event sends blocking data about any compatibility blocking entries hit on the system that are not directly related to specific applications or devices, to help keep Windows up-to-date. +### Microsoft.Windows.Appraiser.General.DecisionApplicationFileRemove -The following fields are available: +This event indicates Indicates that the DecisionApplicationFile object is no longer present. -- **AppraiserVersion** The version of the appraiser file generating the events. - -### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoBlockAdd - -This event sends compatibility decision data about blocking entries on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. - -The following fields are available: - -- **AppraiserVersion** The version of the appraiser file generating the events. -- **BlockingApplication** Are there are any application issues that interfere with upgrade due to matching info blocks? -- **DisplayGenericMessage** Will a generic message be shown for this block? -- **NeedsUninstallAction** Does the user need to take an action in setup due to a matching info block? -- **SdbBlockUpgrade** Is a matching info block blocking upgrade? -- **SdbBlockUpgradeCanReinstall** Is a matching info block blocking upgrade, but has the can reinstall tag? -- **SdbBlockUpgradeUntilUpdate** Is a matching info block blocking upgrade but has the until update tag? - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveAdd - -This event sends compatibility database information about non-blocking compatibility entries on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. - -The following fields are available: - -- **AppraiserVersion** The version of the appraiser file generating the events. - -### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPassiveAdd - -This event sends compatibility decision data about non-blocking entries on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **BlockingApplication** Are there any application issues that interfere with upgrade due to matching info blocks? -- **MigApplication** Is there a matching info block with a mig for the current mode of upgrade? -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeAdd +### Microsoft.Windows.Appraiser.General.DecisionApplicationFileStartSync -This event sends compatibility database information about entries requiring reinstallation after an upgrade on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. +This event indicates that a new set of DecisionApplicationFileAdd events will be sent. -The following fields are available: - -- **AppraiserVersion** The version of the appraiser file generating the events. - - -### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPostUpgradeAdd - -This event sends compatibility decision data about entries that require reinstall after upgrade. It's used to help keep Windows up-to-date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **NeedsInstallPostUpgradeData** Will the file have a notification after upgrade to install a replacement for the app? -- **NeedsNotifyPostUpgradeData** Should a notification be shown for this file after upgrade? -- **NeedsReinstallPostUpgradeData** Will the file have a notification after upgrade to reinstall the app? -- **SdbReinstallUpgrade** The file is tagged as needing to be reinstalled after upgrade in the compatibility database (but is not blocking upgrade). - - -### Microsoft.Windows.Appraiser.General.DatasourceDevicePnpAdd - -This event sends compatibility data for a PNP device, to help keep Windows up-to-date. - -The following fields are available: - -- **ActiveNetworkConnection** Is the device an active network device? -- **AppraiserVersion** The version of the appraiser file generating the events. -- **IsBootCritical** Is the device boot critical? -- **WuDriverCoverage** Is there a driver uplevel for this device according to Windows Update? -- **WuDriverUpdateId** The Windows Update ID of the applicable uplevel driver. -- **WuPopulatedFromId** The expected uplevel driver matching ID based on driver coverage from Windows Update. ### Microsoft.Windows.Appraiser.General.DecisionDevicePnpAdd -This event sends compatibility decision data about a PNP device to help keep Windows up-to-date. +This event sends compatibility decision data about a PNP device to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **AssociatedDriverWillNotMigrate** Will the driver associated with this plug-and-play device migrate? - **AppraiserVersion** The version of the appraiser file generating the events. - **AssociatedDriverIsBlocked** Is the driver associated with this PNP device blocked? +- **AssociatedDriverWillNotMigrate** Will the driver associated with this plug-and-play device migrate? - **BlockAssociatedDriver** Should the driver associated with this PNP device be blocked? - **BlockingDevice** Is this PNP device blocking upgrade? - **BlockUpgradeIfDriverBlocked** Is the PNP device both boot critical and does not have a driver included with the OS? @@ -483,17 +404,33 @@ The following fields are available: - **SdbDriverBlockOverridden** Is there an SDB block on the PNP device that blocks upgrade, but that block was overridden? -### Microsoft.Windows.Appraiser.General.DatasourceDriverPackageAdd +### Microsoft.Windows.Appraiser.General.DecisionDevicePnpRemove -This event sends compatibility database data about driver packages to help keep Windows up-to-date. +This event indicates that the DecisionDevicePnp object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **AppraiserVersion** The version of the appraiser file generating the events. +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DecisionDevicePnpStartSync + +The DecisionDevicePnpStartSync event indicates that a new set of DecisionDevicePnpAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + ### Microsoft.Windows.Appraiser.General.DecisionDriverPackageAdd -This event sends decision data about driver package compatibility to help keep Windows up-to-date. +This event sends decision data about driver package compatibility to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -505,188 +442,144 @@ The following fields are available: - **SdbDriverBlockOverridden** Does the driver package have an SDB block that blocks it from migrating, but that block has been overridden? -### Microsoft.Windows.Appraiser.General.InventorySystemBiosAdd +### Microsoft.Windows.Appraiser.General.DecisionDriverPackageRemove -This event sends basic metadata about the BIOS to determine whether it has a compatibility block. +This event indicates that the DecisionDriverPackage object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **BiosDate** The release date of the BIOS in UTC format. -- **BiosName** The name field from Win32_BIOS. -- **Manufacturer** The manufacturer field from Win32_ComputerSystem. -- **Model** The model field from Win32_ComputerSystem. -### Microsoft.Windows.Appraiser.General.SystemMemoryAdd +### Microsoft.Windows.Appraiser.General.DecisionDriverPackageStartSync -This event sends data on the amount of memory on the system and whether it meets requirements, to help keep Windows up-to-date. +This event indicates that a new set of DecisionDriverPackageAdd events will be sent. -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file generating the events. -- **Blocking** Is the device from upgrade due to memory restrictions? -- **MemoryRequirementViolated** Was a memory requirement violated? -- **pageFile** The current committed memory limit for the system or the current process, whichever is smaller (in bytes). -- **ram** The amount of memory on the device. -- **ramKB** The amount of memory (in KB). -- **virtual** The size of the user-mode portion of the virtual address space of the calling process (in bytes). -- **virtualKB** The amount of virtual memory (in KB). - - -### Microsoft.Windows.Appraiser.General.DecisionSystemBiosAdd - -This event sends compatibility decision data about the BIOS to help keep Windows up-to-date. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file generating the events. -- **Blocking** Is the device blocked from upgrade due to a BIOS block? -- **HasBiosBlock** Does the device have a BIOS block? - - -### Microsoft.Windows.Appraiser.General.DatasourceSystemBiosAdd - -This event sends compatibility database information about the BIOS to help keep Windows up-to-date. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file generating the events. -- **SdbEntries** An array of fields indicating the SDB entries that apply to this BIOS. - -### Microsoft.Windows.Appraiser.General.SystemProcessorCompareExchangeAdd - -This event sends data indicating whether the system supports the CompareExchange128 CPU requirement, to help keep Windows up to date. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file generating the events. -- **Blocking** Is the upgrade blocked due to the processor? -- **CompareExchange128Support** Does the CPU support CompareExchange128? - - -### Microsoft.Windows.Appraiser.General.SystemProcessorLahfSahfAdd - -This event sends data indicating whether the system supports the LahfSahf CPU requirement, to help keep Windows up-to-date. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file generating the events. -- **Blocking** Is the upgrade blocked due to the processor? -- **LahfSahfSupport** Does the CPU support LAHF/SAHF? - -### Microsoft.Windows.Appraiser.General.SystemProcessorNxAdd - -This event sends data indicating whether the system supports the NX CPU requirement, to help keep Windows up-to-date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **Blocking** Is the upgrade blocked due to the processor? -- **NXDriverResult** The result of the driver used to do a non-deterministic check for NX support. -- **NXProcessorSupport** Does the processor support NX? -### Microsoft.Windows.Appraiser.General.SystemProcessorPrefetchWAdd +### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoBlockAdd -This event sends data indicating whether the system supports the PrefetchW CPU requirement, to help keep Windows up-to-date. +This event sends compatibility decision data about blocking entries on the system that are not keyed by either applications or devices, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the appraiser file generating the events. +- **BlockingApplication** Are there are any application issues that interfere with upgrade due to matching info blocks? +- **DisplayGenericMessage** Will a generic message be shown for this block? +- **NeedsUninstallAction** Does the user need to take an action in setup due to a matching info block? +- **SdbBlockUpgrade** Is a matching info block blocking upgrade? +- **SdbBlockUpgradeCanReinstall** Is a matching info block blocking upgrade, but has the can reinstall tag? +- **SdbBlockUpgradeUntilUpdate** Is a matching info block blocking upgrade but has the until update tag? + + +### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoBlockRemove + +This event indicates that the DecisionMatchingInfoBlock object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **Blocking** Is the upgrade blocked due to the processor? -- **PrefetchWSupport** Does the processor support PrefetchW? -### Microsoft.Windows.Appraiser.General.SystemProcessorSse2Add +### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoBlockStartSync -This event sends data indicating whether the system supports the SSE2 CPU requirement, to help keep Windows up-to-date. +This event indicates that a new set of DecisionMatchingInfoBlockAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **Blocking** Is the upgrade blocked due to the processor? -- **SSE2ProcessorSupport** Does the processor support SSE2? -### Microsoft.Windows.Appraiser.General.SystemWimAdd +### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPassiveAdd -This event sends data indicating whether the operating system is running from a compressed WIM file, to help keep Windows up-to-date. +This event sends compatibility decision data about non-blocking entries on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **IsWimBoot** Is the current operating system running from a compressed WIM file? -- **RegistryWimBootValue** The raw value from the registry that is used to indicate if the device is running from a WIM. +- **BlockingApplication** Are there any application issues that interfere with upgrade due to matching info blocks? +- **MigApplication** Is there a matching info block with a mig for the current mode of upgrade? -### Microsoft.Windows.Appraiser.General.SystemTouchAdd +### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPassiveRemove -This event sends data indicating whether the system supports touch, to help keep Windows up-to-date. +This event Indicates that the DecisionMatchingInfoPassive object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **IntegratedTouchDigitizerPresent** Is there an integrated touch digitizer? -- **MaximumTouches** The maximum number of touch points supported by the device hardware. -### Microsoft.Windows.Appraiser.General.SystemWindowsActivationStatusAdd +### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPassiveStartSync -This event sends data indicating whether the current operating system is activated, to help keep Windows up-to-date. +This event indicates that a new set of DecisionMatchingInfoPassiveAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **WindowsIsLicensedApiValue** The result from the API that's used to indicate if operating system is activated. -- **WindowsNotActivatedDecision** Is the current operating system activated? -### Microsoft.Windows.Appraiser.General.InventoryLanguagePackAdd +### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPostUpgradeAdd -This event sends data about the number of language packs installed on the system, to help keep Windows up-to-date. +This event sends compatibility decision data about entries that require reinstall after upgrade. It's used to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **HasLanguagePack** Does this device have 2 or more language packs? -- **LanguagePackCount** How many language packs are installed? +- **NeedsInstallPostUpgradeData** Will the file have a notification after upgrade to install a replacement for the app? +- **NeedsNotifyPostUpgradeData** Should a notification be shown for this file after upgrade? +- **NeedsReinstallPostUpgradeData** Will the file have a notification after upgrade to reinstall the app? +- **SdbReinstallUpgrade** The file is tagged as needing to be reinstalled after upgrade in the compatibility database (but is not blocking upgrade). -### Microsoft.Windows.Appraiser.General.SystemWlanAdd +### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPostUpgradeRemove -This event sends data indicating whether the system has WLAN, and if so, whether it uses an emulated driver that could block an upgrade, to help keep Windows up-to-date. +This event indicates that the DecisionMatchingInfoPostUpgrade object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **Blocking** Is the upgrade blocked because of an emulated WLAN driver? -- **HasWlanBlock** Does the emulated WLAN driver have an upgrade block? -- **WlanEmulatedDriver** Does the device have an emulated WLAN driver? -- **WlanExists** Does the device support WLAN at all? -- **WlanModulePresent** Are any WLAN modules present? -- **WlanNativeDriver** Does the device have a non-emulated WLAN driver? -### Microsoft.Windows.Appraiser.General.InventoryMediaCenterAdd +### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPostUpgradeStartSync -This event sends true/false data about decision points used to understand whether Windows Media Center is used on the system, to help keep Windows up to date. +This event indicates that a new set of DecisionMatchingInfoPostUpgradeAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **AppraiserVersion** The version of the Appraiser file generating the events. -- **EverLaunched** Has Windows Media Center ever been launched? -- **HasConfiguredTv** Has the user configured a TV tuner through Windows Media Center? -- **HasExtendedUserAccounts** Are any Windows Media Center Extender user accounts configured? -- **HasWatchedFolders** Are any folders configured for Windows Media Center to watch? -- **IsDefaultLauncher** Is Windows Media Center the default app for opening music or video files? -- **IsPaid** Is the user running a Windows Media Center edition that implies they paid for Windows Media Center? -- **IsSupported** Does the running OS support Windows Media Center? +- **AppraiserVersion** The version of the Appraiser file that is generating the events. ### Microsoft.Windows.Appraiser.General.DecisionMediaCenterAdd -This event sends decision data about the presence of Windows Media Center, to help keep Windows up-to-date. +This event sends decision data about the presence of Windows Media Center, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -699,187 +592,11 @@ The following fields are available: - **NeedsDismissAction** Are there any actions that can be dismissed coming from Windows Media Center? -### Microsoft.Windows.Appraiser.General.ChecksumTotalPictureCount +### Microsoft.Windows.Appraiser.General.DecisionMediaCenterRemove -This event lists the types of objects and how many of each exist on the client device. This allows for a quick way to ensure that the records present on the server match what is present on the client. +This event indicates that the DecisionMediaCenter object is no longer present. -The following fields are available: - -- **DatasourceApplicationFile_RS2** The total DatasourceApplicationFile objects targeting Windows 10 version 1703 present on this device. -- **DatasourceDevicePnp_RS2** The total DatasourceDevicePnp objects targeting Windows 10 version 1703 present on this device. -- **DatasourceDriverPackage_RS2** The total DatasourceDriverPackage objects targeting Windows 10 version 1703 present on this device. -- **DataSourceMatchingInfoBlock_RS2** The total DataSourceMatchingInfoBlock objects targeting Windows 10 version 1703 present on this device. -- **DataSourceMatchingInfoPassive_RS2** The total DataSourceMatchingInfoPassive objects targeting Windows 10 version 1703 present on this device. -- **DataSourceMatchingInfoPostUpgrade_RS2** The total DataSourceMatchingInfoPostUpgrade objects targeting Windows 10 version 1703 present on this device. -- **DatasourceSystemBios_RS2** The total DatasourceSystemBios objects targeting Windows 10 version 1703 present on this device. -- **DecisionApplicationFile_RS2** The total DecisionApplicationFile objects targeting Windows 10 version 1703 present on this device. -- **DecisionDevicePnp_RS2** The total DecisionDevicePnp objects targeting Windows 10 version 1703 present on this device. -- **DecisionDriverPackage_RS2** The total DecisionDriverPackage objects targeting Windows 10 version 1703 present on this device. -- **DecisionMatchingInfoBlock_RS2** The total DecisionMatchingInfoBlock objects targeting Windows 10 version 1703 present on this device. -- **DecisionMatchingInfoPassive_RS2** The total DecisionMatchingInfoPassive objects targeting Windows 10 version 1703 present on this device. -- **DecisionMatchingInfoPostUpgrade_RS2** The total DecisionMatchingInfoPostUpgrade objects targeting Windows 10 version 1703 present on this device. -- **DecisionMediaCenter_RS2** The total DecisionMediaCenter objects targeting Windows 10 version 1703 present on this device. -- **DecisionSystemBios_RS2** The total DecisionSystemBios objects targeting Windows 10 version 1703 present on this device. -- **InventoryApplicationFile** The total InventoryApplicationFile objects that are present on this device. -- **InventoryLanguagePack** The total InventoryLanguagePack objects that are present on this device. -- **InventoryMediaCenter** The total InventoryMediaCenter objects that are present on this device. -- **InventorySystemBios** The total InventorySystemBios objects that are present on this device. -- **InventoryUplevelDriverPackage** The total InventoryUplevelDriverPackage objects that are present on this device. -- **PCFP** An ID for the system that is calculated by hashing hardware identifiers. -- **SystemMemory** The total SystemMemory objects that are present on this device. -- **SystemProcessorCompareExchange** The total SystemProcessorCompareExchange objects that are present on this device. -- **SystemProcessorLahfSahf** The total SystemProcessorLahfSahf objects that are present on this device. -- **SystemProcessorNx** The total SystemProcessorNx objects that are present on this device. -- **SystemProcessorPrefetchW** The total SystemProcessorPrefetchW objects that are present on this device. -- **SystemProcessorSse2** The total SystemProcessorSse2 objects that are present on this device. -- **SystemTouch** The total SystemTouch objects that are present on this device. -- **SystemWim** The total SystemWim objects that are present on this device -- **SystemWindowsActivationStatus** The total SystemWindowsActivationStatus objects that are present on this device. -- **SystemWlan** The total SystemWlan objects that are present on this device. -- **Wmdrm_RS2** The total Wmdrm objects targeting Windows 10 version 1703 present on this device. -- **DatasourceApplicationFile_RS3** "The total DecisionApplicationFile objects targeting the next release of Windows on this device. " -- **DatasourceDevicePnp_RS3** The total DatasourceDevicePnp objects targeting the next release of Windows on this device. -- **DatasourceDriverPackage_RS3** The total DatasourceDriverPackage objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoBlock_RS3** The total DataSourceMatchingInfoBlock objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPassive objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoPostUpgrade_RS3** The total DataSourceMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. -- **DatasourceSystemBios_RS3** The total DatasourceSystemBios objects targeting the next release of Windows on this device. -- **DecisionApplicationFile_RS3** The total DecisionApplicationFile objects targeting the next release of Windows on this device. -- **DecisionDevicePnp_RS3** The total DecisionDevicePnp objects targeting the next release of Windows on this device. -- **DecisionDriverPackage_RS3** The total DecisionDriverPackage objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoBlock_RS3** The total DecisionMatchingInfoBlock objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPassive objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoPostUpgrade_RS3** The total DecisionMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. -- **DecisionMediaCenter_RS3** The total DecisionMediaCenter objects targeting the next release of Windows on this device. -- **DecisionSystemBios_RS3** The total DecisionSystemBios objects targeting the next release of Windows on this device. -- **Wmdrm_RS3** The total Wmdrm objects targeting the next release of Windows on this device. - - -### Microsoft.Windows.Appraiser.General.InventoryUplevelDriverPackageStartSync - -This event indicates that a new set of InventoryUplevelDriverPackageAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemProcessorLahfSahfStartSync - -This event indicates that a new set of SystemProcessorLahfSahfAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemProcessorSse2StartSync - -This event indicates that a new set of SystemProcessorSse2Add events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.InventorySystemBiosStartSync - -This event indicates that a new set of InventorySystemBiosAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - -### Microsoft.Windows.Appraiser.General.DecisionSystemBiosStartSync - -This event indicates that a new set of DecisionSystemBiosAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemMemoryStartSync - -This event indicates that a new set of SystemMemoryAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - -### Microsoft.Windows.Appraiser.General.SystemProcessorCompareExchangeStartSync - -This event indicates that a new set of SystemProcessorCompareExchangeAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - -### Microsoft.Windows.Appraiser.General.SystemProcessorNxStartSync - -This event indicates that a new set of SystemProcessorNxAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemProcessorPrefetchWStartSync - -This event indicates that a new set of SystemProcessorPrefetchWAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemWimStartSync - -This event indicates that a new set of SystemWimAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DatasourceSystemBiosStartSync - -This event indicates that a new set of DatasourceSystemBiosAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemTouchStartSync - -This event indicates that a new set of SystemTouchAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DatasourceDriverPackageEndSync - -This event indicates that a full set of DatasourceDriverPackageAdd events has been sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemWlanStartSync - -This event indicates that a new set of SystemWlanAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - -### Microsoft.Windows.Appraiser.General.SystemWindowsActivationStatusStartSync - -This event indicates that a new set of SystemWindowsActivationStatusAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -890,198 +607,48 @@ The following fields are available: This event indicates that a new set of DecisionMediaCenterAdd events will be sent. -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.InventoryMediaCenterStartSync - -This event indicates that a new set of InventoryMediaCenterAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - -### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPassiveStartSync - -This event indicates that a new set of DecisionMatchingInfoPassiveAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveStartSync +### Microsoft.Windows.Appraiser.General.DecisionSystemBiosAdd -This event indicates that a new set of DataSourceMatchingInfoPassiveAdd events will be sent. +This event sends compatibility decision data about the BIOS to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file generating the events. +- **Blocking** Is the device blocked from upgrade due to a BIOS block? +- **HasBiosBlock** Does the device have a BIOS block? + + +### Microsoft.Windows.Appraiser.General.DecisionSystemBiosRemove + +This event indicates that the DecisionSystemBios object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.InventoryApplicationFileStartSync +### Microsoft.Windows.Appraiser.General.DecisionSystemBiosStartSync -This event indicates that a new set of InventoryApplicationFileAdd events will be sent. +This event indicates that a new set of DecisionSystemBiosAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPostUpgradeStartSync - -This event indicates that a new set of DecisionMatchingInfoPostUpgradeAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.WmdrmStartSync - -This event indicates that a new set of WmdrmAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveEndSync - -This event indicates that a full set of DataSourceMatchingInfoPassiveAdd events have been sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoBlockStartSync - -This event indicates that a new set of DecisionMatchingInfoBlockAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DatasourceApplicationFileStartSync - -This event indicates that a new set of DatasourceApplicationFileAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - -### Microsoft.Windows.Appraiser.General.DatasourceDevicePnpStartSync - -This event indicates that a new set of DatasourceDevicePnpAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockStartSync - -This event indicates that a full set of DataSourceMatchingInfoBlockStAdd events have been sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DecisionApplicationFileStartSync - -This event indicates that a new set of DecisionApplicationFileAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.InventoryLanguagePackStartSync - -This event indicates that a new set of InventoryLanguagePackAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeStartSync - -This event indicates that a new set of DataSourceMatchingInfoPostUpgradeAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - -### Microsoft.Windows.Appraiser.General.DecisionDevicePnpStartSync - -This event indicates that the DecisionDevicePnp object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DatasourceDriverPackageStartSync - -This event indicates that a new set of DatasourceDriverPackageAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DecisionDriverPackageStartSync - -This event indicates that a new set of DecisionDriverPackageAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.WmdrmAdd - -This event sends data about the usage of older digital rights management on the system, to help keep Windows up to date. This data does not indicate the details of the media using the digital rights management, only whether any such files exist. Collecting this data was critical to ensuring the correct mitigation for customers, and should be able to be removed once all mitigations are in place. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **BlockingApplication** Same as NeedsDismissAction -- **NeedsDismissAction** Indicates if a dismissible message is needed to warn the user about a potential loss of data due to DRM deprecation. -- **WmdrmApiResult** Raw value of the API used to gather DRM state. -- **WmdrmCdRipped** Indicates if the system has any files encrypted with personal DRM, which was used for ripped CDs. -- **WmdrmIndicators** WmdrmCdRipped OR WmdrmPurchased -- **WmdrmInUse** WmdrmIndicators AND dismissible block in setup was not dismissed. -- **WmdrmNonPermanent** Indicates if the system has any files with non-permanent licenses. -- **WmdrmPurchased** Indicates if the system has any files with permanent licenses. - -### Microsoft.Windows.Appraiser.General.InventoryUplevelDriverPackageAdd - -This event is only runs during setup. It provides a listing of the uplevel driver packages that were downloaded before the upgrade. Is critical to understanding if failures in setup can be traced to not having sufficient uplevel drivers before the upgrade. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **BootCritical** Is the driver package marked as boot critical? -- **Build** The build value from the driver package. -- **CatalogFile** The name of the catalog file within the driver package. -- **Class** The device class from the driver package. -- **ClassGuid** The device class GUID from the driver package. -- **Date** The date from the driver package. -- **Inbox** Is the driver package of a driver that is included with Windows? -- **OriginalName** The original name of the INF file before it was renamed. Generally a path under $WINDOWS.~BT\Drivers\DU -- **Provider** The provider of the driver package. -- **PublishedName** The name of the INF file, post-rename. -- **Revision** The revision of the driver package. -- **SignatureStatus** Indicates if the driver package is signed. Unknown:0, Unsigned:1, Signed: 2 -- **VersionMajor** The major version of the driver package. -- **VersionMinor** The minor version of the driver package. - ### Microsoft.Windows.Appraiser.General.GatedRegChange This event sends data about the results of running a set of quick-blocking instructions, to help keep Windows up to date. @@ -1096,109 +663,546 @@ The following fields are available: - **Time** The client time of the event. -### Microsoft.Windows.Appraiser.General.DatasourceApplicationFileRemove +### Microsoft.Windows.Appraiser.General.InventoryApplicationFileAdd -This event indicates that the DatasourceApplicationFile object is no longer present. +This event represents the basic metadata about a file on the system. The file must be part of an app and either have a block in the compatibility database or be part of an antivirus program. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file generating the events. +- **AvDisplayName** If the app is an antivirus app, this is its display name. +- **AvProductState** Indicates whether the antivirus program is turned on and the signatures are up to date. +- **BinaryType** A binary type. Example: UNINITIALIZED, ZERO_BYTE, DATA_ONLY, DOS_MODULE, NE16_MODULE, PE32_UNKNOWN, PE32_I386, PE32_ARM, PE64_UNKNOWN, PE64_AMD64, PE64_ARM64, PE64_IA64, PE32_CLR_32, PE32_CLR_IL, PE32_CLR_IL_PREFER32, PE64_CLR_64. +- **BinFileVersion** An attempt to clean up FileVersion at the client that tries to place the version into 4 octets. +- **BinProductVersion** An attempt to clean up ProductVersion at the client that tries to place the version into 4 octets. +- **BoeProgramId** If there is no entry in Add/Remove Programs, this is the ProgramID that is generated from the file metadata. +- **CompanyName** The company name of the vendor who developed this file. +- **FileId** A hash that uniquely identifies a file. +- **FileVersion** The File version field from the file metadata under Properties -> Details. +- **HasUpgradeExe** Indicates whether the antivirus app has an upgrade.exe file. +- **IsAv** Indicates whether the file an antivirus reporting EXE. +- **LinkDate** The date and time that this file was linked on. +- **LowerCaseLongPath** The full file path to the file that was inventoried on the device. +- **Name** The name of the file that was inventoried. +- **ProductName** The Product name field from the file metadata under Properties -> Details. +- **ProductVersion** The Product version field from the file metadata under Properties -> Details. +- **ProgramId** A hash of the Name, Version, Publisher, and Language of an application used to identify it. +- **Size** The size of the file (in hexadecimal bytes). + + +### Microsoft.Windows.Appraiser.General.InventoryApplicationFileRemove + +This event indicates that the InventoryApplicationFile object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.DatasourceDevicePnpRemove +### Microsoft.Windows.Appraiser.General.InventoryApplicationFileStartSync -This event indicates that the DatasourceDevicePnp object is no longer present. +This event indicates indicates that a new set of InventoryApplicationFileAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.DatasourceDriverPackageRemove +### Microsoft.Windows.Appraiser.General.InventoryLanguagePackAdd -This event indicates that the DatasourceDriverPackage object is no longer present. +This event sends data about the number of language packs installed on the system, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **HasLanguagePack** Indicates whether this device has 2 or more language packs. +- **LanguagePackCount** The number of language packs are installed. + + +### Microsoft.Windows.Appraiser.General.InventoryLanguagePackRemove + +This event indicates that the InventoryLanguagePack object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.SystemProcessorSse2Remove +### Microsoft.Windows.Appraiser.General.InventoryLanguagePackStartSync -This event indicates that the SystemProcessorSse2 object is no longer present. +This event indicates that a new set of InventoryLanguagePackAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.InventoryUplevelDriverPackageRemove +### Microsoft.Windows.Appraiser.General.InventoryMediaCenterAdd -This event indicates that the InventoryUplevelDriverPackage object is no longer present. +This event sends true/false data about decision points used to understand whether Windows Media Center is used on the system, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DecisionMediaCenterRemove - -This event indicates that the DecisionMediaCenter object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **AppraiserVersion** The version of the Appraiser file generating the events. +- **EverLaunched** Has Windows Media Center ever been launched? +- **HasConfiguredTv** Has the user configured a TV tuner through Windows Media Center? +- **HasExtendedUserAccounts** Are any Windows Media Center Extender user accounts configured? +- **HasWatchedFolders** Are any folders configured for Windows Media Center to watch? +- **IsDefaultLauncher** Is Windows Media Center the default app for opening music or video files? +- **IsPaid** Is the user running a Windows Media Center edition that implies they paid for Windows Media Center? +- **IsSupported** Does the running OS support Windows Media Center? ### Microsoft.Windows.Appraiser.General.InventoryMediaCenterRemove This event indicates that the InventoryMediaCenter object is no longer present. -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DatasourceSystemBiosRemove - -This event indicates that the DatasourceSystemBios object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.DecisionApplicationFileRemove +### Microsoft.Windows.Appraiser.General.InventoryMediaCenterStartSync -This event indicates that the DecisionApplicationFile object is no longer present. +This event indicates that a new set of InventoryMediaCenterAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPostUpgradeRemove +### Microsoft.Windows.Appraiser.General.InventorySystemBiosAdd -This event indicates that the DecisionMatchingInfoPostUpgrade object is no longer present. +This event sends basic metadata about the BIOS to determine whether it has a compatibility block. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **BiosDate** The release date of the BIOS in UTC format. +- **BiosName** The name field from Win32_BIOS. +- **Manufacturer** The manufacturer field from Win32_ComputerSystem. +- **Model** The model field from Win32_ComputerSystem. + + +### Microsoft.Windows.Appraiser.General.InventorySystemBiosRemove + +This event indicates that the InventorySystemBios object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.InventorySystemBiosStartSync + +This event indicates that a new set of InventorySystemBiosAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.InventoryUplevelDriverPackageAdd + +This event is only runs during setup. It provides a listing of the uplevel driver packages that were downloaded before the upgrade. Is critical to understanding if failures in setup can be traced to not having sufficient uplevel drivers before the upgrade. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **BootCritical** Is the driver package marked as boot critical? +- **Build** The build value from the driver package. +- **CatalogFile** The name of the catalog file within the driver package. +- **Class** The device class from the driver package. +- **ClassGuid** The device class unique ID from the driver package. +- **Date** The date from the driver package. +- **Inbox** Is the driver package of a driver that is included with Windows? +- **OriginalName** The original name of the INF file before it was renamed. Generally a path under $WINDOWS.~BT\Drivers\DU. +- **Provider** The provider of the driver package. +- **PublishedName** The name of the INF file after it was renamed. +- **Revision** The revision of the driver package. +- **SignatureStatus** Indicates if the driver package is signed. Unknown = 0, Unsigned = 1, Signed = 2. +- **VersionMajor** The major version of the driver package. +- **VersionMinor** The minor version of the driver package. + + +### Microsoft.Windows.Appraiser.General.InventoryUplevelDriverPackageRemove + +This event indicates that the InventoryUplevelDriverPackage object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.InventoryUplevelDriverPackageStartSync + +This event indicates that a new set of InventoryUplevelDriverPackageAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.RunContext + +This event indicates what should be expected in the data payload. + +The following fields are available: + +- **AppraiserBranch** The source branch in which the currently running version of Appraiser was built. +- **AppraiserProcess** The name of the process that launched Appraiser. +- **AppraiserVersion** The version of the Appraiser file generating the events. +- **Context** Indicates what mode Appraiser is running in. Example: Setup or Telemetry. +- **PCFP** An ID for the system calculated by hashing hardware identifiers. +- **Time** The client time of the event. + + +### Microsoft.Windows.Appraiser.General.SystemMemoryAdd + +This event sends data on the amount of memory on the system and whether it meets requirements, to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file generating the events. +- **Blocking** Is the device from upgrade due to memory restrictions? +- **MemoryRequirementViolated** Was a memory requirement violated? +- **pageFile** The current committed memory limit for the system or the current process, whichever is smaller (in bytes). +- **ram** The amount of memory on the device. +- **ramKB** The amount of memory (in KB). +- **virtual** The size of the user-mode portion of the virtual address space of the calling process (in bytes). +- **virtualKB** The amount of virtual memory (in KB). + + +### Microsoft.Windows.Appraiser.General.SystemMemoryRemove + +This event that the SystemMemory object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemMemoryStartSync + +This event indicates that a new set of SystemMemoryAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemProcessorCompareExchangeAdd + +This event sends data indicating whether the system supports the CompareExchange128 CPU requirement, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file generating the events. +- **Blocking** Is the upgrade blocked due to the processor? +- **CompareExchange128Support** Does the CPU support CompareExchange128? + + +### Microsoft.Windows.Appraiser.General.SystemProcessorCompareExchangeRemove + +This event indicates that the SystemProcessorCompareExchange object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemProcessorCompareExchangeStartSync + +This event indicates that a new set of SystemProcessorCompareExchangeAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemProcessorLahfSahfAdd + +This event sends data indicating whether the system supports the LahfSahf CPU requirement, to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file generating the events. +- **Blocking** Is the upgrade blocked due to the processor? +- **LahfSahfSupport** Does the CPU support LAHF/SAHF? + + +### Microsoft.Windows.Appraiser.General.SystemProcessorLahfSahfRemove + +This event indicates that the SystemProcessorLahfSahf object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemProcessorLahfSahfStartSync + +This event indicates that a new set of SystemProcessorLahfSahfAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemProcessorNxAdd + +This event sends data indicating whether the system supports the NX CPU requirement, to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **Blocking** Is the upgrade blocked due to the processor? +- **NXDriverResult** The result of the driver used to do a non-deterministic check for NX support. +- **NXProcessorSupport** Does the processor support NX? + + +### Microsoft.Windows.Appraiser.General.SystemProcessorNxRemove + +This event indicates that the SystemProcessorNx object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemProcessorNxStartSync + +This event indicates that a new set of SystemProcessorNxAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemProcessorPrefetchWAdd + +This event sends data indicating whether the system supports the PrefetchW CPU requirement, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **Blocking** Is the upgrade blocked due to the processor? +- **PrefetchWSupport** Does the processor support PrefetchW? + + +### Microsoft.Windows.Appraiser.General.SystemProcessorPrefetchWRemove + +This event indicates that the SystemProcessorPrefetchW object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemProcessorPrefetchWStartSync + +This event indicates that a new set of SystemProcessorPrefetchWAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemProcessorSse2Add + +This event sends data indicating whether the system supports the SSE2 CPU requirement, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **Blocking** Is the upgrade blocked due to the processor? +- **SSE2ProcessorSupport** Does the processor support SSE2? + + +### Microsoft.Windows.Appraiser.General.SystemProcessorSse2Remove + +This event indicates that the SystemProcessorSse2 object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemProcessorSse2StartSync + +This event indicates that a new set of SystemProcessorSse2Add events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemTouchAdd + +This event sends data indicating whether the system supports touch, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **IntegratedTouchDigitizerPresent** Is there an integrated touch digitizer? +- **MaximumTouches** The maximum number of touch points supported by the device hardware. ### Microsoft.Windows.Appraiser.General.SystemTouchRemove -"This event indicates that the SystemTouch object is no longer present. " +This event indicates that the SystemTouch object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. +### Microsoft.Windows.Appraiser.General.SystemTouchStartSync + +This event indicates that a new set of SystemTouchAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemWimAdd + +This event sends data indicating whether the operating system is running from a compressed Windows Imaging Format (WIM) file, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **IsWimBoot** Is the current operating system running from a compressed WIM file? +- **RegistryWimBootValue** The raw value from the registry that is used to indicate if the device is running from a WIM. + + +### Microsoft.Windows.Appraiser.General.SystemWimRemove + +This event indicates that the SystemWim object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemWimStartSync + +This event indicates that a new set of SystemWimAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemWindowsActivationStatusAdd + +This event sends data indicating whether the current operating system is activated, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **WindowsIsLicensedApiValue** The result from the API that's used to indicate if operating system is activated. +- **WindowsNotActivatedDecision** Is the current operating system activated? + + ### Microsoft.Windows.Appraiser.General.SystemWindowsActivationStatusRemove This event indicates that the SystemWindowsActivationStatus object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.SystemWindowsActivationStatusStartSync + +This event indicates that a new set of SystemWindowsActivationStatusAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1206,185 +1210,120 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemWlanRemove -"This event indicates that the SystemWlan object is no longer present. " +This event indicates that the SystemWlan object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeRemove +### Microsoft.Windows.Appraiser.General.SystemWlanStartSync -This event indicates that the DataSourceMatchingInfoPostUpgrade object is no longer present. +This event indicates that a new set of SystemWlanAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.SystemProcessorNxRemove +### Microsoft.Windows.Appraiser.General.TelemetryRunHealth -This event indicates that the SystemProcessorNx object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockRemove - -This event indicates that the DataSourceMatchingInfoBlock object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DecisionDevicePnpRemove - -This event indicates that the DecisionDevicePnp object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPassiveRemove - -This event Indicates that the DecisionMatchingInfoPassive object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemMemoryRemove - -This event that the SystemMemory object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoBlockRemove - -This event indicates that the DecisionMatchingInfoBlock object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveRemove - -This event indicates that the DataSourceMatchingInfoPassive object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.InventoryApplicationFileRemove - -This event indicates that the InventoryApplicationFile object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemWimRemove - -"This event indicates that the SystemWim object is no longer present. " - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.InventorySystemBiosRemove - -"This event indicates that the InventorySystemBios object is no longer present. " +This event indicates the parameters and result of a telemetry (diagnostic) run. This allows the rest of the data sent over the course of the run to be properly contextualized and understood, which is then used to keep Windows up to date. + +The following fields are available: + +- **AppraiserBranch** The source branch in which the version of Appraiser that is running was built. +- **AppraiserDataVersion** The version of the data files being used by the Appraiser telemetry run. +- **AppraiserProcess** The name of the process that launched Appraiser. +- **AppraiserVersion** The file version (major, minor and build) of the Appraiser DLL, concatenated without dots. +- **AuxFinal** Obsolete, always set to false. +- **AuxInitial** Obsolete, indicates if Appraiser is writing data files to be read by the Get Windows 10 app. +- **DeadlineDate** A timestamp representing the deadline date, which is the time until which appraiser will wait to do a full scan. +- **EnterpriseRun** Indicates if the telemetry run is an enterprise run, which means appraiser was run from the command line with an extra enterprise parameter. +- **FullSync** Indicates if Appraiser is performing a full sync, which means that full set of events representing the state of the machine are sent. Otherwise, only the changes from the previous run are sent. +- **InventoryFullSync** Indicates if inventory is performing a full sync, which means that the full set of events representing the inventory of machine are sent. +- **PCFP** An ID for the system calculated by hashing hardware identifiers. +- **PerfBackoff** Indicates if the run was invoked with logic to stop running when a user is present. Helps to understand why a run may have a longer elapsed time than normal. +- **PerfBackoffInsurance** Indicates if appraiser is running without performance backoff because it has run with perf backoff and failed to complete several times in a row. +- **RunAppraiser** Indicates if Appraiser was set to run at all. If this if false, it is understood that data events will not be received from this device. +- **RunDate** The date that the telemetry run was stated, expressed as a filetime. +- **RunGeneralTel** Indicates if the generaltel.dll component was run. Generaltel collects additional telemetry on an infrequent schedule and only from machines at telemetry levels higher than Basic. +- **RunOnline** Indicates if appraiser was able to connect to Windows Update and theefore is making decisions using up-to-date driver coverage information. +- **RunResult** The hresult of the Appraiser telemetry run. +- **SendingUtc** Indicates if the Appraiser client is sending events during the current telemetry run. +- **StoreHandleIsNotNull** Obsolete, always set to false +- **TelementrySent** Indicates if telemetry was successfully sent. +- **ThrottlingUtc** Indicates if the Appraiser client is throttling its output of CUET events to avoid being disabled. This increases runtime but also telemetry reliability. +- **Time** The client time of the event. +- **VerboseMode** Indicates if appraiser ran in Verbose mode, which is a test-only mode with extra logging. +- **WhyFullSyncWithoutTablePrefix** Indicates the reason or reasons that a full sync was generated. + + +### Microsoft.Windows.Appraiser.General.WmdrmAdd + +This event sends data about the usage of older digital rights management on the system, to help keep Windows up to date. This data does not indicate the details of the media using the digital rights management, only whether any such files exist. Collecting this data was critical to ensuring the correct mitigation for customers, and should be able to be removed once all mitigations are in place. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. +- **BlockingApplication** Same as NeedsDismissAction. +- **NeedsDismissAction** Indicates if a dismissible message is needed to warn the user about a potential loss of data due to DRM deprecation. +- **WmdrmApiResult** Raw value of the API used to gather DRM state. +- **WmdrmCdRipped** Indicates if the system has any files encrypted with personal DRM, which was used for ripped CDs. +- **WmdrmIndicators** WmdrmCdRipped OR WmdrmPurchased. +- **WmdrmInUse** WmdrmIndicators AND dismissible block in setup was not dismissed. +- **WmdrmNonPermanent** Indicates if the system has any files with non-permanent licenses. +- **WmdrmPurchased** Indicates if the system has any files with permanent licenses. ### Microsoft.Windows.Appraiser.General.WmdrmRemove This event indicates that the Wmdrm object is no longer present. -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemProcessorLahfSahfRemove - -"This event indicates that the SystemProcessorLahfSahf object is no longer present. " +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.InventoryLanguagePackRemove +### Microsoft.Windows.Appraiser.General.WmdrmStartSync -This event indicates that the InventoryLanguagePack object is no longer present. +This event indicates that a new set of WmdrmAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -### Microsoft.Windows.Appraiser.General.DecisionDriverPackageRemove - -This event indicates that the DecisionDriverPackage object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DecisionSystemBiosRemove - -This event indicates that the DecisionSystemBios object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemProcessorCompareExchangeRemove - -"This event indicates that the SystemProcessorCompareExchange object is no longer present. " - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.SystemProcessorPrefetchWRemove - -This event indicates that the SystemProcessorPrefetchW object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.InventoryDriverBinaryEndSync - -This event indicates that a full set of InventoryDriverBinaryAdd events has been sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - ## Census events +### Census.App + +Provides information on IE and Census versions running on the device + +The following fields are available: + +- **AppraiserEnterpriseErrorCode** The error code of the last Appraiser enterprise run. +- **AppraiserErrorCode** The error code of the last Appraiser run. +- **AppraiserRunEndTimeStamp** The end time of the last Appraiser run. +- **AppraiserRunIsInProgressOrCrashed** Flag that indicates if the Appraiser run is in progress or has crashed. +- **AppraiserRunStartTimeStamp** The start time of the last Appraiser run. +- **AppraiserTaskEnabled** Whether the Appraiser task is enabled. +- **AppraiserTaskExitCode** The Appraiser task exist code. +- **AppraiserTaskLastRun** The last runtime for the Appraiser task. +- **CensusVersion** The version of Census that generated the current data for this device. +- **IEVersion** Retrieves which version of Internet Explorer is running on this device. + + ### Census.Battery This event sends type and capacity data about the battery on the device, as well as the number of connected standby devices in use, type to help keep Windows up to date. @@ -1398,6 +1337,16 @@ The following fields are available: - **IsAlwaysOnAlwaysConnectedCapable** Represents whether the battery enables the device to be AlwaysOnAlwaysConnected . Boolean value. +### Census.Camera + +This event sends data about the resolution of cameras on the device, to help keep Windows up to date. + +The following fields are available: + +- **FrontFacingCameraResolution** Represents the resolution of the front facing camera in megapixels. If a front facing camera does not exist, then the value is 0. +- **RearFacingCameraResolution** Represents the resolution of the rear facing camera in megapixels. If a rear facing camera does not exist, then the value is 0. + + ### Census.Enterprise This event sends data about Azure presence, type, and cloud domain use in order to provide an understanding of the use and integration of devices in an enterprise, cloud, and server environment. @@ -1409,7 +1358,7 @@ The following fields are available: - **CDJType** Represents the type of cloud domain joined for the machine. - **CommercialId** Represents the GUID for the commercial entity which the device is a member of.  Will be used to reflect insights back to customers. - **ContainerType** The type of container, such as process or virtual machine hosted. -- **EnrollmentType** Represents the type of enrollment, such as MDM or Intune, for a particular device. +- **EnrollmentType** Defines the type of MDM enrollment on the device. - **HashedDomain** The hashed representation of the user domain used for login. - **IsCloudDomainJoined** Is this device joined to an Azure Active Directory (AAD) tenant? true/false - **IsDERequirementMet** Represents if the device can do device encryption. @@ -1423,48 +1372,6 @@ The following fields are available: - **SystemCenterID** The SCCM ID is an anonymized one-way hash of the Active Directory Organization identifier -### Census.App - -This event sends version data about the Apps running on this device, to help keep Windows up to date. - -The following fields are available: - -- **CensusVersion** The version of Census that generated the current data for this device. -- **IEVersion** Retrieves which version of Internet Explorer is running on this device. - - -### Census.Camera - -This event sends data about the resolution of cameras on the device, to help keep Windows up to date. - -The following fields are available: - -- **FrontFacingCameraResolution** Represents the resolution of the front facing camera in megapixels. If a front facing camera does not exist, then the value is 0. -- **RearFacingCameraResolution** Represents the resolution of the rear facing camera in megapixels. If a rear facing camera does not exist, then the value is 0. - - -### Census.UserDisplay - -This event sends data about the logical/physical display size, resolution and number of internal/external displays, and VRAM on the system, to help keep Windows up to date. - -The following fields are available: - -- **InternalPrimaryDisplayLogicalDPIX** Retrieves the logical DPI in the x-direction of the internal display. -- **InternalPrimaryDisplayLogicalDPIY** Retrieves the logical DPI in the y-direction of the internal display. -- **InternalPrimaryDisplayPhysicalDPIX** Retrieves the physical DPI in the x-direction of the internal display. -- **InternalPrimaryDisplayPhysicalDPIY** Retrieves the physical DPI in the y-direction of the internal display. -- **InternalPrimaryDisplayResolutionHorizontal** Retrieves the number of pixels in the horizontal direction of the internal display. -- **InternalPrimaryDisplayResolutionVertical** Retrieves the number of pixels in the vertical direction of the internal display. -- **InternalPrimaryDisplaySizePhysicalH** Retrieves the physical horizontal length of the display in mm. Used for calculating the diagonal length in inches . -- **InternalPrimaryDisplaySizePhysicalY** Retrieves the physical vertical length of the display in mm. Used for calculating the diagonal length in inches -- **InternalPrimaryDisplayType** Represents the type of technology used in the monitor, such as Plasma, LED, LCOS, etc. -- **NumberofExternalDisplays** Retrieves the number of external displays connected to the machine -- **NumberofInternalDisplays** Retrieves the number of internal displays in a machine. -- **VRAMDedicated** Retrieves the video RAM in MB. -- **VRAMDedicatedSystem** Retrieves the amount of memory on the dedicated video card. -- **VRAMSharedSystem** Retrieves the amount of RAM memory that the video card can use. - - ### Census.Firmware This event sends data about the BIOS and startup embedded in the device, to help keep Windows up to date. @@ -1479,11 +1386,11 @@ The following fields are available: ### Census.Flighting -This event sends Windows Insider data from customers participating in improvement testing and feedback programs, to help keep Windows up-to-date. +This event sends Windows Insider data from customers participating in improvement testing and feedback programs, to help keep Windows up to date. The following fields are available: -- **DeviceSampleRate** The diagnostic data sample rate assigned to the device. +- **DeviceSampleRate** The telemetry sample rate assigned to the device. - **EnablePreviewBuilds** Used to enable Windows Insider builds on a device. - **FlightIds** A list of the different Windows Insider builds on this device. - **FlightingBranchName** The name of the Windows Insider branch currently used by the device. @@ -1494,23 +1401,23 @@ The following fields are available: ### Census.Hardware -This event sends data about the device, including hardware type, OEM brand, model line, model, diagnostic data level setting, and TPM support, to help keep Windows up-to-date. +This event sends data about the device, including hardware type, OEM brand, model line, model, telemetry level setting, and TPM support, to help keep Windows up to date. The following fields are available: - **ActiveMicCount** The number of active microphones attached to the device. - **ChassisType** Represents the type of device chassis, such as desktop or low profile desktop. The possible values can range between 1 - 36. - **ComputerHardwareID** Identifies a device class that is represented by a hash of different SMBIOS fields. -- **D3DMaxFeatureLevel** The supported Direct3D version. +- **D3DMaxFeatureLevel** Supported Direct3D version. - **DeviceColor** Indicates a color of the device. - **DeviceForm** Indicates the form as per the device classification. - **DeviceName** The device name that is set by the user. - **DigitizerSupport** Is a digitizer supported? - **DUID** The device unique ID. -- **Gyroscope** Indicates whether the device has a gyroscope. +- **Gyroscope** Indicates whether the device has a gyroscope (a mechanical component that measures and maintains orientation). - **InventoryId** The device ID used for compatibility testing. -- **Magnetometer** Indicates whether the device has a magnetometer. -- **NFCProximity** Indicates whether the device supports NFC. +- **Magnetometer** Indicates whether the device has a magnetometer (a mechanical component that works like a compass). +- **NFCProximity** Indicates whether the device supports NFC (a set of communication protocols that helps establish communication when applicable devices are brought close together.) - **OEMDigitalMarkerFileName** The name of the file placed in the \Windows\system32\drivers directory that specifies the OEM and model name of the device. - **OEMManufacturerName** The device manufacturer name. The OEMName for an inactive device is not reprocessed even if the clean OEM name is changed at a later date. - **OEMModelBaseBoard** The baseboard model used by the OEM. @@ -1526,9 +1433,9 @@ The following fields are available: - **PowerPlatformRole** The OEM preferred power management profile. It's used to help to identify the basic form factor of the device. - **SoCName** The firmware manufacturer of the device. - **StudyID** Used to identify retail and non-retail device. -- **TelemetryLevel** The diagnostic data level the user has opted into, such as Basic or Enhanced. -- **TelemetryLevelLimitEnhanced** The diagnostic data level for Windows Analytics-based solutions. -- **TelemetrySettingAuthority** Determines who set the diagnostic data level, such as GP, MDM, or the user. +- **TelemetryLevel** The telemetry level the user has opted into, such as Basic or Enhanced. +- **TelemetryLevelLimitEnhanced** The telemetry level for Windows Analytics-based solutions. +- **TelemetrySettingAuthority** Determines who set the telemetry level, such as GP, MDM, or the user. - **TPMVersion** The supported Trusted Platform Module (TPM) on the device. If no TPM is present, the value is 0. - **VoiceSupported** Does the device have a cellular radio capable of making voice calls? @@ -1573,9 +1480,9 @@ This event sends data about the operating system such as the version, locale, up The following fields are available: - **ActivationChannel** Retrieves the retail license key or Volume license key for a machine. -- **AssignedAccessStatus** The kiosk configuration mode. +- **AssignedAccessStatus** Kiosk configuration mode. - **CompactOS** Indicates if the Compact OS feature from Win10 is enabled. -- **DeveloperUnlockStatus** "Represents if a device has been developer unlocked by the user or Group Policy. " +- **DeveloperUnlockStatus** Represents if a device has been developer unlocked by the user or Group Policy. - **DeviceTimeZone** The time zone that is set on the device. Example: Pacific Standard Time - **GenuineState** Retrieves the ID Value specifying the OS Genuine check. - **InstallationType** Retrieves the type of OS installation. (Clean, Upgrade, Reset, Refresh, Update). @@ -1585,10 +1492,9 @@ The following fields are available: - **IsPortableOperatingSystem** Retrieves whether OS is running Windows-To-Go - **IsSecureBootEnabled** Retrieves whether Boot chain is signed under UEFI. - **LanguagePacks** The list of language packages installed on the device. -- **LicenseStateReason** Retrieves why (or how) a system is licensed or unlicensed. The HRESULT may indicate an error code that indicates a key blocked error, or it may indicate that we are running an OS License granted by the Microsoft Store. +- **LicenseStateReason** Retrieves why (or how) a system is licensed or unlicensed. The HRESULT may indicate an error code that indicates a key blocked error, or it may indicate that we are running an OS License granted by the MS store. - **OA3xOriginalProductKey** Retrieves the License key stamped by the OEM to the machine. - **OSEdition** Retrieves the version of the current OS. -- **OSInstallDateTime** Retrieves the date the OS was installed using ISO 8601 (Date part) == yyyy-mm-dd - **OSInstallType** Retrieves a numeric description of what install was used on the device i.e. clean, upgrade, refresh, reset, etc - **OSOOBEDateTime** Retrieves Out of Box Experience (OOBE) Date in Coordinated Universal Time (UTC). - **OSSKU** Retrieves the Friendly Name of OS Edition. @@ -1611,38 +1517,41 @@ The following fields are available: ### Census.Processor -This event sends data about the processor (architecture, speed, number of cores, manufacturer, and model number), to help keep Windows up to date. +Provides information on several important data points about Processor settings The following fields are available: -- **KvaShadow** Microcode info of the processor. -- **MMSettingOverride** Microcode setting of the processor. -- **MMSettingOverrideMask** Microcode setting override of the processor. -- **ProcessorArchitecture** Retrieves the processor architecture of the installed operating system. -- **ProcessorClockSpeed** Retrieves the clock speed of the processor in MHz. -- **ProcessorCores** Retrieves the number of cores in the processor. -- **ProcessorIdentifier** The processor identifier of a manufacturer. -- **ProcessorManufacturer** Retrieves the name of the processor's manufacturer. -- **ProcessorModel** Retrieves the name of the processor model. +- **KvaShadow** Microcode info of the processor. +- **MMSettingOverride** Microcode setting of the processor. +- **MMSettingOverrideMask** Microcode setting override of the processor. +- **ProcessorArchitecture** Retrieves the processor architecture of the installed operating system. +- **ProcessorClockSpeed** Clock speed of the processor in MHz. +- **ProcessorCores** Number of logical cores in the processor. +- **ProcessorIdentifier** Processor Identifier of a manufacturer. +- **ProcessorManufacturer** Name of the processor manufacturer. +- **ProcessorModel** Name of the processor model. - **ProcessorPhysicalCores** Number of physical cores in the processor. -- **ProcessorUpdateRevision** The microcode version. -- **SocketCount** Number of physical CPU sockets of the machine. -- **SpeculationControl** If the system has enabled protections needed to validate the speculation control vulnerability. +- **ProcessorUpdateRevision** Microcode revision +- **ProcessorUpdateStatus** Enum value that represents the processor microcode load status +- **SocketCount** Count of CPU sockets. +- **SpeculationControl** If the system has enabled protections needed to validate the speculation control vulnerability. ### Census.Security -This event provides information on about security settings used to help keep Windows up-to-date and secure. +This event provides information on about security settings used to help keep Windows up to date and secure. -- **AvailableSecurityProperties** Enumerates and reports state on the relevant security properties for Device Guard. -- **CGRunning** Is Credential Guard running? -- **DGState** A summary of the Device Guard state. -- **HVCIRunning** Is HVCI running? -- **IsSawGuest** Describes whether the device is running as a Secure Admin Workstation Guest. -- **IsSawHost** Describes whether the device is running as a Secure Admin Workstation Host. -- **RequiredSecurityProperties** Describes the required security properties to enable virtualization-based security. -- **SecureBootCapable** Is this device capable of running Secure Boot? -- **VBSState** Is virtualization-based security enabled, disabled, or running? +The following fields are available: + +- **AvailableSecurityProperties** This field helps to enumerate and report state on the relevant security properties for Device Guard. +- **CGRunning** Credential Guard isolates and hardens key system and user secrets against compromise, helping to minimize the impact and breadth of a Pass the Hash style attack in the event that malicious code is already running via a local or network based vector. This field tells if Credential Guard is running. +- **DGState** This field summarizes the Device Guard state. +- **HVCIRunning** Is HVCI running? +- **IsSawGuest** Indicates whether the device is running as a Secure Admin Workstation Guest. +- **IsSawHost** Indicates whether the device is running as a Secure Admin Workstation Host. +- **RequiredSecurityProperties** Describes the required security properties to enable virtualization-based security. +- **SecureBootCapable** Systems that support Secure Boot can have the feature turned off via BIOS. This field tells if the system is capable of running Secure Boot, regardless of the BIOS setting. +- **VBSState** Virtualization-based security (VBS) uses the hypervisor to help protect the kernel and other parts of the operating system. Credential Guard and Hypervisor Code Integrity (HVCI) both depend on VBS to isolate/protect secrets, and kernel-mode code integrity validation. VBS has a tri-state that can be Disabled, Enabled, or Running. ### Census.Speech @@ -1655,14 +1564,13 @@ The following fields are available: - **GPAllowInputPersonalization** Indicates if a Group Policy setting has enabled speech functionalities. - **HolographicSpeechInputDisabled** Holographic setting that represents if the attached HMD devices have speech functionality disabled by the user. - **HolographicSpeechInputDisabledRemote** Indicates if a remote policy has disabled speech functionalities for the HMD devices. -- **KWSEnabled** "Cortana setting that represents if a user has enabled the ""Hey Cortana"" keyword spotter (KWS)." +- **KWSEnabled** Cortana setting that represents if a user has enabled the "Hey Cortana" keyword spotter (KWS). - **MDMAllowInputPersonalization** Indicates if an MDM policy has enabled speech functionalities. -- **RemotelyManaged** Indicates if the device is being controlled by a remote admininistrator (MDM or Group Policy) in the context of speech functionalities. +- **RemotelyManaged** Indicates if the device is being controlled by a remote administrator (MDM or Group Policy) in the context of speech functionalities. - **SpeakerIdEnabled** Cortana setting that represents if keyword detection has been trained to try to respond to a single user's voice. - **SpeechServicesEnabled** Windows setting that represents whether a user is opted-in for speech services on the device. - ### Census.Storage This event sends data about the total capacity of the system volume and primary disk, to help keep Windows up to date. @@ -1673,14 +1581,36 @@ The following fields are available: - **PrimaryDiskType** Retrieves an enumerator value of type STORAGE_BUS_TYPE that indicates the type of bus to which the device is connected. This should be used to interpret the raw device properties at the end of this structure (if any). - **SystemVolumeTotalCapacity** Retrieves the size of the partition that the System volume is installed on in MB. + ### Census.Userdefault This event sends data about the current user's default preferences for browser and several of the most popular extensions and protocols, to help keep Windows up to date. The following fields are available: -- **DefaultApp** The current uer's default program selected for the following extension or protocol: .html,.htm,.jpg,.jpeg,.png,.mp3,.mp4, .mov,.pdf -- **DefaultBrowserProgId** The ProgramId of the current user's default browser +- **DefaultApp** The current uer's default program selected for the following extension or protocol: .html, .htm, .jpg, .jpeg, .png, .mp3, .mp4, .mov, .pdf. +- **DefaultBrowserProgId** The ProgramId of the current user's default browser. + + +### Census.UserDisplay + +This event sends data about the logical/physical display size, resolution and number of internal/external displays, and VRAM on the system, to help keep Windows up to date. + +The following fields are available: + +- **InternalPrimaryDisplayLogicalDPIX** Retrieves the logical DPI in the x-direction of the internal display. +- **InternalPrimaryDisplayLogicalDPIY** Retrieves the logical DPI in the y-direction of the internal display. +- **InternalPrimaryDisplayPhysicalDPIX** Retrieves the physical DPI in the x-direction of the internal display. +- **InternalPrimaryDisplayPhysicalDPIY** Retrieves the physical DPI in the y-direction of the internal display. +- **InternalPrimaryDisplayResolutionHorizontal** Retrieves the number of pixels in the horizontal direction of the internal display. +- **InternalPrimaryDisplayResolutionVertical** Retrieves the number of pixels in the vertical direction of the internal display. +- **InternalPrimaryDisplaySizePhysicalH** Retrieves the physical horizontal length of the display in mm. Used for calculating the diagonal length in inches . +- **InternalPrimaryDisplaySizePhysicalY** Retrieves the physical vertical length of the display in mm. Used for calculating the diagonal length in inches +- **NumberofExternalDisplays** Retrieves the number of external displays connected to the machine +- **NumberofInternalDisplays** Retrieves the number of internal displays in a machine. +- **VRAMDedicated** Retrieves the video RAM in MB. +- **VRAMDedicatedSystem** Retrieves the amount of memory on the dedicated video card. +- **VRAMSharedSystem** Retrieves the amount of RAM memory that the video card can use. ### Census.UserNLS @@ -1695,26 +1625,22 @@ The following fields are available: - **KeyboardInputLanguages** The Keyboard input languages installed on the device. - **SpeechInputLanguages** The Speech Input languages installed on the device. + ### Census.VM This event sends data indicating whether virtualization is enabled on the device, and its various characteristics, to help keep Windows up to date. The following fields are available: -- **CloudService** Indicates which cloud service, if any, that this virtual machine is running within. +- **CloudService** Indicates which cloud service, if any, that this virtual machine is running within. - **HyperVisor** Retrieves whether the current OS is running on top of a Hypervisor. - **IOMMUPresent** Represents if an input/output memory management unit (IOMMU) is present. -- **isVDI** Is the device using Virtual Desktop Infrastructure? -- **IsVirtualDevice** Retrieves that when the Hypervisor is Microsoft's Hyper-V Hypervisor or other Hv#HASH#1 Hypervisor, this field will be set to FALSE for the Hyper-V host OS and TRUE for any guest OS's. This field should not be relied upon for non-Hv#HASH#1 Hypervisors. +- **IsVDI** Is the device using Virtual Desktop Infrastructure? +- **IsVirtualDevice** Retrieves that when the Hypervisor is Microsoft's Hyper-V Hypervisor or other Hv#1 Hypervisor, this field will be set to FALSE for the Hyper-V host OS and TRUE for any guest OS's. This field should not be relied upon for non-Hv#1 Hypervisors. - **SLATSupported** Represents whether Second Level Address Translation (SLAT) is supported by the hardware. - **VirtualizationFirmwareEnabled** Represents whether virtualization is enabled in the firmware. - - - - - ### Census.WU This event sends data about the Windows update server and other App store policies, to help keep Windows up to date. @@ -1726,25 +1652,26 @@ The following fields are available: - **AppStoreAutoUpdateMDM** Retrieves the App Auto Update value for MDM: 0 - Disallowed. 1 - Allowed. 2 - Not configured. Default: [2] Not configured - **AppStoreAutoUpdatePolicy** Retrieves the Microsoft Store App Auto Update group policy setting - **DelayUpgrade** Retrieves the Windows upgrade flag for delaying upgrades. -- **OSAssessmentFeatureOutOfDate** How many days has it been since a the last feature update was released but the device did not install it? -- **OSAssessmentForFeatureUpdate** Is the device is on the latest feature update? -- **OSAssessmentForQualityUpdate** Is the device on the latest quality update? -- **OSAssessmentForSecurityUpdate** Is the device on the latest security update? -- **OSAssessmentQualityOutOfDate** How many days has it been since a the last quality update was released but the device did not install it? -- **OSAssessmentReleaseInfoTime** The freshness of release information used to perform an assessment. +- **OSAssessmentFeatureOutOfDate** How many days has it been since a the last feature update was released but the device did not install it? +- **OSAssessmentForFeatureUpdate** Is the device is on the latest feature update? +- **OSAssessmentForQualityUpdate** Is the device on the latest quality update? +- **OSAssessmentForSecurityUpdate** Is the device on the latest security update? +- **OSAssessmentQualityOutOfDate** How many days has it been since a the last quality update was released but the device did not install it? +- **OSAssessmentReleaseInfoTime** The freshness of release information used to perform an assessment. - **OSRollbackCount** The number of times feature updates have rolled back on the device. - **OSRolledBack** A flag that represents when a feature update has rolled back during setup. - **OSUninstalled** A flag that represents when a feature update is uninstalled on a device . - **OSWUAutoUpdateOptions** Retrieves the auto update settings on the device. - **UninstallActive** A flag that represents when a device has uninstalled a previous upgrade recently. - **UpdateServiceURLConfigured** Retrieves if the device is managed by Windows Server Update Services (WSUS). -- **WUDeferUpdatePeriod** Retrieves if deferral is set for Updates -- **WUDeferUpgradePeriod** Retrieves if deferral is set for Upgrades +- **WUDeferUpdatePeriod** Retrieves if deferral is set for Updates. +- **WUDeferUpgradePeriod** Retrieves if deferral is set for Upgrades. - **WUDODownloadMode** Retrieves whether DO is turned on and how to acquire/distribute updates Delivery Optimization (DO) allows users to deploy previously downloaded WU updates to other devices on the same network. - **WUMachineId** Retrieves the Windows Update (WU) Machine Identifier. -- **WUPauseState** Retrieves WU setting to determine if updates are paused +- **WUPauseState** Retrieves WU setting to determine if updates are paused. - **WUServer** Retrieves the HTTP(S) URL of the WSUS server that is used by Automatic Updates and API callers (by default). + ### Census.Xbox This event sends data about the Xbox Console, such as Serial Number and DeviceId, to help keep Windows up to date. @@ -1753,349 +1680,863 @@ The following fields are available: - **XboxConsolePreferredLanguage** Retrieves the preferred language selected by the user on Xbox console. - **XboxConsoleSerialNumber** Retrieves the serial number of the Xbox console. -- **XboxLiveDeviceId** Retrieves the unique device id of the console. -- **XboxLiveSandboxId** Retrieves the developer sandbox id if the device is internal to MS. +- **XboxLiveDeviceId** Retrieves the unique device ID of the console. +- **XboxLiveSandboxId** Retrieves the developer sandbox ID if the device is internal to Microsoft. +## Common data extensions + +### Common Data Extensions.app + +Describes the properties of the running application. This extension could be populated by a client app or a web app. + +The following fields are available: + +- **asId** An integer value that represents the app session. This value starts at 0 on the first app launch and increments after each subsequent app launch per boot session. +- **env** The environment from which the event was logged. +- **expId** Associates a flight, such as an OS flight, or an experiment, such as a web site UX experiment, with an event. +- **id** Represents a unique identifier of the client application currently loaded in the process producing the event; and is used to group events together and understand usage pattern, errors by application. +- **userId** The userID as known by the application. +- **ver** Represents the version number of the application. Used to understand errors by Version, Usage by Version across an app. + + +### Common Data Extensions.container + +Describes the properties of the container for events logged within a container. + +The following fields are available: + +- **localId** The device ID as known by the client. +- **osVer** The operating system version. +- **type** The container type. Examples: Process or VMHost + + +### Common Data Extensions.cs + +Describes properties related to the schema of the event. + +The following fields are available: + +- **sig** A common schema signature that identifies new and modified event schemas. + + +### Common Data Extensions.device + +Describes the device-related fields. + +The following fields are available: + +- **deviceClass** Represents the classification of the device, the device “family”. For example, Desktop, Server, or Mobile. +- **localId** Represents a locally defined unique ID for the device, not the human readable device name. Most likely equal to the value stored at HKLM\Software\Microsoft\SQMClient\MachineId + + +### Common Data Extensions.Envelope + +Represents an envelope that contains all of the common data extensions. + +The following fields are available: + +- **appId** Represents a unique identifier of the client application currently loaded in the process producing the event; and is used to group events together and understand usage pattern, errors by application. +- **appVer** Represents the version number of the application. Used to understand errors by version and usage by version across an app. +- **cV** Represents the Correlation Vector: A single field for tracking partial order of related telemetry events across component boundaries. +- **data** Represents the optional unique diagnostic data for a particular event schema. +- **epoch** ID used to help distinguish events in the sequence by indicating the current boot session. +- **ext_app** Describes the properties of the running application. This extension could be populated by either a client app or a web app. See [Common Data Extensions.app](#common-data-extensionsapp). +- **ext_container** Describes the properties of the container for events logged within a container. See [Common Data Extensions.container](#common-data-extensionscontainer). +- **ext_cs** Describes properties related to the schema of the event. See [Common Data Extensions.cs](#common-data-extensionscs). +- **ext_device** Describes the device-related fields. See [Common Data Extensions.device](#common-data-extensionsdevice). +- **ext_os** Describes the operating system properties that would be populated by the client. See [Common Data Extensions.os](#common-data-extensionsos). +- **ext_user** Describes the fields related to a user. See [Common Data Extensions.user](#common-data-extensionsuser). +- **ext_utc** Describes the fields that might be populated by a logging library on Windows. See [Common Data Extensions.utc](#common-data-extensionsutc). +- **ext_xbl** Describes the fields related to XBOX Live. See [Common Data Extensions.xbl](#common-data-extensionsxbl). +- **flags** Represents a collection of bits that describe how the event should be processed by the Connected User Experience and Telemetry component pipeline. The lowest-order byte is the event persistence. The next byte is the event latency. +- **iKey** Represents an ID for applications or other logical groupings of events. +- **name** Represents the uniquely qualified name for the event. +- **os** The operating system name. +- **osVer** The operating system version. +- **popSample** Represents the effective sample rate for this event at the time it was generated by a client. +- **seqNum** Used to track the absolute order of uploaded events. +- **tags** A header for semi-managed extensions. +- **time** Represents the event date time in Coordinated Universal Time (UTC) when the event was generated on the client. This should be in ISO 8601 format. +- **ver** Represents the major and minor version of the extension. + + +### Common Data Extensions.os + +Describes some properties of the operating system. + +The following fields are available: + +- **bootId** An integer value that represents the boot session. This value starts at 0 on first boot after OS install and increments after every reboot. +- **expId** Represents the experiment ID. The standard for associating a flight, such as an OS flight (pre-release build), or an experiment, such as a web site UX experiment, with an event is to record the flight / experiment IDs in Part A of the common schema. +- **locale** Represents the locale of the operating system. + + +### Common Data Extensions.user + +Describes the fields related to a user. + +The following fields are available: + +- **authId** This is an ID of the user associated with this event that is deduced from a token such as a Microsoft Account ticket or an XBOX token. +- **localId** Represents a unique user identity that is created locally and added by the client. This is not the user's account ID. + + +### Common Data Extensions.utc + +Describes the properties that could be populated by a logging library on Windows. + +The following fields are available: + +- **aId** Represents the ETW ActivityId. Logged via TraceLogging or directly via ETW. +- **bSeq** Upload buffer sequence number in the format: buffer identifier:sequence number +- **cat** Represents a bitmask of the ETW Keywords associated with the event. +- **cpId** The composer ID, such as Reference, Desktop, Phone, Holographic, Hub, IoT Composer. +- **flags** Represents the bitmap that captures various Windows specific flags. +- **mon** Combined monitor and event sequence numbers in the format: monitor sequence : event sequence +- **op** Represents the ETW Op Code. +- **raId** Represents the ETW Related ActivityId. Logged via TraceLogging or directly via ETW. +- **sqmId** The Windows SQM ID. +- **stId** Represents the Scenario Entry Point ID. This is a unique GUID for each event in a diagnostic scenario. This used to be Scenario Trigger ID. +- **tickets** An array of strings that refer back to a key in the X-Tickets http header that the client uploaded along with a batch of events. + + +### Common Data Extensions.xbl + +Describes the fields that are related to XBOX Live. + +The following fields are available: + +- **claims** Any additional claims whose short claim name hasn't been added to this structure. +- **did** XBOX device ID +- **dty** XBOX device type +- **dvr** The version of the operating system on the device. +- **eid** A unique ID that represents the developer entity. +- **exp** Expiration time +- **ip** The IP address of the client device. +- **nbf** Not before time +- **pid** A comma separated list of PUIDs listed as base10 numbers. +- **sbx** XBOX sandbox identifier +- **sid** The service instance ID. +- **sty** The service type. +- **tid** The XBOX Live title ID. +- **tvr** The XBOX Live title version. +- **uts** A bit field, with 2 bits being assigned to each user ID listed in xid. This field is omitted if all users are retail accounts. +- **xid** A list of base10-encoded XBOX User IDs. + + +## Common data fields + +### Ms.Device.DeviceInventoryChange + +Describes the installation state for all hardware and software components available on a particular device. + +The following fields are available: + +- **action** The change that was invoked on a device inventory object. +- **inventoryId** Device ID used for Compatibility testing +- **objectInstanceId** Object identity which is unique within the device scope. +- **objectType** Indicates the object type that the event applies to. +- **syncId** A string used to group StartSync, EndSync, Add, and Remove operations that belong together. This field is unique by Sync period and is used to disambiguate in situations where multiple agents perform overlapping inventories for the same object. ## Diagnostic data events -### TelClientSynthetic.AuthorizationInfo_Startup - -This event sends data indicating that a device has undergone a change of diagnostic data opt-in level detected at UTC startup, to help keep Windows up to date. - -The following fields are available: - -- **CanAddMsaToMsTelemetry** True if UTC is allowed to add MSA user identity onto diagnostic data from the OS provider groups. -- **CanCollectAnyTelemetry** True if UTC is allowed to collect non-OS diagnostic data. Non-OS diagnostic data is responsible for providing its own opt-in mechanism. -- **CanCollectCoreTelemetry** True if UTC is allowed to collect data which is tagged with both MICROSOFT_KEYWORD_CRITICAL_DATA and MICROSOFT_EVENTTAG_CORE_DATA. -- **CanCollectHeartbeats** True if UTC is allowed to collect heartbeats. -- **CanCollectOsTelemetry** True if UTC is allowed to collect diagnostic data from the OS provider groups. -- **CanPerformDiagnosticEscalations** True if UTC is allowed to perform all scenario escalations. -- **CanPerformScripting** True if UTC is allowed to perform scripting. -- **CanPerformTraceEscalations** True if UTC is allowed to perform scenario escalations with tracing actions. -- **CanReportScenarios** True if UTC is allowed to load and report scenario completion, failure, and cancellation events. -- **PreviousPermissions** Bitmask representing the previously configured permissions since the diagnostic data client was last started. -- **TransitionFromEverythingOff** True if this transition is moving from not allowing core diagnostic data to allowing core diagnostic data. - - ### TelClientSynthetic.AuthorizationInfo_RuntimeTransition -This event sends data indicating that a device has undergone a change of diagnostic data opt-in level during the runtime of the device (not at UTC boot or offline), to help keep Windows up to date. - -The following fields are available: - -- **CanAddMsaToMsTelemetry** True if UTC is allowed to add MSA user identity onto diagnostic data from the OS provider groups. -- **CanCollectAnyTelemetry** True if UTC is allowed to collect non-OS diagnostic data. Non-OS diagnostic data is responsible for providing its own opt-in mechanism. -- **CanCollectCoreTelemetry** True if UTC is allowed to collect data which is tagged with both MICROSOFT_KEYWORD_CRITICAL_DATA and MICROSOFT_EVENTTAG_CORE_DATA. -- **CanCollectHeartbeats** True if UTC is allowed to collect heartbeats. -- **CanCollectOsTelemetry** True if UTC is allowed to collect diagnostic data from the OS provider groups. -- **CanPerformDiagnosticEscalations** True if UTC is allowed to perform all scenario escalations. -- **CanPerformScripting** True if UTC is allowed to perform scripting. -- **CanPerformTraceEscalations** True if UTC is allowed to perform scenario escalations with tracing actions. -- **CanReportScenarios** True if UTC is allowed to load and report scenario completion, failure, and cancellation events. -- **PreviousPermissions** Bitmask representing the previously configured permissions since the diagnostic data opt-in level was last changed. -- **TransitionFromEverythingOff** True if this transition is moving from not allowing core diagnostic data to allowing core diagnostic data. +This event sends data indicating that a device has undergone a change of telemetry opt-in level detected at UTC startup, to help keep Windows up to date. The telemetry opt-in level signals what data we are allowed to collect. -### TelClientSynthetic.ConnectivityHeartBeat_0 -This event sends data about the connectivity status of the Connected User Experience and Telemetry component that uploads diagnostic data events. If an unrestricted free network (such as Wi-Fi) is available, this event updates the last successful upload time. Otherwise, it checks whether a Connectivity Heartbeat event was fired in the past 24 hours, and if not, it fires an event. A Connectivity Heartbeat event also fires when a device recovers from costed network to free network. +### TelClientSynthetic.AuthorizationInfo_Startup -The following fields are available: +This event sends data indicating that a device has undergone a change of telemetry opt-in level detected at UTC startup, to help keep Windows up to date. The telemetry opt-in level signals what data we are allowed to collect. -- **CensusExitCode** Returns last execution codes from census client run. -- **CensusStartTime** Returns timestamp corresponding to last successful census run. -- **CensusTaskEnabled** Returns Boolean value for the census task (Enable/Disable) on client machine. -- **LastConnectivityLossTime** Retrieves the last time the device lost free network. -- **LastConntectivityLossTime** Retrieves the last time the device lost free network. -- **NetworkState** Retrieves the network state: 0 = No network. 1 = Restricted network. 2 = Free network. -- **NoNetworkTime** Retrieves the time spent with no network (since the last time) in seconds. -- **RestrictedNetworkTime** Retrieves the time spent on a metered (cost restricted) network in seconds. ### TelClientSynthetic.HeartBeat_5 This event sends data about the health and quality of the diagnostic data from the given device, to help keep Windows up to date. It also enables data analysts to determine how 'trusted' the data is from a given device. -The following fields are available: - -- **AgentConnectionErrorsCount** The number of non-timeout errors associated with the host/agent channel. -- **CensusExitCode** The last exit code of the Census task. -- **CensusStartTime** The time of the last Census run. -- **CensusTaskEnabled** Indicates whether Census is enabled. -- **ConsumerDroppedCount** The number of events dropped by the consumer layer of the diagnostic data client. -- **CriticalDataDbDroppedCount** The number of critical data sampled events that were dropped at the database layer. -- **CriticalDataThrottleDroppedCount** The number of critical data sampled events that were dropped because of throttling. -- **CriticalOverflowEntersCounter** The number of times a critical overflow mode was entered into the event database. -- **DbCriticalDroppedCount** The total number of dropped critical events in the event database. -- **DbDroppedCount** The number of events that were dropped because the database was full. -- **DecodingDroppedCount** The number of events dropped because of decoding failures. -- **EnteringCriticalOverflowDroppedCounter** The number of events that was dropped because a critical overflow mode was initiated. -- **EtwDroppedBufferCount** The number of buffers dropped in the CUET ETW session. -- **EtwDroppedCount** The number of events dropped by the ETW layer of the diagnostic data client. -- **EventSubStoreResetCounter** The number of times the event database was reset. -- **EventSubStoreResetSizeSum** The total size of the event database across all resets reports in this instance. -- **EventsUploaded** The number of events that have been uploaded. -- **Flags** Flags that indicate device state, such as network, battery, and opt-in state. -- **FullTriggerBufferDroppedCount** The number of events that were dropped because the trigger buffer was full. -- **HeartBeatSequenceNumber** A monotonically increasing heartbeat counter. -- **InvalidHttpCodeCount** The number of invalid HTTP codes received from Vortex. -- **LastAgentConnectionError** The last non-timeout error that happened in the host/agent channel. -- **LastEventSizeOffender** The name of the last event that exceeded the maximum event size. -- **LastInvalidHttpCode** The last invalid HTTP code received from Vortex. -- **MaxActiveAgentConnectionCount** The maximum number of active agents during this heartbeat timeframe. -- **MaxInUseScenarioCounter** The soft maximum number of scenarios loaded by the Connected User Experiences and Telemetry component. -- **PreviousHeartBeatTime** The time of last heartbeat event. This allows chaining of events. -- **SettingsHttpAttempts** The number of attempts to contact the OneSettings service. -- **SettingsHttpFailures** The number of failures from contacting the OneSettings service. -- **ThrottledDroppedCount** The number of events dropped due to throttling of noisy providers. -- **UploaderDroppedCount** The number of events dropped by the uploader layer of the diagnostic data client. -- **VortexFailuresTimeout** The number of timeout failures received from Vortex. -- **VortexHttpAttempts** The number of attempts to contact the Vortex service. -- **VortexHttpFailures4xx** The number of 400-499 error codes received from Vortex. -- **VortexHttpFailures5xx** The number of 500-599 error codes received from Vortex. -### TelClientSynthetic.PrivacySettingsAfterCreatorsUpdate +### TelClientSynthetic.HeartBeat_Aria_5 -This event sends basic data on privacy settings before and after a feature update. This is used to ensure that customer privacy settings are correctly migrated across feature updates. +This event is the telemetry client ARIA heartbeat. The following fields are available: -- **PostUpgradeSettings** The privacy settings after a feature update. -- **PreUpgradeSettings** The privacy settings before a feature update. - - -## DxgKernelTelemetry events - -### DxgKrnlTelemetry.GPUAdapterInventoryV2 - -This event sends basic GPU and display driver information to keep Windows and display drivers up-to-date. - -The following fields are available: - -- **aiSeqId** The event sequence ID. -- **bootId** The system boot ID. -- **ComputePreemptionLevel** The maximum preemption level supported by GPU for compute payload. -- **DedicatedSystemMemoryB** The amount of system memory dedicated for GPU use (in bytes). -- **DedicatedVideoMemoryB** The amount of dedicated VRAM of the GPU (in bytes). -- **DisplayAdapterLuid** The display adapter LUID. -- **DriverDate** The date of the display driver. -- **DriverRank** The rank of the display driver. -- **DriverVersion** The display driver version. -- **GPUDeviceID** The GPU device ID. -- **GPUPreemptionLevel** The maximum preemption level supported by GPU for graphics payload. -- **GPURevisionID** The GPU revision ID. -- **GPUVendorID** The GPU vendor ID. -- **InterfaceId** The GPU interface ID. -- **IsDisplayDevice** Does the GPU have displaying capabilities? -- **IsHybridDiscrete** Does the GPU have discrete GPU capabilities in a hybrid device? -- **IsHybridIntegrated** Does the GPU have integrated GPU capabilities in a hybrid device? -- **IsLDA** Is the GPU comprised of Linked Display Adapters? -- **IsMiracastSupported** Does the GPU support Miracast? -- **IsMismatchLDA** Is at least one device in the Linked Display Adapters chain from a different vendor? -- **IsMPOSupported** Does the GPU support Multi-Plane Overlays? -- **IsMsMiracastSupported** Are the GPU Miracast capabilities driven by a Microsoft solution? -- **IsPostAdapter** Is this GPU the POST GPU in the device? -- **IsRenderDevice** Does the GPU have rendering capabilities? -- **IsSoftwareDevice** Is this a software implementation of the GPU? -- **MeasureEnabled** Is the device listening to MICROSOFT_KEYWORD_MEASURES? -- **SharedSystemMemoryB** The amount of system memory shared by GPU and CPU (in bytes). -- **SubSystemID** The subsystem ID. -- **SubVendorID** The GPU sub vendor ID. -- **TelemetryEnabled** Is the device listening to MICROSOFT_KEYWORD_TELEMETRY? -- **TelInvEvntTrigger** What triggered this event to be logged? Example: 0 (GPU enumeration) or 1 (DxgKrnlTelemetry provider toggling) -- **version** The event version. -- **WDDMVersion** The Windows Display Driver Model version. -- **NumVidPnSources** The number of supported display output sources. -- **NumVidPnTargets** The number of supported display output targets. - - -## Fault Reporting events - -### Microsoft.Windows.FaultReporting.AppCrashEvent - -"This event sends data about crashes for both native and managed applications, to help keep Windows up to date. The data includes information about the crashing process and a summary of its exception record. It does not contain any Watson bucketing information. The bucketing information is recorded in a Windows Error Reporting (WER) event that is generated when the WER client reports the crash to the Watson service, and the WER event will contain the same ReportID (see field 14 of crash event, field 19 of WER event) as the crash event for the crash being reported. AppCrash is emitted once for each crash handled by WER (e.g. from an unhandled exception or FailFast or ReportException). Note that Generic Watson event types (e.g. from PLM) that may be considered crashes"" by a user DO NOT emit this event." - -The following fields are available: - -- **AppName** The name of the app that has crashed. -- **AppSessionGuid** GUID made up of process ID and is used as a correlation vector for process instances in the diagnostic data backend. -- **AppTimeStamp** The date/time stamp of the app. -- **AppVersion** The version of the app that has crashed. -- **ExceptionCode** The exception code returned by the process that has crashed. -- **ExceptionOffset** The address where the exception had occurred. -- **Flags** "Flags indicating how reporting is done. For example, queue the report, do not offer JIT debugging, or do not terminate the process after reporting. " -- **ModName** Exception module name (e.g. bar.dll). -- **ModTimeStamp** The date/time stamp of the module. -- **ModVersion** The version of the module that has crashed. -- **PackageFullName** Store application identity. -- **PackageRelativeAppId** Store application identity. -- **ProcessArchitecture** Architecture of the crashing process, as one of the PROCESSOR_ARCHITECTURE_* constants: 0: PROCESSOR_ARCHITECTURE_INTEL. 5: PROCESSOR_ARCHITECTURE_ARM. 9: PROCESSOR_ARCHITECTURE_AMD64. 12: PROCESSOR_ARCHITECTURE_ARM64. -- **ProcessCreateTime** The time of creation of the process that has crashed. -- **ProcessId** The ID of the process that has crashed. -- **ReportId** A GUID used to identify the report. This can used to track the report across Watson. -- **TargetAppId** The kernel reported AppId of the application being reported. -- **TargetAppVer** The specific version of the application being reported -- **TargetAsId** The sequence number for the hanging process. +- **CompressedBytesUploaded** Number of compressed bytes uploaded +- **CriticalDataDbDroppedCount** Number of critical data sampled events dropped at the database layer. +- **CriticalOverflowEntersCounter** Number of times critical overflow mode was entered in event database. +- **DbCriticalDroppedCount** Total number of dropped critical events in event database. +- **DbDroppedCount** Number of events dropped at the database layer. +- **EnteringCriticalOverflowDroppedCounter** Number of events dropped due to critical overflow mode being initiated. +- **EventSubStoreResetCounter** Number of times event database was reset. +- **EventSubStoreResetSizeSum** Total size of event database across all resets reports in this instance. +- **EventsUploaded** Number of events uploaded. +- **InvalidHttpCodeCounter** Number of invalid HTTP codes received from contacting Vortex. +- **LastInvalidHttpCode** Last invalid HTTP code received from Vortex. +- **SettingsHttpAttempts** Number of attempts to contact OneSettings service. +- **SettingsHttpFailures** Number of failures from contacting OneSettings service. +- **UploaderDroppedCount** Number of events dropped at the uploader layer of telemetry client. +- **VortexFailuresTimeout** Number of time out failures received from Vortex. +- **VortexHttpAttempts** Number of attempts to contact Vortex. +- **VortexHttpFailures4xx** Number of 400-499 error codes received from Vortex. +- **VortexHttpFailures5xx** Number of 500-599 error codes received from Vortex. +- **VortexHttpResponseFailures** Number of Vortex responses that are not 2XX or 400. +- **VortexHttpResponsesWithDroppedEvents** Number of Vortex responses containing at least 1 dropped event. ## Feature update events ### Microsoft.Windows.Upgrade.Uninstall.UninstallFailed -This event sends diagnostic data about failures when uninstalling a feature update, to help resolve any issues preventing customers from reverting to a known state +This event sends diagnostic data about failures when uninstalling a feature update, to help resolve any issues preventing customers from reverting to a known state. The following fields are available: -- **failureReason** Provides data about the uninstall initialization operation failure -- **hr** Provides the Win32 error code for the operation failure +- **failureReason** Provides data about the uninstall initialization operation failure. +- **hr** Provides the Win32 error code for the operation failure. ### Microsoft.Windows.Upgrade.Uninstall.UninstallFinalizedAndRebootTriggered -Indicates that the uninstall was properly configured and that a system reboot was initiated +This event indicates that the uninstall was properly configured and that a system reboot was initiated. The following fields are available: - **name** Name of the event -## Hang Reporting events +### Microsoft.Windows.Upgrade.Uninstall.UninstallGoBackButtonClicked -### Microsoft.Windows.HangReporting.AppHangEvent +This event sends basic metadata about the starting point of uninstalling a feature update, which helps ensure customers can safely revert to a well-known state if the update caused any problems. -This event sends data about hangs for both native and managed applications, to help keep Windows up to date. It does not contain any Watson bucketing information. The bucketing information is recorded in a Windows Error Reporting (WER) event that is generated when the WER client reports the hang to the Watson service, and the WER event will contain the same ReportID (see field 13 of hang event, field 19 of WER event) as the hang event for the hang being reported. AppHang is reported only on PC devices. It handles classic Win32 hangs and is emitted only once per report. Some behaviors that may be perceived by a user as a hang are reported by app managers (e.g. PLM/RM/EM) as Watson Generics and will not produce AppHang events. - -The following fields are available: - -- **AppName** The name of the app that has hung. -- **AppSessionGuid** GUID made up of process id used as a correlation vector for process instances in the diagnostic data backend. -- **AppVersion** The version of the app that has hung. -- **PackageFullName** Store application identity. -- **PackageRelativeAppId** Store application identity. -- **ProcessArchitecture** Architecture of the hung process, as one of the PROCESSOR_ARCHITECTURE_* constants: 0: PROCESSOR_ARCHITECTURE_INTEL. 5: PROCESSOR_ARCHITECTURE_ARM. 9: PROCESSOR_ARCHITECTURE_AMD64. 12: PROCESSOR_ARCHITECTURE_ARM64. -- **ProcessCreateTime** The time of creation of the process that has hung. -- **ProcessId** The ID of the process that has hung. -- **ReportId** A GUID used to identify the report. This can used to track the report across Watson. -- **TargetAppId** The kernel reported AppId of the application being reported. -- **TargetAppVer** The specific version of the application being reported. -- **TargetAsId** The sequence number for the hanging process. -- **TypeCode** Bitmap describing the hang type. -- **WaitingOnAppName** If this is a cross process hang waiting for an application, this has the name of the application. -- **WaitingOnAppVersion** If this is a cross process hang, this has the version of the application for which it is waiting. -- **WaitingOnPackageFullName** If this is a cross process hang waiting for a package, this has the full name of the package for which it is waiting. -- **WaitingOnPackageRelativeAppId** If this is a cross process hang waiting for a package, this has the relative application id of the package. ## Inventory events -### Microsoft.Windows.Inventory.Core.InventoryDeviceUsbHubClassStartSync +### Microsoft.Windows.Inventory.Core.AmiTelCacheChecksum -This event indicates that a new set of InventoryDeviceUsbHubClassAdd events will be sent +This event captures basic checksum data about the device inventory items stored in the cache for use in validating data completeness for Microsoft.Windows.Inventory.Core events. The fields in this event may change over time, but they will always represent a count of a given object. The following fields are available: -- **InventoryVersion** The version of the inventory file generating the events +- **Device** A count of device objects in cache. +- **DeviceCensus** A count of devicecensus objects in cache. +- **DriverPackageExtended** A count of driverpackageextended objects in cache. +- **File** A count of file objects in cache. +- **FileSigningInfo** A count of file signing objects in cache. +- **Generic** A count of generic objects in cache. +- **HwItem** A count of hwitem objects in cache. +- **InventoryApplication** A count of application objects in cache. +- **InventoryApplicationFile** A count of application file objects in cache. +- **InventoryDeviceContainer** A count of device container objects in cache. +- **InventoryDeviceInterface** A count of Plug and Play device interface objects in cache. +- **InventoryDeviceMediaClass** A count of device media objects in cache. +- **InventoryDevicePnp** A count of device Plug and Play objects in cache. +- **InventoryDeviceUsbHubClass** A count of device usb objects in cache +- **InventoryDriverBinary** A count of driver binary objects in cache. +- **InventoryDriverPackage** A count of device objects in cache. +- **Metadata** A count of metadata objects in cache. +- **Orphan** A count of orphan file objects in cache. +- **Programs** A count of program objects in cache. + + +### Microsoft.Windows.Inventory.Core.AmiTelCacheVersions + +This event sends inventory component versions for the Device Inventory data. + +The following fields are available: + +- **aeinv** The version of the App inventory component. +- **devinv** The file version of the Device inventory component. + + +### Microsoft.Windows.Inventory.Core.InventoryApplicationAdd + +This event sends basic metadata about an application on the system to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **HiddenArp** Indicates whether a program hides itself from showing up in ARP. +- **InstallDate** The date the application was installed (a best guess based on folder creation date heuristics). +- **InstallDateArpLastModified** The date of the registry ARP key for a given application. Hints at install date but not always accurate. Passed as an array. Example: 4/11/2015 00:00:00 +- **InstallDateFromLinkFile** The estimated date of install based on the links to the files. Passed as an array. +- **InstallDateMsi** The install date if the application was installed via Microsoft Installer (MSI). Passed as an array. +- **InventoryVersion** The version of the inventory file generating the events. +- **Language** The language code of the program. +- **MsiPackageCode** A GUID that describes the MSI Package. Multiple 'Products' (apps) can make up an MsiPackage. +- **MsiProductCode** A GUID that describe the MSI Product. +- **Name** The name of the application. +- **OSVersionAtInstallTime** The four octets from the OS version at the time of the application's install. +- **PackageFullName** The package full name for a Store application. +- **ProgramInstanceId** A hash of the file IDs in an app. +- **Publisher** The Publisher of the application. Location pulled from depends on the 'Source' field. +- **RootDirPath** The path to the root directory where the program was installed. +- **Source** How the program was installed (for example, ARP, MSI, Appx). +- **StoreAppType** A sub-classification for the type of Microsoft Store app, such as UWP or Win8StoreApp. +- **Type** One of ("Application", "Hotfix", "BOE", "Service", "Unknown"). Application indicates Win32 or Appx app, Hotfix indicates app updates (KBs), BOE indicates it's an app with no ARP or MSI entry, Service indicates that it is a service. Application and BOE are the ones most likely seen. +- **Version** The version number of the program. + + +### Microsoft.Windows.Inventory.Core.InventoryApplicationDriverAdd + +This event represents what drivers an application installs. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory component +- **ProgramIds** The unique program identifier the driver is associated with. + + +### Microsoft.Windows.Inventory.Core.InventoryApplicationDriverStartSync + +The InventoryApplicationDriverStartSync event indicates that a new set of InventoryApplicationDriverStartAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory component. + + +### Microsoft.Windows.Inventory.Core.InventoryApplicationFrameworkAdd + +This event provides the basic metadata about the frameworks an application may depend on. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **FileId** A hash that uniquely identifies a file. +- **Frameworks** The list of frameworks this file depends on. +- **InventoryVersion** The version of the inventory file generating the events. +- **ProgramId** A hash of the Name, Version, Publisher, and Language of an application used to identify it + + +### Microsoft.Windows.Inventory.Core.InventoryApplicationFrameworkStartSync + +This event indicates that a new set of InventoryApplicationFrameworkAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryApplicationRemove + +This event indicates that a new set of InventoryDevicePnpAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryApplicationStartSync + +This event indicates that a new set of InventoryApplicationAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDeviceContainerAdd + +This event sends basic metadata about a device container (such as a monitor or printer as opposed to a Plug and Play device) to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **Categories** A comma separated list of functional categories in which the container belongs. +- **DiscoveryMethod** The discovery method for the device container. +- **FriendlyName** The name of the device container. +- **InventoryVersion** The version of the inventory file generating the events. +- **IsActive** Is the device connected, or has it been seen in the last 14 days? +- **IsConnected** For a physically attached device, this value is the same as IsPresent. For wireless a device, this value represents a communication link. +- **IsMachineContainer** Is the container the root device itself? +- **IsNetworked** Is this a networked device? +- **IsPaired** Does the device container require pairing? +- **Manufacturer** The manufacturer name for the device container. +- **ModelId** A unique model ID. +- **ModelName** The model name. +- **ModelNumber** The model number for the device container. +- **PrimaryCategory** The primary category for the device container. + + +### Microsoft.Windows.Inventory.Core.InventoryDeviceContainerRemove + +This event indicates that the InventoryDeviceContainer object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDeviceContainerStartSync + +This event indicates that a new set of InventoryDeviceContainerAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDeviceInterfaceAdd + +This event retrieves information about what sensor interfaces are available on the device. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **Accelerometer3D** Indicates if an Accelerator3D sensor is found. +- **ActivityDetection** Indicates if an Activity Detection sensor is found. +- **AmbientLight** Indicates if an Ambient Light sensor is found. +- **Barometer** Indicates if a Barometer sensor is found. +- **Custom** Indicates if a Custom sensor is found. +- **EnergyMeter** Indicates if an Energy sensor is found. +- **FloorElevation** Indicates if a Floor Elevation sensor is found. +- **GeomagneticOrientation** Indicates if a Geo Magnetic Orientation sensor is found. +- **GravityVector** Indicates if a Gravity Detector sensor is found. +- **Gyrometer3D** Indicates if a Gyrometer3D sensor is found. +- **Humidity** Indicates if a Humidity sensor is found. +- **InventoryVersion** The version of the inventory file generating the events. +- **LinearAccelerometer** Indicates if a Linear Accelerometer sensor is found. +- **Magnetometer3D** Indicates if a Magnetometer3D sensor is found. +- **Orientation** Indicates if an Orientation sensor is found. +- **Pedometer** Indicates if a Pedometer sensor is found. +- **Proximity** Indicates if a Proximity sensor is found. +- **RelativeOrientation** Indicates if a Relative Orientation sensor is found. +- **SimpleDeviceOrientation** Indicates if a Simple Device Orientation sensor is found. +- **Temperature** Indicates if a Temperature sensor is found. + + +### Microsoft.Windows.Inventory.Core.InventoryDeviceInterfaceStartSync + +This event indicates that a new set of InventoryDeviceInterfaceAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDeviceMediaClassAdd + +This event sends additional metadata about a Plug and Play device that is specific to a particular class of devices to help keep Windows up to date while reducing overall size of data payload. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **Audio_CaptureDriver** The Audio device capture driver endpoint. +- **Audio_RenderDriver** The Audio device render driver endpoint. +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDeviceMediaClassRemove + +This event indicates that the InventoryDeviceMediaClassRemove object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDeviceMediaClassStartSync + +This event indicates that a new set of InventoryDeviceMediaClassSAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDevicePnpAdd + +This event represents the basic metadata about a plug and play (PNP) device and its associated driver. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **BusReportedDescription** System-supplied GUID that uniquely groups the functional devices associated with a single-function or multifunction device installed in the computer. +- **Class** System-supplied GUID that uniquely groups the functional devices associated with a single-function or multifunction device installed in the computer. +- **ClassGuid** A unique identifier for the driver installed. +- **COMPID** Name of the .sys image file (or wudfrd.sys if using user mode driver framework). +- **ContainerId** INF file name (the name could be renamed by OS, such as oemXX.inf) +- **Description** The version of the inventory binary generating the events. +- **DeviceState** The current error code for the device. +- **DriverId** A unique identifier for the driver installed. +- **DriverName** Name of the .sys image file (or wudfrd.sys if using user mode driver framework). +- **DriverPackageStrongName** The immediate parent directory name in the Directory field of InventoryDriverPackage. +- **DriverVerDate** The date of the driver loaded for the device. +- **DriverVerVersion** The version of the driver loaded for the device. +- **Enumerator** The bus that enumerated the device. +- **HWID** List of hardware ids for the device. +- **Inf** INF file name (the name could be renamed by OS, such as oemXX.inf) +- **InstallState** Device installation state. +- **InventoryVersion** The version of the inventory binary generating the events. +- **LowerClassFilters** Lower filter class drivers IDs installed for the device. +- **LowerFilters** Lower filter drivers IDs installed for the device. +- **Manufacturer** The device manufacturer. +- **MatchingID** Represents the hardware ID or compatible ID that Windows uses to install a device instance. +- **Model** The device model. +- **ParentId** Device instance id of the parent of the device. +- **ProblemCode** The current error code for the device. +- **Provider** The device provider. +- **Service** The device service name +- **STACKID** The device service name. +- **UpperClassFilters** The list of hardware ids for the stack +- **UpperFilters** Upper filter drivers IDs installed for the device + + +### Microsoft.Windows.Inventory.Core.InventoryDevicePnpRemove + +This event indicates that the InventoryDevicePnpRemove object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDevicePnpStartSync + +This event indicates that a new set of InventoryDevicePnpAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. ### Microsoft.Windows.Inventory.Core.InventoryDeviceUsbHubClassAdd -This event sends basic metadata about the USB hubs on the device +This event sends basic metadata about the USB hubs on the device. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **InventoryVersion** The version of the inventory file generating the events -- **TotalUserConnectablePorts** Total number of connectable USB ports -- **TotalUserConnectableTypeCPorts** Total number of connectable USB Type C ports +- **InventoryVersion** The version of the inventory file generating the events. +- **TotalUserConnectablePorts** Total number of connectable USB ports. +- **TotalUserConnectableTypeCPorts** Total number of connectable USB Type C ports. -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBARuleViolationsAdd +### Microsoft.Windows.Inventory.Core.InventoryDeviceUsbHubClassStartSync -This event provides data on Microsoft Office VBA rule violations, including a rollup count per violation type, giving an indication of remediation requirements for an organization. The event identifier is a unique GUID, associated with the validation rule +This event indicates that a new set of InventoryDeviceUsbHubClassAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **Count** Count of total Microsoft Office VBA rule violations +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDriverBinaryAdd + +This event provides the basic metadata about driver binaries running on the system. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **DriverCheckSum** The checksum of the driver file. +- **DriverCompany** The company name that developed the driver. +- **DriverInBox** Is the driver included with the operating system? +- **DriverIsKernelMode** Is it a kernel mode driver? +- **DriverName** The file name of the driver. +- **DriverPackageStrongName** The strong name of the driver package +- **DriverSigned** The strong name of the driver package +- **DriverTimeStamp** The low 32 bits of the time stamp of the driver file. +- **DriverType** A bitfield of driver attributes: 1. define DRIVER_MAP_DRIVER_TYPE_PRINTER 0x0001. 2. define DRIVER_MAP_DRIVER_TYPE_KERNEL 0x0002. 3. define DRIVER_MAP_DRIVER_TYPE_USER 0x0004. 4. define DRIVER_MAP_DRIVER_IS_SIGNED 0x0008. 5. define DRIVER_MAP_DRIVER_IS_INBOX 0x0010. 6. define DRIVER_MAP_DRIVER_IS_WINQUAL 0x0040. 7. define DRIVER_MAP_DRIVER_IS_SELF_SIGNED 0x0020. 8. define DRIVER_MAP_DRIVER_IS_CI_SIGNED 0x0080. 9. define DRIVER_MAP_DRIVER_HAS_BOOT_SERVICE 0x0100. 10. define DRIVER_MAP_DRIVER_TYPE_I386 0x10000. 11. define DRIVER_MAP_DRIVER_TYPE_IA64 0x20000. 12. define DRIVER_MAP_DRIVER_TYPE_AMD64 0x40000. 13. define DRIVER_MAP_DRIVER_TYPE_ARM 0x100000. 14. define DRIVER_MAP_DRIVER_TYPE_THUMB 0x200000. 15. define DRIVER_MAP_DRIVER_TYPE_ARMNT 0x400000. 16. define DRIVER_MAP_DRIVER_IS_TIME_STAMPED 0x800000. +- **DriverVersion** The version of the driver file. +- **ImageSize** The size of the driver file. +- **Inf** The name of the INF file. +- **InventoryVersion** The version of the inventory file generating the events. +- **Product** The product name that is included in the driver file. +- **ProductVersion** The product version that is included in the driver file. +- **Service** The name of the service that is installed for the device. +- **WdfVersion** The Windows Driver Framework version. + + +### Microsoft.Windows.Inventory.Core.InventoryDriverBinaryRemove + +This event indicates that the InventoryDriverBinary object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDriverBinaryStartSync + +This event indicates that a new set of InventoryDriverBinaryAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDriverPackageAdd + +This event sends basic metadata about drive packages installed on the system to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **Class** The class name for the device driver. +- **ClassGuid** The class GUID for the device driver. +- **Date** The driver package date. +- **Directory** The path to the driver package. +- **DriverInBox** Is the driver included with the operating system? +- **Inf** The INF name of the driver package. +- **InventoryVersion** The version of the inventory file generating the events. +- **Provider** The provider for the driver package. +- **SubmissionId** The HLK submission ID for the driver package. +- **Version** The version of the driver package. + + +### Microsoft.Windows.Inventory.Core.InventoryDriverPackageRemove + +This event indicates that the InventoryDriverPackageRemove object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + + +### Microsoft.Windows.Inventory.Core.InventoryDriverPackageStartSync + +This event indicates that a new set of InventoryDriverPackageAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory file generating the events. + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeAddInAdd -This event provides data on the installed Office Add-ins. +Invalid variant - Provides data on the installed Office Add-ins + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AddinCLSID** The CLSID for the Office addin +- **AddInCLSID** The CLSID for the Add-in +- **AddInId** Add-In identifier +- **AddinType** The type of the Office addin. +- **BinFileTimestamp** Timestamp of the Office addin +- **BinFileVersion** Version of the Office addin +- **Description** Add-in description +- **FileId** FileId of the Office addin +- **FileSize** File size of the Office addin +- **FriendlyName** Add-in friendly name +- **FullPath** Full path to the add-in module +- **LoadBehavior** The load behavior +- **LoadTime** The load time for the add-in +- **OfficeApplication** The Microsoft Office application associated with the add-in +- **OfficeArchitecture** Architecture of the addin +- **OfficeVersion** The Microsoft Office version installed +- **OutlookCrashingAddin** Whether the Outlook addin is crashing +- **ProductCompany** The name of the company associated with the Office addin +- **ProductName** The product name associated with the Office addin +- **ProductVersion** The version associated with the Office addin +- **ProgramId** The unique program identifier of the Office addin +- **Provider** Name of the provider for this addin +- **Usage** Data regarding usage of the add-in. -- **AddInCLSID** The CLSID key office for the Office addin. -- **AddInId** The identifier of the Office addin. -- **AddinType** The type of the Office addin. -- **BinFileTimestamp** The timestamp of the Office addin. -- **BinFileVersion** The version of the Office addin. -- **Description** The description of the Office addin. -- **FileId** The file ID of the Office addin. -- **FriendlyName** The friendly name of the Office addin. -- **FullPath** The full path to the Office addin. -- **LoadBehavior** A Uint32 that describes the load behavior. -- **LoadTime** The load time for the Office addin. -- **OfficeApplication** The OIffice application for this addin. -- **OfficeArchitecture** The architecture of the addin. -- **OfficeVersion** The Office version for this addin. -- **OutlookCrashingAddin** A boolean value that indicates if crashes have been found for this addin. -- **ProductCompany** The name of the company associated with the Office addin. -- **ProductName** The product name associated with the Office addin. -- **ProductVersion** The version associated with the Office addin. -- **ProgramId** The unique program identifier of the Office addin. -- **Provider** The provider name for this addin. ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeAddInRemove This event indicates that the particular data object represented by the objectInstanceId is no longer present. -There are no fields in this event. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeAddInStartSync + +This event indicates that a new sync is being generated for this object type. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIdentifiersAdd + +This event provides data on the Office identifiers + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **OAudienceData** Sub-identifier for Microsoft Office release management, identifying the pilot group for a device +- **OAudienceId** Microsoft Office identifier for Microsoft Office release management, identifying the pilot group for a device +- **OMID** Identifier for the Office SQM Machine +- **OPlatform** Whether the installed Microsoft Office product is 32-bit or 64-bit +- **OTenantId** Unique GUID representing the Microsoft O365 Tenant +- **OVersion** Installed version of Microsoft Office. For example, 16.0.8602.1000 +- **OWowMID** Legacy Microsoft Office telemetry identifier (SQM Machine ID) for WoW systems (32-bit Microsoft Office on 64-bit Windows) + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIdentifiersStartSync + +Diagnostic event to indicate a new sync is being generated for this object type + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIESettingsAdd + +This event includes the Office-related Internet Explorer features + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **OIeFeatureAddon** Flag indicating which Microsoft Office products have this setting enabled. The FEATURE_ADDON_MANAGEMENT feature lets applications hosting the WebBrowser Control to respect add-on management selections made using the Add-on Manager feature of Internet Explorer. Add-ons disabled by the user or by administrative group policy will also be disabled in applications that enable this feature. +- **OIeMachineLockdown** Flag indicating which Microsoft Office products have this setting enabled. When the FEATURE_LOCALMACHINE_LOCKDOWN feature is enabled, Internet Explorer applies security restrictions on content loaded from the user's local machine, which helps prevent malicious behavior involving local files. +- **OIeMimeHandling** Flag indicating which Microsoft Office products have this setting enabled. When the FEATURE_MIME_HANDLING feature control is enabled, Internet Explorer handles MIME types more securely. Only applies to Windows Internet Explorer 6 for Windows XP Service Pack 2 (SP2) +- **OIeMimeSniffing** Flag indicating which Microsoft Office products have this setting enabled. Determines a file's type by examining its bit signature. Windows Internet Explorer uses this information to determine how to render the file. The FEATURE_MIME_SNIFFING feature, when enabled, allows to be set differently for each security zone by using the URLACTION_FEATURE_MIME_SNIFFING URL action flag +- **OIeNoAxInstall** Flag indicating which Microsoft Office products have this setting enabled. When a webpage attempts to load or install an ActiveX control that isn't already installed, the FEATURE_RESTRICT_ACTIVEXINSTALL feature blocks the request. When a webpage tries to load or install an ActiveX control that isn't already installed, the FEATURE_RESTRICT_ACTIVEXINSTALL feature blocks the request +- **OIeNoDownload** Flag indicating which Microsoft Office products have this setting enabled. The FEATURE_RESTRICT_FILEDOWNLOAD feature blocks file download requests that navigate to a resource, that display a file download dialog box, or that are not initiated explicitly by a user action (for example, a mouse click or key press). Only applies to Windows Internet Explorer 6 for Windows XP Service Pack 2 (SP2) +- **OIeObjectCaching** Flag indicating which Microsoft Office products have this setting enabled. When enabled, the FEATURE_OBJECT_CACHING feature prevents webpages from accessing or instantiating ActiveX controls cached from different domains or security contexts +- **OIePasswordDisable** Flag indicating which Microsoft Office products have this setting enabled. After Windows Internet Explorer 6 for Windows XP Service Pack 2 (SP2), Internet Explorer no longer allows usernames and passwords to be specified in URLs that use the HTTP or HTTPS protocols. URLs using other protocols, such as FTP, still allow usernames and passwords +- **OIeSafeBind** Flag indicating which Microsoft Office products have this setting enabled. The FEATURE_SAFE_BINDTOOBJECT feature performs additional safety checks when calling MonikerBindToObject to create and initialize Microsoft ActiveX controls. Specifically, prevent the control from being created if COMPAT_EVIL_DONT_LOAD is in the registry for the control +- **OIeSecurityBand** Flag indicating which Microsoft Office products have this setting enabled. The FEATURE_SECURITYBAND feature controls the display of the Internet Explorer Information bar. When enabled, the Information bar appears when file download or code installation is restricted +- **OIeUncSaveCheck** Flag indicating which Microsoft Office products have this setting enabled. The FEATURE_UNC_SAVEDFILECHECK feature enables the Mark of the Web (MOTW) for local files loaded from network locations that have been shared by using the Universal Naming Convention (UNC) +- **OIeValidateUrl** Flag indicating which Microsoft Office products have this setting enabled. When enabled, the FEATURE_VALIDATE_NAVIGATE_URL feature control prevents Windows Internet Explorer from navigating to a badly formed URL +- **OIeWebOcPopup** Flag indicating which Microsoft Office products have this setting enabled. The FEATURE_WEBOC_POPUPMANAGEMENT feature allows applications hosting the WebBrowser Control to receive the default Internet Explorer pop-up window management behavior +- **OIeWinRestrict** Flag indicating which Microsoft Office products have this setting enabled. When enabled, the FEATURE_WINDOW_RESTRICTIONS feature adds several restrictions to the size and behavior of popup windows +- **OIeZoneElevate** Flag indicating which Microsoft Office products have this setting enabled. When enabled, the FEATURE_ZONE_ELEVATION feature prevents pages in one zone from navigating to pages in a higher security zone unless the navigation is generated by the user + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIESettingsStartSync + +Diagnostic event to indicate a new sync is being generated for this object type + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeInsightsAdd -This event provides insight data on the installed Office products. +Provides insight data on the installed Office products + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **OfficeApplication** The name of the Office application. -- **OfficeArchitecture** The bitness of the Office application. -- **OfficeVersion** The version of the Office application. -- **Value** The insights collected about this entity. +- **OfficeApplication** The name of the Office application. +- **OfficeArchitecture** The bitness of the Office application. +- **OfficeVersion** The version of the Office application. +- **Value** The insights collected about this entity. + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeInsightsRemove This event indicates that the particular data object represented by the objectInstanceId is no longer present. -There are no fields in this event. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeInsightsStartSync -This diagnostic event indicates that a new sync is being generated for this object type. +Diagnostic event to indicate a new sync is being generated for this object type + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeProductsAdd + +This event list all installed Office products + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **OC2rApps** A GUID the describes the Office Click-To-Run apps +- **OC2rSkus** Comma-delimited list (CSV) of Office Click-To-Run products installed on the device. For example, Office 2016 ProPlus +- **OMsiApps** Comma-delimited list (CSV) of Office MSI products installed on the device. For example, Microsoft Word +- **OProductCodes** A GUID that describes the Office MSI products + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeProductsStartSync + +Diagnostic event to indicate a new sync is being generated for this object type + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). -There are no fields in this event. ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeSettingsAdd -This event describes various Office settings. +This event describes various Office settings + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **BrowserFlags** Browser flags for Office-related products. -- **ExchangeProviderFlags** Provider policies for Office Exchange. -- **SharedComputerLicensing** Office shared computer licensing policies. +- **BrowserFlags** Browser flags for Office-related products +- **ExchangeProviderFlags** Office Exchange provider policies +- **SharedComputerLicensing** Office Shared Computer Licensing policies + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeSettingsStartSync -Diagnostic event to indicate a new sync is being generated for this object type. +Diagnostic event to indicate a new sync is being generated for this object type + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + -There are no fields in this event. ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBAAdd This event provides a summary rollup count of conditions encountered while performing a local scan of Office files, analyzing for known VBA programmability compatibility issues between legacy office version and ProPlus, and between 32 and 64-bit versions +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **Design** Count of files with design issues found @@ -2125,43 +2566,74 @@ The following fields are available: This event indicates that the particular data object represented by the objectInstanceId is no longer present. -There are no fields in this event. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBARuleViolationsAdd + +This event provides data on Microsoft Office VBA rule violations, including a rollup count per violation type, giving an indication of remediation requirements for an organization. The event identifier is a unique GUID, associated with the validation rule + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **Count** Count of total Microsoft Office VBA rule violations + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBARuleViolationsRemove This event indicates that the particular data object represented by the objectInstanceId is no longer present. -There are no fields in this event. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). -### Microsoft.Windows.Inventory.Core.InventoryApplicationFrameworkStartSync -This event indicates that a new set of InventoryApplicationFrameworkAdd events will be sent + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBARuleViolationsStartSync + +This event indicates that a new sync is being generated for this object type. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBAStartSync + +Diagnostic event to indicate a new sync is being generated for this object type + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousUUPInfoAdd + +Provides data on Unified Update Platform (UUP) products and what version they are at. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **InventoryVersion** The version of the inventory file generating the events +- **Identifier** UUP identifier +- **LastActivatedVersion** Last activated version +- **PreviousVersion** Previous version +- **Source** UUP source +- **Version** UUP version -### Microsoft.Windows.Inventory.Core.InventoryApplicationFrameworkAdd +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousUUPInfoRemove -This event provides the basic metadata about the frameworks an application may depend on +Indicates that this particular data object represented by the objectInstanceId is no longer present. -The following fields are available: - -- **FileId** A hash that uniquely identifies a file -- **Frameworks** The list of frameworks this file depends on -- **InventoryVersion** The version of the inventory file generating the events -- **ProgramId** A hash of the Name, Version, Publisher, and Language of an application used to identify it +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). -### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicatorAdd -These events represent the basic metadata about the OS indicators installed on the system which are used for keeping the device up-to-date. +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousUUPInfoStartSync -The following fields are available: +Diagnostic event to indicate a new sync is being generated for this object type + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). -- **IndicatorValue** The indicator value -- **Value** Describes an operating system indicator that may be relevant for the device upgrade. ### Microsoft.Windows.Inventory.Indicators.Checksum @@ -2174,627 +2646,147 @@ The following fields are available: - **PCFP** Equivalent to the InventoryId field that is found in other core events. -### Microsoft.Windows.Inventory.Core.InventoryApplicationAdd +### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicatorAdd -This event sends basic metadata about an application on the system to help keep Windows up to date. +These events represent the basic metadata about the OS indicators installed on the system which are used for keeping the device up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **HiddenArp** Indicates whether a program hides itself from showing up in ARP. -- **InstallDate** The date the application was installed (a best guess based on folder creation date heuristics). -- **InstallDateArpLastModified** The date of the registry ARP key for a given application. Hints at install date but not always accurate. Passed as an array. Example: 4/11/2015 00:00:00 -- **InstallDateFromLinkFile** The estimated date of install based on the links to the files. Passed as an array. -- **InstallDateMsi** The install date if the application was installed via MSI. Passed as an array. -- **InventoryVersion** The version of the inventory file generating the events. -- **Language** The language code of the program. -- **MsiPackageCode** A GUID that describes the MSI Package. Multiple 'Products' (apps) can make up an MsiPackage. -- **MsiProductCode** A GUID that describe the MSI Product. -- **Name** The name of the application -- **OSVersionAtInstallTime** The four octets from the OS version at the time of the application's install. -- **PackageFullName** The package full name for a Store application. -- **ProgramInstanceId** A hash of the file IDs in an app. -- **Publisher** The Publisher of the application. Location pulled from depends on the 'Source' field. -- **RootDirPath** The path to the root directory where the program was installed. -- **Source** How the program was installed (ARP, MSI, Appx, etc...) -- **StoreAppType** A sub-classification for the type of Microsoft Store app, such as UWP or Win8StoreApp. -- **Type** "One of (""Application"", ""Hotfix"", ""BOE"", ""Service"", ""Unknown""). Application indicates Win32 or Appx app, Hotfix indicates app updates (KBs), BOE indicates it's an app with no ARP or MSI entry, Service indicates that it is a service. Application and BOE are the ones most likely seen." -- **Version** The version number of the program. +- **IndicatorValue** The indicator value. -### Microsoft.Windows.Inventory.Core.InventoryApplicationRemove - -This event indicates that a new set of InventoryDevicePnpAdd events will be sent. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryApplicationStartSync - -This event indicates that a new set of InventoryApplicationAdd events will be sent. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDeviceContainerRemove - -This event indicates that the InventoryDeviceContainer object is no longer present. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDriverPackageAdd - -This event sends basic metadata about drive packages installed on the system to help keep Windows up-to-date. - -The following fields are available: - -- **Class** The class name for the device driver. -- **ClassGuid** The class GUID for the device driver. -- **Date** The driver package date. -- **Directory** The path to the driver package. -- **DriverInBox** Is the driver included with the operating system? -- **Inf** The INF name of the driver package. -- **InventoryVersion** The version of the inventory file generating the events. -- **Provider** The provider for the driver package. -- **SubmissionId** The HLK submission ID for the driver package. -- **Version** The version of the driver package. - - -### Microsoft.Windows.Inventory.Core.InventoryDriverBinaryStartSync - -This event indicates that a new set of InventoryDriverBinaryAdd events will be sent. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDriverBinaryRemove - -This event indicates that the InventoryDriverBinary object is no longer present. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDriverPackageRemove - -This event indicates that the InventoryDriverPackageRemove object is no longer present. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDevicePnpRemove - -This event indicates that the InventoryDevicePnpRemove object is no longer present. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDeviceContainerAdd - -This event sends basic metadata about a device container (such as a monitor or printer as opposed to a PNP device) to help keep Windows up-to-date. - -The following fields are available: - -- **Categories** A comma separated list of functional categories in which the container belongs. -- **DiscoveryMethod** The discovery method for the device container. -- **FriendlyName** The name of the device container. -- **InventoryVersion** The version of the inventory file generating the events. -- **IsActive** Is the device connected, or has it been seen in the last 14 days? -- **IsConnected** For a physically attached device, this value is the same as IsPresent. For wireless a device, this value represents a communication link. -- **IsMachineContainer** Is the container the root device itself? -- **IsNetworked** Is this a networked device? -- **IsPaired** Does the device container require pairing? -- **Manufacturer** The manufacturer name for the device container. -- **ModelId** A model GUID. -- **ModelName** The model name. -- **ModelNumber** The model number for the device container. -- **PrimaryCategory** The primary category for the device container. - - -### Microsoft.Windows.Inventory.Core.InventoryDeviceContainerStartSync - -This event indicates that a new set of InventoryDeviceContainerAdd events will be sent. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDeviceMediaClassStartSync - -This event indicates that a new set of InventoryDeviceMediaClassSAdd events will be sent. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDriverPackageStartSync - -This event indicates that a new set of InventoryDriverPackageAdd events will be sent. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDeviceMediaClassRemove - -This event indicates that the InventoryDeviceMediaClassRemove object is no longer present. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDevicePnpStartSync - -This event indicates that a new set of InventoryDevicePnpAdd events will be sent. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDeviceMediaClassAdd - -This event sends additional metadata about a PNP device that is specific to a particular class of devices to help keep Windows up to date while reducing overall size of data payload. - -The following fields are available: - -- **Audio_CaptureDriver** The Audio device capture driver endpoint. -- **Audio_RenderDriver** The Audio device render driver endpoint. -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDevicePnpAdd - -This event represents the basic metadata about a PNP device and its associated driver - -The following fields are available: - -- **class** The device setup class of the driver loaded for the device -- **classGuid** The device class GUID from the driver package -- **COMPID** A JSON array the provides the value and order of the compatible ID tree for the device. -- **ContainerId** A system-supplied GUID that uniquely groups the functional devices associated with a single-function or multifunction device installed in the device. -- **description** The device description -- **deviceState** DeviceState is a bitmask of the following: DEVICE_IS_CONNECTED 0x0001 (currently only for container). DEVICE_IS_NETWORK_DEVICE 0x0002 (currently only for container). DEVICE_IS_PAIRED 0x0004 (currently only for container). DEVICE_IS_ACTIVE 0x0008 (currently never set). DEVICE_IS_MACHINE 0x0010 (currently only for container). DEVICE_IS_PRESENT 0x0020 (currently always set). DEVICE_IS_HIDDEN 0x0040. DEVICE_IS_PRINTER 0x0080 (currently only for container). DEVICE_IS_WIRELESS 0x0100. DEVICE_IS_WIRELESS_FAT 0x0200. The most common values are therefore: 32 (0x20)= device is present. 96 (0x60)= device is present but hidden. 288 (0x120)= device is a wireless device that is present -- **DriverId** A unique identifier for the installed device. -- **DriverName** The name of the driver image file. -- **driverPackageStrongName** The immediate parent directory name in the Directory field of InventoryDriverPackage. -- **driverVerDate** The date of the driver loaded for the device -- **driverVerVersion** The version of the driver loaded for the device -- **enumerator** The bus that enumerated the device -- **HWID** A JSON array that provides the value and order of the HWID tree for the device. -- **Inf** The INF file name. -- **installState** The device installation state. One of these values: https://msdn.microsoft.com/library/windows/hardware/ff543130.aspx -- **InventoryVersion** The version of the inventory file generating the events. -- **lowerClassFilters** Lower filter class drivers IDs installed for the device. -- **lowerFilters** Lower filter drivers IDs installed for the device -- **manufacturer** The device manufacturer -- **matchingID** Represents the hardware ID or compatible ID that Windows uses to install a device instance -- **model** The device model -- **parentId** Device instance id of the parent of the device -- **ProblemCode** The current error code for the device. -- **provider** The device provider -- **service** The device service name#N##N##N##N##N# -- **STACKID** A JSON array that provides the value and order of the STACKID tree for the device. -- **upperClassFilters** Upper filter class drivers IDs installed for the device -- **upperFilters** Upper filter drivers IDs installed for the device - - -### Microsoft.Windows.Inventory.Core.InventoryDriverBinaryAdd - -This event provides the basic metadata about driver binaries running on the system - -The following fields are available: - -- **DriverCheckSum** The checksum of the driver file. -- **DriverCompany** The company name that developed the driver. -- **driverInBox** Is the driver included with the operating system? -- **driverIsKernelMode** Is it a kernel mode driver? -- **DriverName** The file name of the driver. -- **driverPackageStrongName** The strong name of the driver package -- **driverSigned** The strong name of the driver package -- **DriverTimeStamp** The low 32 bits of the time stamp of the driver file. -- **DriverType** A bitfield of driver attributes: 1. define DRIVER_MAP_DRIVER_TYPE_PRINTER 0x0001. 2. define DRIVER_MAP_DRIVER_TYPE_KERNEL 0x0002. 3. define DRIVER_MAP_DRIVER_TYPE_USER 0x0004. 4. define DRIVER_MAP_DRIVER_IS_SIGNED 0x0008. 5. define DRIVER_MAP_DRIVER_IS_INBOX 0x0010. 6. define DRIVER_MAP_DRIVER_IS_WINQUAL 0x0040. 7. define DRIVER_MAP_DRIVER_IS_SELF_SIGNED 0x0020. 8. define DRIVER_MAP_DRIVER_IS_CI_SIGNED 0x0080. 9. define DRIVER_MAP_DRIVER_HAS_BOOT_SERVICE 0x0100. 10. define DRIVER_MAP_DRIVER_TYPE_I386 0x10000. 11. define DRIVER_MAP_DRIVER_TYPE_IA64 0x20000. 12. define DRIVER_MAP_DRIVER_TYPE_AMD64 0x40000. 13. define DRIVER_MAP_DRIVER_TYPE_ARM 0x100000. 14. define DRIVER_MAP_DRIVER_TYPE_THUMB 0x200000. 15. define DRIVER_MAP_DRIVER_TYPE_ARMNT 0x400000. 16. define DRIVER_MAP_DRIVER_IS_TIME_STAMPED 0x800000. -- **DriverVersion** The version of the driver file. -- **ImageSize** The size of the driver file. -- **Inf** The name of the INF file. -- **InventoryVersion** The version of the inventory file generating the events. -- **Product** The product name that is included in the driver file. -- **ProductVersion** The product version that is included in the driver file. -- **service** The device service name -- **WdfVersion** The Windows Driver Framework version. - - -### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicator - -This event sends value data about the markers on custom devices, to help keep Windows up to date. The formal name for markers is UEX Indicators. See marker list for definitions. - -The following fields are available: - -- **IndicatorValue** Value of the marker/indicator -- **Key** Name of the marker/indicator - - -### Microsoft.Windows.Inventory.Core.AmiTelCacheVersions - -This event sends inventory component versions for the Device Inventory data. - -The following fields are available: - -- **aeinv** The version of the App inventory component. -- **devinv** The file version of the Device inventory component. - - -### Microsoft.Windows.Inventory.Core.AmiTelCacheChecksum - -This event captures basic checksum data about the device inventory items stored in the cache for use in validating data completeness for Microsoft.Windows.Inventory.Core events. The fields in this event may change over time, but they will always represent a count of a given object. - -The following fields are available: - -- **Device** A count of device objects in cache -- **DeviceCensus** A count of devicecensus objects in cache -- **DriverPackageExtended** A count of driverpackageextended objects in cache -- **File** A count of file objects in cache -- **FileSigningInfo** A count of file signing info objects in cache. -- **Generic** A count of generic objects in cache -- **HwItem** A count of hwitem objects in cache -- **InventoryApplication** A count of application objects in cache -- **InventoryApplicationFile** A count of application file objects in cache -- **InventoryDeviceContainer** A count of device container objects in cache -- **InventoryDeviceInterface** A count of inventory device interface objects in cache. -- **InventoryDeviceMediaClass** A count of device media objects in cache -- **InventoryDevicePnp** A count of devicepnp objects in cache -- **InventoryDriverBinary** A count of driver binary objects in cache -- **InventoryDriverPackage** A count of device objects in cache -- **Metadata** A count of metadata objects in cache -- **Orphan** A count of orphan file objects in cache -- **Programs** A count of program objects in cache - - -### Microsoft.Windows.Inventory.Core.InventoryDeviceInterfaceStartSync - -This event indicates that a new set of InventoryDeviceInterfaceAdd events will be sent. - -The following fields are available: - -- **InventoryVersion** The version of the inventory file generating the events. - - -### Microsoft.Windows.Inventory.Core.InventoryDeviceInterfaceAdd - -This event retrieves information about what sensor interfaces are available on the device. - -The following fields are available: - -- **Accelerometer3D** Indicates if an Accelerator3D sensor is found. -- **ActivityDetection** Indicates if an Activity Detection sensor is found. -- **AmbientLight** Indicates if an Ambient Light sensor is found. -- **Barometer** Indicates if a Barometer sensor is found. -- **Custom** Indicates if a Custom sensor is found. -- **EnergyMeter** Indicates if an Energy sensor is found. -- **FloorElevation** Indicates if a Floor Elevation sensor is found. -- **GeomagneticOrientation** Indicates if a Geo Magnetic Orientation sensor is found. -- **GravityVector** Indicates if a Gravity Detector sensor is found. -- **Gyrometer3D** Indicates if a Gyrometer3D sensor is found. -- **Humidity** Indicates if a Humidity sensor is found. -- **InventoryVersion** The version of the inventory file generating the events. -- **LinearAccelerometer** Indicates if a Linear Accelerometer sensor is found. -- **Magnetometer3D** Indicates if a Magnetometer3D sensor is found. -- **Orientation** Indicates if an Orientation sensor is found. -- **Pedometer** Indicates if a Pedometer sensor is found. -- **Proximity** Indicates if a Proximity sensor is found. -- **RelativeOrientation** Indicates if a Relative Orientation sensor is found. -- **SimpleDeviceOrientation** Indicates if a Simple Device Orientation sensor is found. -- **Temperature** Indicates if a Temperature sensor is found. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeAddInStartSync - -This event indicates that a new sync is being generated for this object type. - -There are no fields in this event. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIdentifiersAdd - -This event provides data on the installed Office identifiers. - -- **OAudienceData** The Office Audience descriptor. -- **OAudienceId** The Office Audience ID. -- **OMID** The Office machine ID. -- **OPlatform** The Office architecture. -- **OVersion** The Office version -- **OTenantId** The Office 365 Tenant GUID. -- **OWowMID** The Office machine ID. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIdentifiersStartSync - -This event indicates that a new sync is being generated for this object type. - -There are no fields in this event. - - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIESettingsAdd - -This event provides data on the installed Office-related Internet Explorer features. - -- **OIeFeatureAddon** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeMachineLockdown** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeMimeHandling** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeMimeSniffing** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeNoAxInstall** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeNoDownload** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeObjectCaching** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIePasswordDisable** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeSafeBind** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeSecurityBand** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeUncSaveCheck** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeValidateUrl** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeWebOcPopup** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeWinRestrict** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). -- **OIeZoneElevate** For more information, see the Office-related [Internet Feature Control Keys](https://msdn.microsoft.com/library/ee330720.aspx). - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIESettingsStartSync - -This event indicates that a new sync is being generated for this object type. - -There are no fields in this event. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeProductsAdd - -This event describes the Office products that are installed. - -- **OC2rApps** The Office Click-to-Run apps. -- **OC2rSkus** The Office Click-to-Run products. -- **OMsiApps** The Office MSI apps. -- **OProductCodes** The Office MSI product code. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeProductsStartSync - -This event indicates that a new sync is being generated for this object type. - -There are no fields in this event. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBARuleViolationsStartSync - -This event indicates that a new sync is being generated for this object type. - -There are no fields in this event. - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBAStartSync - -This event indicates that a new sync is being generated for this object type. - -There are no fields in this event. - -### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicatorRemove - -This event is a counterpart to InventoryMiscellaneousUexIndicatorAdd that indicates that the item has been removed. - -There are no fields in this event. - ### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicatorStartSync This event indicates that a new set of InventoryMiscellaneousUexIndicatorAdd events will be sent. -There are no fields in this event. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). -## OneDrive events -### Microsoft.OneDrive.Sync.Updater.OfficeRegistration -This event determines the status of the OneDrive integration with Microsoft Office. +## Kernel events + +### IO + +This event indicates the number of bytes read from or read by the OS and written to or written by the OS upon system startup. The following fields are available: -- **isValid** Is the Microsoft Office registration valid? +- **BytesRead** The total number of bytes read from or read by the OS upon system startup. +- **BytesWritten** The total number of bytes written to or written by the OS upon system startup. -### Microsoft.OneDrive.Sync.Updater.UpdateTierReg +### Microsoft.Windows.Kernel.BootEnvironment.OsLaunch -This event determines status of the update tier registry values. +OS information collected during Boot, used to evaluate the success of the upgrade process. The following fields are available: -- **regReadEnterpriseHr** The HResult of the enterprise reg read value. -- **regReadTeamHr** The HResult of the team reg read value. - - -### Microsoft.OneDrive.Sync.Updater.RepairResult - -The event determines the result of the installation repair. - -The following fields are available: - -- **hr** The HResult of the operation. - - -### Microsoft.OneDrive.Sync.Updater.UpdateXmlDownloadHResult - -This event determines the status when downloading the OneDrive update configuration file. - -The following fields are available: - -- **hr** The HResult of the operation. - - -### Microsoft.OneDrive.Sync.Updater.SetupBinaryDownloadHResult - -This event indicates the status when downloading the OneDrive setup file. - -The following fields are available: - -- **hr** The HResult of the operation. - - -### Microsoft.OneDrive.Sync.Updater.UpdateOverallResult - -This event determines the outcome of the operation. - -The following fields are available: - -- **hr** The HResult of the operation. -- **IsLoggingEnabled** Is logging enabled? -- **UpdaterVersion** The version of the updater. - - -### Microsoft.OneDrive.Sync.Updater.WebConnectionStatus - -This event determines the error code that was returned when verifying Internet connectivity. - -The following fields are available: - -- **winInetError** The HResult of the operation. - - -### Microsoft.OneDrive.Sync.Updater.OverlayIconStatus - -This event indicates if the OneDrive overlay icon is working correctly. 0 = healthy; 1 = can be fixed; 2 = broken - -The following fields are available: - -- **32bit** The status of the OneDrive overlay icon on a 32-bit operating system. -- **64bit** The status of the OneDrive overlay icon on a 64-bit operating system. -- **SixtyFourBit** The status of the OneDrive overlay icon on a 32-bit operating system. -- **ThirtyTwoBit** The status of the OneDrive overlay icon on a 64-bit operating system. - - -### Microsoft.OneDrive.Sync.Updater.ComponentInstallState - -This event determines the installation state of dependent OneDrive components. - -The following fields are available: - -- **ComponentName** The name of the dependent component. -- **isInstalled** Is the dependent component installed? - - -### Microsoft.OneDrive.Sync.Updater.CommonData - -This event contains basic OneDrive configuration data that helps to diagnose failures. - -The following fields are available: - -- **AppVersion** The version of the app. -- **BuildArch** Is the architecture x86 or x64? -- **Environment** Is the device on the production or int service? -- **IsMSFTInternal** Is this an internal Microsoft device? -- **MachineGuid** The CEIP machine ID. -- **Market** Which market is this in? -- **OfficeVersion** The version of Office that is installed. -- **OneDriveDeviceId** The OneDrive device ID. -- **OSDeviceName** Only if the device is internal to Microsoft, the device name. -- **OSUserName** Only if the device is internal to Microsoft, the user name. -- **UserGuid** A unique global user identifier. - - -### Microsoft.OneDrive.Sync.Setup.APIOperation - -This event includes basic data about install and uninstall OneDrive API operations. - -The following fields are available: - -- **APIName** The name of the API. -- **Duration** How long the operation took. -- **IsSuccess** Was the operation successful? -- **ResultCode** The result code. -- **ScenarioName** The name of the scenario. - - -### Microsoft.OneDrive.Sync.Setup.RegisterStandaloneUpdaterAPIOperation - -This event is related to registering or unregistering the OneDrive update task. - -The following fields are available: - -- **APIName** The name of the API. -- **IsSuccess** Was the operation successful? -- **RegisterNewTaskResult** The HResult of the RegisterNewTask operation. -- **ScenarioName** The name of the scenario. -- **UnregisterOldTaskResult** The HResult of the UnregisterOldTask operation. - - -### Microsoft.OneDrive.Sync.Setup.EndExperience - -This event includes a success or failure summary of the installation. - -The following fields are available: - -- **APIName** The name of the API. -- **HResult** Indicates the result code of the event -- **IsSuccess** Was the operation successful? -- **ScenarioName** The name of the scenario. - - -### Microsoft.OneDrive.Sync.Setup.OSUpgradeInstallationOperation - -This event is related to the OS version when the OS is upgraded with OneDrive installed. - -The following fields are available: - -- **CurrentOneDriveVersion** The current version of OneDrive. -- **CurrentOSBuildBranch** The current branch of the operating system. -- **CurrentOSBuildNumber** The current build number of the operating system. -- **CurrentOSVersion** The current version of the operating system. -- **HResult** The HResult of the operation. -- **SourceOSBuildBranch** The source branch of the operating system. -- **SourceOSBuildNumber** The source build number of the operating system. -- **SourceOSVersion** The source version of the operating system. - - -### Microsoft.OneDrive.Sync.Setup.SetupCommonData - -This event contains basic OneDrive configuration data that helps to diagnose failures. - -The following fields are available: - -- **AppVersion** The version of the app. -- **BuildArchitecture** Is the architecture x86 or x64? -- **Environment** Is the device on the production or int service? -- **MachineGuid** The CEIP machine ID. -- **Market** Which market is this in? -- **MSFTInternal** Is this an internal Microsoft device? -- **OfficeVersionString** The version of Office that is installed. -- **OSDeviceName** Only if the device is internal to Microsoft, the device name. -- **OSUserName** Only if the device is internal to Microsoft, the user name. -- **UserGuid** The CEIP user ID. +- **BootApplicationId** This field tells us what the OS Loader Application Identifier is. +- **BootAttemptCount** The number of consecutive times the boot manager has attempted to boot into this operating system. +- **BootSequence** The current Boot ID, used to correlate events related to a particular boot session. +- **BootStatusPolicy** Identifies the applicable Boot Status Policy. +- **BootType** Identifies the type of boot (e.g.: "Cold", "Hiber", "Resume"). +- **EventTimestamp** Seconds elapsed since an arbitrary time point. This can be used to identify the time difference in successive boot attempts being made. +- **FirmwareResetReasonEmbeddedController** Reason for system reset provided by firmware. +- **FirmwareResetReasonEmbeddedControllerAdditional** Additional information on system reset reason provided by firmware if needed. +- **FirmwareResetReasonPch** Reason for system reset provided by firmware. +- **FirmwareResetReasonPchAdditional** Additional information on system reset reason provided by firmware if needed. +- **FirmwareResetReasonSupplied** Flag indicating that a reason for system reset was provided by firmware. +- **IO** Amount of data written to and read from the disk by the OS Loader during boot. See [IO](#io). +- **LastBootSucceeded** Flag indicating whether the last boot was successful. +- **LastShutdownSucceeded** Flag indicating whether the last shutdown was successful. +- **MenuPolicy** Type of advanced options menu that should be shown to the user (Legacy, Standard, etc.). +- **RecoveryEnabled** Indicates whether recovery is enabled. +- **UserInputTime** The amount of time the loader application spent waiting for user input. ## Remediation events ->[!NOTE] ->Events from this provider are sent with the installation of KB4023057 and any subsequent Windows update. For details, see [this support article](https://support.microsoft.com/help/4023057). - ### Microsoft.Windows.Remediation.Applicable -Reports whether a specific remediation to issues preventing security and quality updates is applicable based on detection. +This event indicates a remedial plug-in is applicable if/when such a plug-in is detected. This is used to ensure Windows is up to date. The following fields are available: -- **CV** Correlation vector. -- **DetectedCondition** Boolean true if detect condition is true and perform action will be run. -- **GlobalEventCounter** Client side counter which indicates ordering of events sent by the remediation system. -- **PackageVersion** Current package version of Remediation. -- **PluginName** Name of the remediation plugin specified for each generic plugin event. -- **RemediationShellDeviceManaged** TRUE if the device is WSUS managed or Windows Updated is disabled. -- **RemediationShellDeviceNewOS** TRUE if the device has a recently installed OS. -- **RemediationShellDeviceSccm** TRUE if the device is SCCM managed. -- **RemediationShellDeviceZeroExhaust** TRUE if the device has opted out of Windows Updates completely. -- **Result** Result for detection or perform action phases of the remediation system. +- **ActionName** The name of the action to be taken by the plug-in. +- **AppraiserBinariesValidResult** Indicates whether plug-in was appraised as valid. +- **AppraiserDetectCondition** Indicates whether the plug-in passed the appraiser's check. +- **AppraiserRegistryValidResult** Indicates whether the registry entry checks out as valid. +- **AppraiserTaskDisabled** Indicates the appraiser task is disabled. +- **AppraiserTaskValidFailed** Indicates the Appraiser task did not function and requires intervention. +- **CV** Correlation vector +- **DateTimeDifference** The difference between local and reference clock times. +- **DateTimeSyncEnabled** Indicates whether the datetime sync plug-in is enabled. +- **DaysSinceLastSIH** The number of days since the most recent SIH executed. +- **DaysToNextSIH** The number of days until the next scheduled SIH execution. +- **DetectedCondition** Indicates whether detect condition is true and the perform action will be run. +- **EvalAndReportAppraiserBinariesFailed** Indicates the EvalAndReportAppraiserBinaries event failed. +- **EvalAndReportAppraiserRegEntries** Indicates the EvalAndReportAppraiserRegEntriesFailed event failed. +- **EvalAndReportAppraiserRegEntriesFailed** Indicates the EvalAndReportAppraiserRegEntriesFailed event failed. +- **GlobalEventCounter** Client side counter that indicates ordering of events sent by the remediation system. +- **HResult** The HRESULT for detection or perform action phases of the plugin. +- **IsAppraiserLatestResult** The HRESULT from the appraiser task. +- **IsConfigurationCorrected** Indicates whether the configuration of SIH task was successfully corrected. +- **LastHresult** The HRESULT for detection or perform action phases of the plugin. +- **LastRun** The date of the most recent SIH run. +- **NextRun** Date of the next scheduled SIH run. +- **PackageVersion** The version of the current remediation package. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Reload** True if SIH reload is required. +- **RemediationNoisyHammerAcLineStatus** Event that indicates the AC Line Status of the machine. +- **RemediationNoisyHammerAutoStartCount** The number of times hammer auto-started. +- **RemediationNoisyHammerCalendarTaskEnabled** Event that indicates Update Assistant Calendar Task is enabled. +- **RemediationNoisyHammerCalendarTaskExists** Event that indicates an Update Assistant Calendar Task exists. +- **RemediationNoisyHammerCalendarTaskTriggerEnabledCount** Event that indicates calendar triggers are enabled in the task. +- **RemediationNoisyHammerDaysSinceLastTaskRunTime** The number of days since the most recent hammer task ran. +- **RemediationNoisyHammerGetCurrentSize** Size in MB of the $GetCurrent folder. +- **RemediationNoisyHammerIsInstalled** TRUE if the noisy hammer is installed. +- **RemediationNoisyHammerLastTaskRunResult** The result of the last hammer task run. +- **RemediationNoisyHammerMeteredNetwork** TRUE if the machine is on a metered network. +- **RemediationNoisyHammerTaskEnabled** Indicates whether the Update Assistant Task (Noisy Hammer) is enabled. +- **RemediationNoisyHammerTaskExists** Indicates whether the Update Assistant Task (Noisy Hammer) exists. +- **RemediationNoisyHammerTaskTriggerEnabledCount** Indicates whether counting is enabled for the Update Assistant (Noisy Hammer) task trigger. +- **RemediationNoisyHammerUAExitCode** The exit code of the Update Assistant (Noisy Hammer) task. +- **RemediationNoisyHammerUAExitState** The code for the exit state of the Update Assistant (Noisy Hammer) task. +- **RemediationNoisyHammerUserLoggedIn** TRUE if there is a user logged in. +- **RemediationNoisyHammerUserLoggedInAdmin** TRUE if there is the user currently logged in is an Admin. +- **RemediationShellDeviceManaged** TRUE if the device is WSUS managed or Windows Updated disabled. +- **RemediationShellDeviceNewOS** TRUE if the device has a recently installed OS. +- **RemediationShellDeviceSccm** TRUE if the device is managed by SCCM (Microsoft System Center Configuration Manager). +- **RemediationShellDeviceZeroExhaust** TRUE if the device has opted out of Windows Updates completely. +- **RemediationTargetMachine** Indicates whether the device is a target of the specified fix. +- **RemediationTaskHealthAutochkProxy** True/False based on the health of the AutochkProxy task. +- **RemediationTaskHealthChkdskProactiveScan** True/False based on the health of the Check Disk task. +- **RemediationTaskHealthDiskCleanup_SilentCleanup** True/False based on the health of the Disk Cleanup task. +- **RemediationTaskHealthMaintenance_WinSAT** True/False based on the health of the Health Maintenance task. +- **RemediationTaskHealthServicing_ComponentCleanupTask** True/False based on the health of the Health Servicing Component task. +- **RemediationTaskHealthUSO_ScheduleScanTask** True/False based on the health of the USO (Update Session Orchestrator) Schedule task. +- **RemediationTaskHealthWindowsUpdate_ScheduledStartTask** True/False based on the health of the Windows Update Scheduled Start task. +- **RemediationTaskHealthWindowsUpdate_SihbootTask** True/False based on the health of the Sihboot task. +- **RemediationUHServiceBitsServiceEnabled** Indicates whether BITS service is enabled. +- **RemediationUHServiceDeviceInstallEnabled** Indicates whether Device Install service is enabled. +- **RemediationUHServiceDoSvcServiceEnabled** Indicates whether DO service is enabled. +- **RemediationUHServiceDsmsvcEnabled** Indicates whether DSMSVC service is enabled. +- **RemediationUHServiceLicensemanagerEnabled** Indicates whether License Manager service is enabled. +- **RemediationUHServiceMpssvcEnabled** Indicates whether MPSSVC service is enabled. +- **RemediationUHServiceTokenBrokerEnabled** Indicates whether Token Broker service is enabled. +- **RemediationUHServiceTrustedInstallerServiceEnabled** Indicates whether Trusted Installer service is enabled. +- **RemediationUHServiceUsoServiceEnabled** Indicates whether USO (Update Session Orchestrator) service is enabled. +- **RemediationUHServicew32timeServiceEnabled** Indicates whether W32 Time service is enabled. +- **RemediationUHServiceWecsvcEnabled** Indicates whether WECSVC service is enabled. +- **RemediationUHServiceWinmgmtEnabled** Indicates whether WMI service is enabled. +- **RemediationUHServiceWpnServiceEnabled** Indicates whether WPN service is enabled. +- **RemediationUHServiceWuauservServiceEnabled** Indicates whether WUAUSERV service is enabled. +- **Result** This is the HRESULT for Detection or Perform Action phases of the plugin. +- **RunAppraiserFailed** Indicates RunAppraiser failed to run correctly. +- **RunTask** TRUE if SIH task should be run by the plug-in. +- **TimeServiceNTPServer** The URL for the NTP time server used by device. +- **TimeServiceStartType** The startup type for the NTP time service. +- **TimeServiceSyncDomainJoined** True if device domain joined and hence uses DC for clock. +- **TimeServiceSyncType** Type of sync behavior for Date & Time service on device. + ### Microsoft.Windows.Remediation.ChangePowerProfileDetection @@ -2802,166 +2794,181 @@ Indicates whether the remediation system can put in a request to defer a system- The following fields are available: -- **ActionName** A descriptive name for the plugin action. -- **CurrentPowerPlanGUID** The ID of the current power plan configured on the device. -- **CV** Correlation vector. -- **GlobalEventCounter** Counter that indicates the ordering of events on the device. -- **PackageVersion** Current package version of remediation service. -- **RemediationBatteryPowerBatteryLevel** Integer between 0 and 100 indicating % battery power remaining (if not on battery, expect 0). -- **RemediationFUInProcess** Result that shows whether the device is currently installing a feature update. -- **RemediationScanInProcess** Result that shows whether the device is currently scanning for updates. -- **RemediationTargetMachine** Result that shows whether this device is a candidate for remediation(s) that will fix update issues. -- **SetupMutexAvailable** Result that shows whether setup mutex is available or not. -- **SysPowerStatusAC** Result that shows whether system is on AC power or not. +- **ActionName** A descriptive name for the plugin action +- **CurrentPowerPlanGUID** The ID of the current power plan configured on the device +- **CV** Correlation vector +- **GlobalEventCounter** Counter that indicates the ordering of events on the device +- **PackageVersion** Current package version of remediation service +- **RemediationBatteryPowerBatteryLevel** Integer between 0 and 100 indicating % battery power remaining (if not on battery, expect 0) +- **RemediationFUInProcess** Result that shows whether the device is currently installing a feature update +- **RemediationFURebootRequred** Indicates that a feature update reboot required was detected so the plugin will exit. +- **RemediationScanInProcess** Result that shows whether the device is currently scanning for updates +- **RemediationTargetMachine** Result that shows whether this device is a candidate for remediation(s) that will fix update issues +- **SetupMutexAvailable** Result that shows whether setup mutex is available or not +- **SysPowerStatusAC** Result that shows whether system is on AC power or not + ### Microsoft.Windows.Remediation.Completed -Enables tracking the completion of a process that remediates issues preventing security and quality updates. +This event enables completion tracking of a process that remediates issues preventing security and quality updates. The following fields are available: -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events sent by the remediation system. -- **PackageVersion** Current package version of Remediation. -- **PluginName** Name of the specific remediation for each generic plugin event. -- **RemediationNoisyHammerTaskKickOffIsSuccess** Event that indicates the Update Assistant task has been started successfully. -- **Result** Indicates whether the remediation has completed. +- **ActionName** Name of the action to be completed by the plug-in. +- **AppraiserTaskCreationFailed** TRUE if the appraiser task creation failed to complete successfully. +- **AppraiserTaskDeleteFailed** TRUE if deletion of appraiser task failed to complete successfully. +- **AppraiserTaskExistFailed** TRUE if detection of the appraiser task failed to complete successfully. +- **AppraiserTaskLoadXmlFailed** TRUE if the Appraiser XML Loader failed to complete successfully. +- **AppraiserTaskMissing** TRUE if the Appraiser task is missing. +- **AppraiserTaskTimeTriggerUpdateFailedId** TRUE if the Appraiser Task Time Trigger failed to update successfully. +- **AppraiserTaskValidateTaskXmlFailed** TRUE if the Appraiser Task XML failed to complete successfully. +- **branchReadinessLevel** Branch readiness level policy. +- **cloudControlState** Value indicating whether the shell is enabled on the cloud control settings. +- **CrossedDiskSpaceThreshold** Indicates if cleanup resulted in hard drive usage threshold required for feature update to be exceeded. +- **CV** The Correlation Vector. +- **DateTimeDifference** The difference between the local and reference clocks. +- **DaysSinceOsInstallation** The number of days since the installation of the Operating System. +- **DiskMbCleaned** The amount of space cleaned on the hard disk, measured in Megabytes. +- **DiskMbFreeAfterCleanup** The amount of free hard disk space after cleanup, measured in Megabytes. +- **DiskMbFreeBeforeCleanup** The amount of free hard disk space before cleanup, measured in Megabytes. +- **ForcedAppraiserTaskTriggered** TRUE if Appraiser task ran from the plug-in. +- **GlobalEventCounter** Client-side counter that indicates ordering of events sent by the active user. +- **HandlerCleanupFreeDiskInMegabytes** The amount of hard disk space cleaned by the storage sense handlers, measured in Megabytes. +- **hasRolledBack** Indicates whether the client machine has rolled back. +- **hasUninstalled** Indicates whether the client machine has uninstalled a later version of the OS. +- **hResult** The result of the event execution. +- **HResult** The result of the event execution. +- **installDate** The value of installDate registry key. Indicates the install date. +- **isNetworkMetered** Indicates whether the client machine has uninstalled a later version of the OS. +- **LatestState** The final state of the plug-in component. +- **MicrosoftCompatibilityAppraiser** The name of the component targeted by the Appraiser plug-in. +- **PackageVersion** The package version for the current Remediation. +- **PageFileCount** The number of Windows Page files. +- **PageFileCurrentSize** The size of the Windows Page file, measured in Megabytes. +- **PageFileLocation** The storage location (directory path) of the Windows Page file. +- **PageFilePeakSize** The maximum amount of hard disk space used by the Windows Page file, measured in Megabytes. +- **PluginName** The name of the plug-in specified for each generic plug-in event. +- **RanCleanup** TRUE if the plug-in ran disk cleanup. +- **RemediationBatteryPowerBatteryLevel** Indicates the battery level at which it is acceptable to continue operation. +- **RemediationBatteryPowerExitDueToLowBattery** True when we exit due to low battery power. +- **RemediationBatteryPowerOnBattery** True if we allow execution on battery. +- **RemediationConfigurationTroubleshooterExecuted** True/False based on whether the Remediation Configuration Troubleshooter executed successfully. +- **RemediationConfigurationTroubleshooterIpconfigFix** TRUE if IPConfig Fix completed successfully. +- **RemediationConfigurationTroubleshooterNetShFix** TRUE if network card cache reset ran successfully. +- **RemediationDiskCleanSizeBtWindowsFolderInMegabytes** The size of the Windows BT folder (used to store Windows upgrade files), measured in Megabytes. +- **RemediationDiskCleanupBTFolderEsdSizeInMB** The size of the Windows BT folder (used to store Windows upgrade files) ESD (Electronic Software Delivery), measured in Megabytes. +- **RemediationDiskCleanupGetCurrentEsdSizeInMB** The size of any existing ESD (Electronic Software Delivery) folder, measured in Megabytes. +- **RemediationDiskCleanupSearchFileSizeInMegabytes** The size of the Cleanup Search index file, measured in Megabytes. +- **RemediationDiskCleanupUpdateAssistantSizeInMB** The size of the Update Assistant folder, measured in Megabytes. +- **RemediationDoorstopChangeSucceeded** TRUE if Doorstop registry key was successfully modified. +- **RemediationDoorstopExists** TRUE if there is a One Settings Doorstop value. +- **RemediationDoorstopRegkeyError** TRUE if an error occurred accessing the Doorstop registry key. +- **RemediationDRFKeyDeleteSucceeded** TRUE if the RecoveredFrom (Doorstop) registry key was successfully deleted. +- **RemediationDUABuildNumber** The build number of the DUA. +- **RemediationDUAKeyDeleteSucceeded** TRUE if the UninstallActive registry key was successfully deleted. +- **RemediationDuplicateTokenSucceeded** TRUE if the user token was successfully duplicated. +- **remediationExecution** Remediation shell is in "applying remediation" state. +- **RemediationHibernationMigrated** TRUE if hibernation was migrated. +- **RemediationHibernationMigrationSucceeded** TRUE if hibernation migration succeeded. +- **RemediationImpersonateUserSucceeded** TRUE if the user was successfully impersonated. +- **RemediationNoisyHammerTaskKickOffIsSuccess** TRUE if the NoisyHammer task started successfully. +- **RemediationQueryTokenSucceeded** TRUE if the user token was successfully queried. +- **RemediationRanHibernation** TRUE if the system entered Hibernation. +- **RemediationRevertToSystemSucceeded** TRUE if reversion to the system context succeeded. +- **RemediationShellHasUpgraded** TRUE if the device upgraded. +- **RemediationShellMinimumTimeBetweenShellRuns** Indicates the time between shell runs exceeded the minimum required to execute plugins. +- **RemediationShellRunFromService** TRUE if the shell driver was run from the service. +- **RemediationShellSessionIdentifier** Unique identifier tracking a shell session. +- **RemediationShellSessionTimeInSeconds** Indicates the time the shell session took in seconds. +- **RemediationShellTaskDeleted** Indicates that the shell task has been deleted so no additional sediment pack runs occur for this installation. +- **RemediationUpdateServiceHealthRemediationResult** The result of the Update Service Health plug-in. +- **RemediationUpdateTaskHealthRemediationResult** The result of the Update Task Health plug-in. +- **RemediationUpdateTaskHealthTaskList** A list of tasks fixed by the Update Task Health plug-in. +- **RemediationWindowsLogSpaceFound** The size of the Windows log files found, measured in Megabytes. +- **RemediationWindowsLogSpaceFreed** The amount of disk space freed by deleting the Windows log files, measured in Megabytes. +- **RemediationWindowsSecondaryDriveFreeSpace** The amount of free space on the secondary drive, measured in Megabytes. +- **RemediationWindowsSecondaryDriveLetter** The letter designation of the first secondary drive with a total capacity of 10GB or more. +- **RemediationWindowsSecondaryDriveTotalSpace** The total storage capacity of the secondary drive, measured in Megabytes. +- **RemediationWindowsTotalSystemDiskSize** The total storage capacity of the System Disk Drive, measured in Megabytes. +- **Result** The HRESULT for Detection or Perform Action phases of the plug-in. +- **RunResult** The HRESULT for Detection or Perform Action phases of the plug-in. +- **ServiceHealthPlugin** The nae of the Service Health plug-in. +- **StartComponentCleanupTask** TRUE if the Component Cleanup task started successfully. +- **systemDriveFreeDiskSpace** Indicates the free disk space on system drive in MBs. +- **systemUptimeInHours** Indicates the amount of time the system in hours has been on since the last boot. +- **TotalSizeofOrphanedInstallerFilesInMegabytes** The size of any orphaned Windows Installer files, measured in Megabytes. +- **TotalSizeofStoreCacheAfterCleanupInMegabytes** The size of the Windows Store cache after cleanup, measured in Megabytes. +- **TotalSizeofStoreCacheBeforeCleanupInMegabytes** The size of the Windows Store cache (prior to cleanup), measured in Megabytes. +- **uninstallActive** TRUE if previous uninstall has occurred for current OS +- **usoScanDaysSinceLastScan** The number of days since the last USO (Update Session Orchestrator) scan. +- **usoScanInProgress** TRUE if a USO (Update Session Orchestrator) scan is in progress, to prevent multiple simultaneous scans. +- **usoScanIsAllowAutoUpdateKeyPresent** TRUE if the AllowAutoUpdate registry key is set. +- **usoScanIsAllowAutoUpdateProviderSetKeyPresent** TRUE if AllowAutoUpdateProviderSet registry key is set. +- **usoScanIsAuOptionsPresent** TRUE if Auto Update Options registry key is set. +- **usoScanIsFeatureUpdateInProgress** TRUE if a USO (Update Session Orchestrator) scan is in progress, to prevent multiple simultaneous scans. +- **usoScanIsNetworkMetered** TRUE if the device is currently connected to a metered network. +- **usoScanIsNoAutoUpdateKeyPresent** TRUE if no Auto Update registry key is set/present. +- **usoScanIsUserLoggedOn** TRUE if the user is logged on. +- **usoScanPastThreshold** TRUE if the most recent USO (Update Session Orchestrator) scan is past the threshold (late). +- **usoScanType** The type of USO (Update Session Orchestrator) scan (Interactive or Background). +- **windows10UpgraderBlockWuUpdates** Event to report the value of Windows 10 Upgrader BlockWuUpdates Key. +- **windowsEditionId** Event to report the value of Windows Edition ID. +- **WindowsHyberFilSysSizeInMegabytes** The size of the Windows Hibernation file, measured in Megabytes. +- **WindowsInstallerFolderSizeInMegabytes** The size of the Windows Installer folder, measured in Megabytes. +- **WindowsOldFolderSizeInMegabytes** The size of the Windows.OLD folder, measured in Megabytes. +- **WindowsOldSpaceCleanedInMB** The amount of disk space freed by removing the Windows.OLD folder, measured in Megabytes. +- **WindowsPageFileSysSizeInMegabytes** The size of the Windows Page file, measured in Megabytes. +- **WindowsSoftwareDistributionFolderSizeInMegabytes** The size of the SoftwareDistribution folder, measured in Megabytes. +- **WindowsSwapFileSysSizeInMegabytes** The size of the Windows Swap file, measured in Megabytes. +- **WindowsSxsFolderSizeInMegabytes** The size of the WinSxS (Windows Side-by-Side) folder, measured in Megabytes. +- **WindowsSxsTempFolderSizeInMegabytes** The size of the WinSxS (Windows Side-by-Side) Temp folder, measured in Megabytes. +- **windowsUpgradeRecoveredFromRs4** Event to report the value of the Windows Upgrade Recovered key. + ### Microsoft.Windows.Remediation.RemediationShellMainExeEventId -Enables tracking the ID of a process that remediates issues preventing security and quality updates. +Enables tracking of completion of process that remediates issues preventing security and quality updates. The following fields are available: -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events sent by the remediation system. -- **PackageVersion** Current package version of Remediation. -- **RemediationShellCanAcquireSedimentMutex** True if the remediation was able to acquire the sediment mutex. False if it is already running. -- **RemediationShellExecuteShellResult** Indicates if the remediation system completed without errors. -- **RemediationShellFoundDriverDll** Indicates whether the remediation system found its component files to run properly. -- **RemediationShellLoadedShellDriver** Indicates whether the remediation system loaded its component files to run properly. -- **RemediationShellLoadedShellFunction** Indicates whether the remediation system loaded the functions from its component files to run properly. +- **CV** Client side counter which indicates ordering of events sent by the remediation system. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by the remediation system. +- **PackageVersion** Current package version of Remediation. +- **RemediationShellCanAcquireSedimentMutex** True if the remediation was able to acquire the sediment mutex. False if it is already running. +- **RemediationShellExecuteShellResult** Indicates if the remediation system completed without errors. +- **RemediationShellFoundDriverDll** Result whether the remediation system found its component files to run properly. +- **RemediationShellLoadedShellDriver** Result whether the remediation system loaded its component files to run properly. +- **RemediationShellLoadedShellFunction** Result whether the remediation system loaded the functions from its component files to run properly. + ### Microsoft.Windows.Remediation.Started -Enables tracking the start of a process that remediates issues preventing security and quality updates. +This event reports whether a plug-in started, to help ensure Windows is up to date. The following fields are available: -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events sent by the remediation system. -- **PackageVersion** Current package version of Remediation. -- **PluginName** Name of the specific remediation for each generic plugin event. -- **Result** Results of the detection or perform action phases of the remediation system. +- **CV** Correlation vector. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. -## Sediment Service events ->[!NOTE] ->Events from this provider are sent with the installation of KB4023057 and any subsequent Windows update. For details, see [this support article](https://support.microsoft.com/help/4023057). +## Sediment events -### Microsoft.Windows.SedimentService.Applicable +### Microsoft.Windows.Sediment.OSRSS.UrlState -Indicates whether a given plugin is applicable. +This event indicates the state the Operating System Remediation System Service (OSRSS) is in while attempting a download from the URL. The following fields are available: -- **CV** Correlation vector. -- **DetectedCondition** Boolean true if detect condition is true and perform action will be run. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **IsSelfUpdateEnabledInOneSettings** True/False based on whether self update is enabled. -- **IsSelfUpdateNeeded** True/False based on whether a newer version is available. -- **PackageVersion** Version of the package. -- **PluginName** Name of the plugin specified for each generic plugin event. -- **Result** This is the HRESULT for detection or perform action phases of the plugin. +- **Id** A number identifying the URL +- **ServiceVersionMajor** Version info for the component +- **ServiceVersionMinor** Version info for the component +- **StateData** State-specific data, such as which attempt number for the download +- **StateNumber** A number identifying which state the URL is in (found, downloading, extracted, etc.) +- **Time** System timestamp the event was fired -### Microsoft.Windows.SedimentService.Completed - -Indicates whether a given plugin has completed its work. - -The following fields are available: - -- **CV** Correlation vector. -- **FailedReasons** String reason for any plugin failures. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **PackageVersion** Current package version of Remediation. -- **PluginName** Name of the plugin specified for each generic plugin event. -- **Result** Result of the service execution. -- **SedimentServiceCheckTaskFunctional** Result of checking if the scheduled task is functional. -- **SedimentServiceCurrentBytes** Current number of bytes the service is consuming. -- **SedimentServiceKillService** True/False based on whether the service should be stopped. -- **SedimentServiceMaximumBytes** Maximum bytes the service can consume. -- **SedimentServiceRetrievedKillService** True/False whether the kill service information was retrieved. -- **SedimentServiceStopping** True/False indicating whether the service was found to be stopping. -- **SedimentServiceTaskFunctional** True/False if scheduled task is functional. If task is not functional this indicates plugins will be run. -- **SedimentServiceTotalIterations** Number of iterations service will wait before running again. - -### Microsoft.Windows.SedimentService.Error - -Indicates whether an error condition occurs in the plugin. - -The following fields are available: - -- **Message** String message containing information from the service. -- **PackageVersion** Version of the package. -- **HResult** Return value from the plugin result. - -### Microsoft.Windows.SedimentService.FallbackError - -Indicates whether an error occurs for a fallback in the plugin. - -The following fields are available: - -- **s0** Fallback error level. -- **wilResult** Result for Windows Installer Logging function. - -### Microsoft.Windows.SedimentService.Information - -General information returned from the plugin. - -The following fields are available: - -- **HResult** Result of the plugin execution. -- **Message** Information collected from the plugin based on the purpose of the plugin. -- **PackageVersion** Version of the package. - -### Microsoft.Windows.SedimentService.Started - -Indicates that a given plugin has started. - -The following fields are available: - -- **CV** Correlation vector -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **PackageVersion** Version of the package. -- **PluginName** Name of the plugin running. -- **Result** Return code from the plugin result. - -### Microsoft.Windows.SedimentService.wilResult - -Result from the windows internal library. - -The following fields are available: - -- **callContext** List of telemetry activities containing this error. -- **currentContextId** Identifier for the newest telemetry activity containing this error. -- **currentContextMessage** Custom message associated with the newest telemetry activity containing this error (if any). -- **currentContextName** Name of the newest telemetry activity containing this error. -- **failureType** Indicates what type of failure was observed (exception, returned error, logged error or fail fast. -- **failureId** Identifier assigned to this failure. -- **filename** The name of the source file where the error occurred. -- **hresult** Failure error code. -- **lineNumber** Line number within the source file where the error occurred. -- **message** Custom message associated with the failure (if any). -- **module** Name of the binary where the error occurred. -- **originatingContextId** Identifier for the oldest telemetry activity containing this error. -- **originatingContextMessage** Custom message associated with the oldest telemetry activity containing this error (if any). -- **originatingContextName** Name of the oldest telemetry activity containing this error. -- **threadId** Identifier of the thread the error occurred on. - -## Sediment Launcher events - ->[!NOTE] ->Events from this provider are sent with the installation of KB4023057 and any subsequent Windows update. For details, see [this support article](https://support.microsoft.com/help/4023057). ### Microsoft.Windows.SedimentLauncher.Applicable @@ -2969,14 +2976,15 @@ Indicates whether a given plugin is applicable. The following fields are available: -- **CV** Correlation vector. -- **DetectedCondition** Boolean true if detect condition is true and action will be run. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **IsSelfUpdateEnabledInOneSettings** True/False based on whether self update is enabled. -- **IsSelfUpdateNeeded** True/False based on whether a newer version is available. -- **PackageVersion** Version of the package. -- **PluginName** Name of the plugin specified for each generic plugin event. -- **Result** This is the HRESULT for detection or perform action phases of the plugin. +- **CV** Correlation vector. +- **DetectedCondition** Boolean true if detect condition is true and perform action will be run. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **IsSelfUpdateEnabledInOneSettings** True if self update enabled in Settings. +- **IsSelfUpdateNeeded** True if self update needed by device. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. + ### Microsoft.Windows.SedimentLauncher.Completed @@ -2984,13 +2992,14 @@ Indicates whether a given plugin has completed its work. The following fields are available: -- **CV** Correlation vector. -- **FailedReasons** String reason for any plugin failures. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **PackageVersion** Current package version of Remediation. -- **PluginName** Name of the plugin specified for each generic plugin event. -- **Result** Result of the service execution. -- **SedLauncherExecutionResult** Final result of launcher running the plugins from the dll. +- **CV** Correlation vector. +- **FailedReasons** Concatenated list of failure reasons. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. +- **SedLauncherExecutionResult** HRESULT for one execution of the Sediment Launcher. + ### Microsoft.Windows.SedimentLauncher.Error @@ -2998,89 +3007,180 @@ Error occurred during execution of the plugin. The following fields are available: -- **Message** Information message returned from a plugin containing only information internal to plugin execution. -- **PackageVersion** Version of the package. -- **HResult** Return value from the plugin result. +- **HResult** The result for the Detection or Perform Action phases of the plug-in. +- **Message** A message containing information about the error that occurred (if any). +- **PackageVersion** The version number of the current remediation package. + ### Microsoft.Windows.SedimentLauncher.FallbackError -Error occurred during execution of the plugin fallback. +This event indicates that an error occurred during execution of the plug-in fallback. The following fields are available: -- **s0** Fallback error level for plugin. -- **wilResult** Result from executing Windows Installer Logging based function. +- **s0** Error occurred during execution of the plugin fallback. See [Microsoft.Windows.SedimentLauncher.wilResult](#microsoftwindowssedimentlauncherwilresult). +- **wilResult** Result from executing wil based function. See [wilResult](#wilresult). + ### Microsoft.Windows.SedimentLauncher.Information -General information returned from the plugin. +This event provides general information returned from the plug-in. The following fields are available: -- **HResult** Result of the plugin execution. -- **Message** Information collected from the plugin based on the purpose of the plugin. -- **PackageVersion** Version of the package. +- **HResult** This is the HRESULT for detection or perform action phases of the plugin. +- **Message** Information message returned from a plugin containing only information internal to the plugins execution. +- **PackageVersion** Current package version of Remediation. + ### Microsoft.Windows.SedimentLauncher.Started -Indicates that a given plugin has started. +This event indicates that a given plug-in has started. The following fields are available: -- **CV** Correlation vector. -- **GlobalEventCounter** Client side counter which indicates ordering of events. -- **PackageVersion** Version of the package. -- **PluginName** Name of the plugin running. -- **Result** Return code from the plugin result. +- **CV** Correlation vector. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. + ### Microsoft.Windows.SedimentLauncher.wilResult -Result from the windows internal library. +This event provides the result from the Windows internal library. The following fields are available: -- **callContext** List of telemetry activities containing this error. -- **currentContextId** Identifier for the newest telemetry activity containing this error. -- **currentContextMessage** Custom message associated with the newest telemetry activity containing this error (if any). -- **currentContextName** Name of the newest telemetry activity containing this error. -- **failurecount** Number of failures seen. -- **failureType** Indicates what type of failure was observed (exception, returned error, logged error or fail fast. -- **failureId** Identifier assigned to this failure. -- **filename** The name of the source file where the error occurred. -- **function** Name of the function where the error occurred. -- **hresult** Failure error code. -- **lineNumber** Line number within the source file where the error occurred. -- **message** Custom message associated with the failure (if any). -- **module** Name of the binary where the error occurred. -- **originatingContextId** Identifier for the oldest telemetry activity containing this error. -- **originatingContextMessage** Custom message associated with the oldest telemetry activity containing this error (if any). -- **originatingContextName** Name of the oldest telemetry activity containing this error. -- **threadId** Identifier of the thread the error occurred on. +- **callContext** List of telemetry activities containing this error. +- **currentContextId** Identifier for the newest telemetry activity containing this error. +- **currentContextMessage** Custom message associated with the newest telemetry activity containing this error (if any). +- **currentContextName** Name of the newest telemetry activity containing this error. +- **failureCount** Number of failures seen within the binary where the error occurred. +- **failureId** Identifier assigned to this failure. +- **failureType** Indicates what type of failure was observed (exception, returned error, logged error or fail fast). +- **fileName** Source code file name where the error occurred. +- **function** Name of the function where the error occurred. +- **hresult** Failure error code. +- **lineNumber** Line number within the source code file where the error occurred. +- **message** Custom message associated with the failure (if any). +- **module** Name of the binary where the error occurred. +- **originatingContextId** Identifier for the oldest telemetry activity containing this error. +- **originatingContextMessage** Custom message associated with the oldest telemetry activity containing this error (if any). +- **originatingContextName** Name of the oldest telemetry activity containing this error. +- **threadId** Identifier of the thread the error occurred on. + + +### Microsoft.Windows.SedimentService.Applicable + +This event indicates whether a given plug-in is applicable. + +The following fields are available: + +- **CV** Correlation vector. +- **DetectedCondition** Determine whether action needs to run based on device properties. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **IsSelfUpdateEnabledInOneSettings** Indicates if self update is enabled in One Settings. +- **IsSelfUpdateNeeded** Indicates if self update is needed. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. + + +### Microsoft.Windows.SedimentService.Completed + +This event indicates whether a given plug-in has completed its work. + +The following fields are available: + +- **CV** Correlation vector. +- **FailedReasons** List of reasons when the plugin action failed. +- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user. +- **PackageVersion** Current package version of Remediation. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for detection or perform action phases of the plugin. +- **SedimentServiceCheckTaskFunctional** True/False if scheduled task check succeeded. +- **SedimentServiceCurrentBytes** Number of current private bytes of memory consumed by sedsvc.exe. +- **SedimentServiceKillService** True/False if service is marked for kill (Shell.KillService). +- **SedimentServiceMaximumBytes** Maximum bytes allowed for the service. +- **SedimentServiceRetrievedKillService** True/False if result of One Settings check for kill succeeded - we only send back one of these indicators (not for each call). +- **SedimentServiceStopping** True/False indicating whether the service is stopping. +- **SedimentServiceTaskFunctional** True/False if scheduled task is functional. If task is not functional this indicates plugins will be run. +- **SedimentServiceTotalIterations** Number of 5 second iterations service will wait before running again. + + +### Microsoft.Windows.SedimentService.Error + +This event indicates whether an error condition occurred in the plug-in. + +The following fields are available: + +- **HResult** This is the HRESULT for detection or perform action phases of the plugin. +- **Message** Custom message associated with the failure (if any). +- **PackageVersion** Current package version of Remediation. + + +### Microsoft.Windows.SedimentService.FallbackError + +This event indicates whether an error occurred for a fallback in the plug-in. + +The following fields are available: + +- **s0** Event returned when an error occurs for a fallback in the plugin. See [Microsoft.Windows.SedimentService.wilResult](#microsoftwindowssedimentservicewilresult). +- **wilResult** Result for wil based function. See [wilResult](#wilresult). + + +### Microsoft.Windows.SedimentService.Information + +This event provides general information returned from the plug-in. + +The following fields are available: + +- **HResult** This is the HRESULT for detection or perform action phases of the plugin. +- **Message** Custom message associated with the failure (if any). +- **PackageVersion** Current package version of Remediation. + + +### Microsoft.Windows.SedimentService.Started + +This event indicates a specified plug-in has started. This information helps ensure Windows is up to date. + +The following fields are available: + +- **CV** The Correlation Vector. +- **GlobalEventCounter** The client-side counter that indicates ordering of events. +- **PackageVersion** The version number of the current remediation package. +- **PluginName** Name of the plugin specified for each generic plugin event. +- **Result** This is the HRESULT for Detection or Perform Action phases of the plugin. + + +### Microsoft.Windows.SedimentService.wilResult + +This event provides the result from the Windows internal library. + +The following fields are available: + +- **callContext** List of telemetry activities containing this error. +- **currentContextId** Identifier for the newest telemetry activity containing this error. +- **currentContextMessage** Custom message associated with the newest telemetry activity containing this error (if any). +- **currentContextName** Name of the newest telemetry activity containing this error. +- **failureCount** Number of failures seen within the binary where the error occurred. +- **failureId** Identifier assigned to this failure. +- **failureType** Indicates what type of failure was observed (exception, returned error, logged error or fail fast). +- **fileName** Source code file name where the error occurred. +- **function** Name of the function where the error occurred. +- **hresult** Failure error code. +- **lineNumber** Line number within the source code file where the error occurred. +- **message** Custom message associated with the failure (if any). +- **module** Name of the binary where the error occurred. +- **originatingContextId** Identifier for the oldest telemetry activity containing this error. +- **originatingContextMessage** Custom message associated with the oldest telemetry activity containing this error (if any). +- **originatingContextName** Name of the oldest telemetry activity containing this error. +- **threadId** Identifier of the thread the error occurred on. + ## Setup events -### SetupPlatformTel.SetupPlatformTelActivityStarted - -This event sends basic metadata about the update installation process generated by SetupPlatform to help keep Windows up to date. - -The following fields are available: - -- **Name** The name of the dynamic update type. Example: GDR driver - - -### SetupPlatformTel.SetupPlatformTelActivityEvent - -This event sends basic metadata about the SetupPlatform update installation process, to help keep Windows up-to-date - -The following fields are available: - -- **ActivityId** Provides a unique Id to correlate events that occur between a activity start event, and a stop event -- **ActivityName** Provides a friendly name of the package type that belongs to the ActivityId (Setup, LanguagePack, GDR, Driver, etc.) -- **FieldName** Retrieves the event name/data point. Examples: InstallStartTime, InstallEndtime, OverallResult etc. -- **GroupName** Retrieves the groupname the event belongs to. Example: Install Information, DU Information, Disk Space Information etc. -- **value** Value associated with the corresponding event name. For example, time-related events will include the system time - - ### SetupPlatformTel.SetupPlatformTelEvent This service retrieves events generated by SetupPlatform, the engine that drives the various deployment scenarios. @@ -3088,21 +3188,22 @@ This service retrieves events generated by SetupPlatform, the engine that drives The following fields are available: - **FieldName** Retrieves the event name/data point. Examples: InstallStartTime, InstallEndtime, OverallResult etc. -- **Value** Retrieves the value associated with the corresponding event name (Field Name). For example: For time related events this will include the system time. - **GroupName** Retrieves the groupname the event belongs to. Example: Install Information, DU Information, Disk Space Information etc. +- **Value** Retrieves the value associated with the corresponding event name (Field Name). For example: For time related events this will include the system time. ## Shared PC events ### Microsoft.Windows.SharedPC.AccountManager.DeleteUserAccount -Activity for deletion of a user account for devices set up for Shared PC mode as part of the Transient Account Manager to help keep Windows up to date. Deleting unused user accounts on shared devices frees up disk space to improve Windows Update success rates. +Activity for deletion of a user account for devices set up for Shared PC mode as part of the Transient Account Manager to help keep Windows up to date. Deleting un-used user accounts on Education/Shared PCs frees up disk space to improve Windows Update success rates. The following fields are available: - **accountType** The type of account that was deleted. Example: AD, AAD, or Local +- **deleteState** Whether the attempted deletion of the user account was successful. - **userSid** The security identifier of the account. -- **wilActivity** Windows Error Reporting data collected when there is a failure in deleting a user account with the Transient Account Manager. +- **wilActivity** Windows Error Reporting data collected when there is a failure in deleting a user account with the Transient Account Manager. See [wilActivity](#wilactivity). ### Microsoft.Windows.SharedPC.AccountManager.SinglePolicyEvaluation @@ -3111,129 +3212,232 @@ Activity for run of the Transient Account Manager that determines if any user ac The following fields are available: -- **wilActivity** Windows Error Reporting data collected when there is a failure in evaluating accounts to be deleted with the Transient Account Manager. -- **totalAccountCount** The number of accounts on a device after running the Transient Account Manager policies. - **evaluationTrigger** When was the Transient Account Manager policies ran? Example: At log off or during maintenance hours +- **totalAccountCount** The number of accounts on a device after running the Transient Account Manager policies. +- **wilActivity** Windows Error Reporting data collected when there is a failure in evaluating accounts to be deleted with the Transient Account Manager. See [wilActivity](#wilactivity). + + +### wilActivity + +This event provides a Windows Internal Library context used for Product and Service diagnostics. + +The following fields are available: + +- **callContext** The function where the failure occurred. +- **currentContextId** The ID of the current call context where the failure occurred. +- **currentContextMessage** The message of the current call context where the failure occurred. +- **currentContextName** The name of the current call context where the failure occurred. +- **failureCount** The number of failures for this failure ID. +- **failureId** The ID of the failure that occurred. +- **failureType** The type of the failure that occurred. +- **fileName** The file name where the failure occurred. +- **function** The function where the failure occurred. +- **hresult** The HResult of the overall activity. +- **lineNumber** The line number where the failure occurred. +- **message** The message of the failure that occurred. +- **module** The module where the failure occurred. +- **originatingContextId** The ID of the originating call context that resulted in the failure. +- **originatingContextMessage** The message of the originating call context that resulted in the failure. +- **originatingContextName** The name of the originating call context that resulted in the failure. +- **threadId** The ID of the thread on which the activity is executing. + + +### wilResult + +This event provides a Windows Internal Library context used for Product and Service diagnostics. + +The following fields are available: + +- **callContext** The call context stack where failure occurred. +- **currentContextId** The ID of the current call context where the failure occurred. +- **currentContextMessage** The message of the current call context where the failure occurred. +- **currentContextName** The name of the current call context where the failure occurred. +- **failureCount** The number of failures for this failure ID. +- **failureId** The ID of the failure that occurred. +- **failureType** The type of the failure that occurred. +- **fileName** The file name where the failure occurred. +- **function** The function where the failure occurred. +- **hresult** The HResult of the overall activity. +- **lineNumber** The line number where the failure occurred. +- **message** The message of the failure that occurred. +- **module** The module where the failure occurred. +- **originatingContextId** The ID of the originating call context that resulted in the failure. +- **originatingContextMessage** The message of the originating call context that resulted in the failure. +- **originatingContextName** The name of the originating call context that resulted in the failure. +- **threadId** The ID of the thread on which the activity is executing. + + +## SIH events + +### SIHEngineTelemetry.EvalApplicability + +This event is sent when targeting logic is evaluated to determine if a device is eligible a given action. + +The following fields are available: + +- **ActionReasons** If an action has been assessed as inapplicable, the additional logic prevented it. +- **CachedEngineVersion** The engine DLL version that is being used. +- **EventInstanceID** A unique identifier for event instance. +- **EventScenario** Indicates the purpose of sending this event – whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **HandlerReasons** If an action has been assessed as inapplicable, the installer technology-specific logic prevented it. +- **ServiceGuid** A unique identifier that represents which service the software distribution client is connecting to (SIH, Windows Update, Windows Store, etc.) +- **StandardReasons** If an action has been assessed as inapplicable, the standard logic the prevented it. +- **StatusCode** Result code of the event (success, cancellation, failure code HResult). +- **UpdateID** A unique identifier for the action being acted upon. +- **WUDeviceID** The unique identifier controlled by the software distribution client. + + +### SIHEngineTelemetry.ExecuteAction + +This event is triggered with SIH attempts to execute (e.g. install) the update or action in question. Includes important information like if the update required a reboot. + +The following fields are available: + +- **CachedEngineVersion** The engine DLL version that is being used. +- **EventInstanceID** A unique identifier for event instance. +- **EventScenario** Indicates the purpose of sending this event, whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **RebootRequired** Indicates if a reboot was required to complete the action. +- **ServiceGuid** A unique identifier that represents which service the software distribution client is connecting to (SIH, Windows Update, Windows Store, etc.). +- **StatusCode** Result code of the event (success, cancellation, failure code HResult). +- **UpdateID** A unique identifier for the action being acted upon. +- **WUDeviceID** The unique identifier controlled by the software distribution client. + + +### SIHEngineTelemetry.PostRebootReport + +This event reports the status of an action following a reboot, should one have been required. + +The following fields are available: + +- **CachedEngineVersion** The engine DLL version that is being used. +- **EventInstanceID** A unique identifier for event instance. +- **EventScenario** Indicates the purpose of sending this event, whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **ServiceGuid** A unique identifier that represents which service the software distribution client is connecting to (SIH, Windows Update, Windows Store, etc.). +- **StatusCode** Result code of the event (success, cancellation, failure code HResult). +- **UpdateID** A unique identifier for the action being acted upon. +- **WUDeviceID** The unique identifier controlled by the software distribution client. + + +### SIHEngineTelemetry.ServiceStateChange + +This event reports the status of attempts to stop or start a service as part of executing an action. + +The following fields are available: + +- **CachedEngineVersion** The engine DLL version that is being used. +- **EventInstanceID** A unique identifier for event instance. +- **EventScenario** Indicates the purpose of sending this event, whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **Service** The service that is being stopped/started. +- **ServiceGuid** A unique identifier that represents which service the software distribution client is connecting to (SIH, Windows Update, Windows Store, etc.). +- **StateChange** The service operation (stop/start) is being attempted. +- **StatusCode** Result code of the event (success, cancellation, failure code HResult). +- **UpdateID** A unique identifier for the action being acted upon. +- **WUDeviceID** The unique identifier controlled by the software distribution client. + + +### SIHEngineTelemetry.SLSActionData + +This event reports if the SIH client was able to successfully parse the manifest describing the actions to be evaluated. + +The following fields are available: + +- **CachedEngineVersion** The engine DLL version that is being used. +- **EventInstanceID** A unique identifier for event instance. +- **EventScenario** Indicates the purpose of sending this event – whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **FailedParseActions** The list of actions that were not successfully parsed. +- **ParsedActions** The list of actions that were successfully parsed. +- **ServiceGuid** A unique identifier that represents which service the software distribution client is connecting to (SIH, Windows Update, Windows Store, etc.) +- **WUDeviceID** The unique identifier controlled by the software distribution client. ## Software update events -### SoftwareUpdateClientTelemetry.UpdateDetected +### SoftwareUpdateClientTelemetry.CheckForUpdates -This event sends data about an AppX app that has been updated from the Microsoft Store, including what app needs an update and what version/architecture is required, in order to understand and address problems with apps getting required updates. +Scan process event on Windows Update client (see eventscenario field for specifics, e.g.: started/failed/succeeded) The following fields are available: +- **ActivityMatchingId** Contains a unique ID identifying a single CheckForUpdates session from initialization to completion. +- **AllowCachedResults** Indicates if the scan allowed using cached results. - **ApplicableUpdateInfo** Metadata for the updates which were detected as applicable -- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client -- **NumberOfApplicableUpdates** The number of updates which were ultimately deemed applicable to the system after the detection process is complete -- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one -- **WUDeviceID** The unique device ID controlled by the software distribution client -- **IntentPFNs** Intended application-set metadata for atomic update scenarios. -- **ServiceGuid** An ID which represents which service the software distribution client is connecting to (Windows Update, Microsoft Store, etc.) - - -### SoftwareUpdateClientTelemetry.SLSDiscovery - -This event sends data about the ability of Windows to discover the location of a backend server with which it must connect to perform updates or content acquisition, in order to determine disruptions in availability of update services and provide context for Windows Update errors. - -The following fields are available: - -- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed -- **HResult** Indicates the result code of the event (success, cancellation, failure code HResult) -- **IsBackground** Indicates whether the SLS discovery event took place in the foreground or background -- **NextExpirationTime** Indicates when the SLS cab expires -- **ServiceID** An ID which represents which service the software distribution client is connecting to (Windows Update, Microsoft Store, etc.) -- **SusClientId** The unique device ID controlled by the software distribution client -- **UrlPath** Path to the SLS cab that was downloaded -- **WUAVersion** The version number of the software distribution client - - -### SoftwareUpdateClientTelemetry.Commit - -This event sends data on whether the Update Service has been called to execute an upgrade, to help keep Windows up to date. - -The following fields are available: - - **BiosFamily** The family of the BIOS (Basic Input Output System). - **BiosName** The name of the device BIOS. - **BiosReleaseDate** The release date of the device BIOS. - **BiosSKUNumber** The sku number of the device BIOS. - **BIOSVendor** The vendor of the BIOS. - **BiosVersion** The version of the BIOS. -- **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. +- **BranchReadinessLevel** The servicing branch configured on the device. +- **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. +- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. +- **CapabilityDetectoidGuid** The GUID for a hardware applicability detectoid that could not be evaluated. +- **CDNCountryCode** Two letter country abbreviation for the Content Distribution Network (CDN) location. +- **CDNId** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. - **ClientVersion** The version number of the software distribution client. +- **Context** Gives context on where the error has occurred. Example: AutoEnable, GetSLSData, AddService, Misc, or Unknown +- **CurrentMobileOperator** The mobile operator the device is currently connected to. +- **DeferralPolicySources** Sources for any update deferral policies defined (GPO = 0x10, MDM = 0x100, Flight = 0x1000, UX = 0x10000). +- **DeferredUpdates** Update IDs which are currently being deferred until a later time - **DeviceModel** What is the device model. +- **DriverError** The error code hit during a driver scan. This is 0 if no error was encountered. +- **DriverExclusionPolicy** Indicates if the policy for not including drivers with Windows Update is enabled. +- **DriverSyncPassPerformed** Were drivers scanned this time? - **EventInstanceID** A globally unique identifier for event instance. -- **EventScenario** State of call -- **EventType** "Possible values are ""Child"", ""Bundle"", or ""Driver""." -- **HandlerType** Indicates the kind of content (app, driver, windows patch, etc.) -- **RevisionNumber** Unique revision number of Update -- **ServerId** Identifier for the service to which the software distribution client is connecting, such as Windows Update and Microsoft Store. +- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **ExtendedMetadataCabUrl** Hostname that is used to download an update. +- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. +- **FailedUpdateGuids** The GUIDs for the updates that failed to be evaluated during the scan. +- **FailedUpdatesCount** The number of updates that failed to be evaluated during the scan. +- **FeatureUpdateDeferral** The deferral period configured for feature OS updates on the device (in days). +- **FeatureUpdatePause** Indicates whether feature OS updates are paused on the device. +- **FeatureUpdatePausePeriod** The pause duration configured for feature OS updates on the device (in days). +- **FlightBranch** The branch that a device is on if participating in flighting (pre-release builds). +- **FlightRing** The ring (speed of getting builds) that a device is on if participating in flighting (pre-release builds). +- **HomeMobileOperator** The mobile operator that the device was originally intended to work with. +- **IntentPFNs** Intended application-set metadata for atomic update scenarios. +- **IPVersion** Indicates whether the download took place over IPv4 or IPv6 +- **IsWUfBDualScanEnabled** Indicates if Windows Update for Business dual scan is enabled on the device. +- **IsWUfBEnabled** Indicates if Windows Update for Business is enabled on the device. +- **IsWUfBFederatedScanDisabled** Indicates if Windows Update for Business federated scan is disabled on the device. +- **MetadataIntegrityMode** The mode of the update transport metadata integrity check. 0-Unknown, 1-Ignoe, 2-Audit, 3-Enforce +- **MSIError** The last error that was encountered during a scan for updates. +- **NetworkConnectivityDetected** Indicates the type of network connectivity that was detected. 0 - IPv4, 1 - IPv6 +- **NumberOfApplicableUpdates** The number of updates which were ultimately deemed applicable to the system after the detection process is complete +- **NumberOfApplicationsCategoryScanEvaluated** The number of categories (apps) for which an app update scan checked +- **NumberOfLoop** The number of round trips the scan required +- **NumberOfNewUpdatesFromServiceSync** The number of updates which were seen for the first time in this scan +- **NumberOfUpdatesEvaluated** The total number of updates which were evaluated as a part of the scan +- **NumFailedMetadataSignatures** The number of metadata signatures checks which failed for new metadata synced down. +- **Online** Indicates if this was an online scan. +- **PausedUpdates** A list of UpdateIds which that currently being paused. +- **PauseFeatureUpdatesEndTime** If feature OS updates are paused on the device, this is the date and time for the end of the pause time window. +- **PauseFeatureUpdatesStartTime** If feature OS updates are paused on the device, this is the date and time for the beginning of the pause time window. +- **PauseQualityUpdatesEndTime** If quality OS updates are paused on the device, this is the date and time for the end of the pause time window. +- **PauseQualityUpdatesStartTime** If quality OS updates are paused on the device, this is the date and time for the beginning of the pause time window. +- **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting (pre-release builds) being introduced. +- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. +- **QualityUpdateDeferral** The deferral period configured for quality OS updates on the device (in days). +- **QualityUpdatePause** Indicates whether quality OS updates are paused on the device. +- **QualityUpdatePausePeriod** The pause duration configured for quality OS updates on the device (in days). +- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one +- **ScanDurationInSeconds** The number of seconds a scan took +- **ScanEnqueueTime** The number of seconds it took to initialize a scan +- **ServiceGuid** An ID which represents which service the software distribution client is checking for content (Windows Update, Windows Store, etc.). +- **ServiceUrl** The environment URL a device is configured to scan with +- **ShippingMobileOperator** The mobile operator that a device shipped on. +- **StatusCode** Indicates the result of a CheckForUpdates event (success, cancellation, failure code HResult). +- **SyncType** Describes the type of scan the event was - **SystemBIOSMajorRelease** Major version of the BIOS. - **SystemBIOSMinorRelease** Minor version of the BIOS. -- **UpdateId** Unique Update ID -- **WUDeviceID** UniqueDeviceID -- **BundleRevisionNumber** Identifies the revision number of the content bundle -- **FlightId** The specific id of the flight the device is getting -- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client - - -### SoftwareUpdateClientTelemetry.DownloadCheckpoint - -This event provides a checkpoint between each of the Windows Update download phases for UUP content - -The following fields are available: - -- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed -- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough -- **FileId** A hash that uniquely identifies a file -- **FileName** Name of the downloaded file -- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one -- **StatusCode** Indicates the result of a CheckForUpdates event (success, cancellation, failure code HResult) -- **EventType** "Possible values are ""Child"", ""Bundle"", ""Relase"" or ""Driver""" -- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client -- **ClientVersion** The version number of the software distribution client -- **FlightId** The unique identifier for each flight -- **RevisionNumber** Unique revision number of Update -- **ServiceGuid** An ID which represents which service the software distribution client is checking for content (Windows Update, Microsoft Store, etc.) -- **UpdateId** Unique Update ID -- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue - - -### SoftwareUpdateClientTelemetry.UpdateMetadataIntegrity - -This event identifies whether updates have been tampered with and protects against man-in-the-middle attacks. - -The following fields are available: - -- **EventScenario** The purpose of this event, such as scan started, scan succeeded, or scan failed. -- **ExtendedStatusCode** The secondary status code of the event. -- **LeafCertId** Integral ID from the FragmentSigning data for certificate that failed. -- **MetadataIntegrityMode** The mode of the transport metadata integrity check. 0 = unknown; 1 = ignore; 2 = audit; 3 = enforce -- **MetadataSignature** A base64-encoded string of the signature associated with the update metadata (specified by revision ID). -- **RevisionId** The revision ID for a specific piece of content. -- **RevisionNumber** The revision number for a specific piece of content. -- **ServiceGuid** Identifies the service to which the software distribution client is connected, Example: Windows Update or Microsoft Store -- **SHA256OfLeafCertPublicKey** A base64 encoding of the hash of the Base64CertData in the FragmentSigning data of the leaf certificate. -- **SHA256OfTimestampToken** A base64-encoded string of hash of the timestamp token blob. -- **SignatureAlgorithm** The hash algorithm for the metadata signature. -- **StatusCode** The status code of the event. -- **TimestampTokenId** The time this was created. It is encoded in a timestamp blob and will be zero if the token is malformed. -- **UpdateId** The update ID for a specific piece of content. -- **TimestampTokenCertThumbprint** "The thumbprint of the encoded timestamp token. " -- **ValidityWindowInDays** The validity window that's in effect when verifying the timestamp. -- **ListOfSHA256OfIntermediateCerData** A semicolon delimited list of base64 encoding of hashes for the Base64CerData in the FragmentSigning data of an intermediate certificate. -- **RawMode** The raw unparsed mode string from the SLS response. This field is null if not applicable. -- **RawValidityWindowInDays** The raw unparsed validity window string in days of the timestamp token. This field is null if not applicable. -- **SHA256OfLeafCerData** A base64 encoding of the hash for the Base64CerData in the FragmentSigning data of the leaf certificate. -- **EndpointUrl** The endpoint URL where the device obtains update metadata. This is used to distinguish between test, staging, and production environments. -- **SLSPrograms** A test program to which a device may have opted in. Example: Insider Fast +- **TargetMetadataVersion** For self-initiated healing, this is the target version of the SIH engine to download (if needed). If not, the value is null. +- **TotalNumMetadataSignatures** The total number of metadata signatures checks done for new metadata that was synced down. +- **WebServiceRetryMethods** Web service method requests that needed to be retried to complete operation. +- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. ### SoftwareUpdateClientTelemetry.Download -This event sends tracking data about the software distribution client download of the content for that update, to help keep Windows up to date. +Download process event for target update on Windows Update client (see eventscenario field for specifics, e.g.: started/failed/succeeded) The following fields are available: @@ -3254,19 +3458,15 @@ The following fields are available: - **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. - **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. - **CbsDownloadMethod** Indicates whether the download was a full-file download or a partial/delta download. -- **CDNCountryCode** Two letter country abbreviation for the CDN's location. +- **CDNCountryCode** Two letter country abbreviation for the Content Distribution Network (CDN) location. - **CDNId** ID which defines which CDN the software distribution client downloaded the content from. -- **ClientManagedByWSUSServer** Indicates whether the client is managed by Windows Server Update Services (WSUS). - **ClientVersion** The version number of the software distribution client. - **CurrentMobileOperator** The mobile operator the device is currently connected to. - **DeviceModel** What is the device model. -- **DeviceOEM** What OEM does this device belong to. - **DownloadPriority** Indicates whether a download happened at background, normal, or foreground priority. - **DownloadScenarioId** A unique ID for a given download used to tie together WU and DO events. - **DownloadType** Differentiates the download type of SIH downloads between Metadata and Payload downloads. -- **Edition** Indicates the edition of Windows being used. - **EventInstanceID** A globally unique identifier for event instance. -- **EventNamespaceID** Indicates whether the event succeeded or failed. Has the format EventType+Event where Event is Succeeded, Cancelled, Failed, etc. - **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started downloading content, or whether it was cancelled, succeeded, or failed. - **EventType** Possible values are Child, Bundle, or Driver. - **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. @@ -3280,22 +3480,19 @@ The following fields are available: - **HomeMobileOperator** The mobile operator that the device was originally intended to work with. - **HostName** The hostname URL the content is downloading from. - **IPVersion** Indicates whether the download took place over IPv4 or IPv6. -- **IsAOACDevice** Is it Always On, Always Connected? - **IsDependentSet** Indicates whether a driver is a part of a larger System Hardware/Firmware Update - **IsWUfBDualScanEnabled** Indicates if Windows Update for Business dual scan is enabled on the device. - **IsWUfBEnabled** Indicates if Windows Update for Business is enabled on the device. - **NetworkCostBitMask** Indicates what kind of network the device is connected to (roaming, metered, over data cap, etc.) -- **NetworkRestrictionStatus** "More general version of NetworkCostBitMask, specifying whether Windows considered the current network to be ""metered.""" +- **NetworkRestrictionStatus** More general version of NetworkCostBitMask, specifying whether Windows considered the current network to be "metered." - **PackageFullName** The package name of the content. - **PhonePreviewEnabled** Indicates whether a phone was opted-in to getting preview builds, prior to flighting (pre-release builds) being introduced. -- **PlatformRole** The PowerPlatformRole as defined on MSDN - **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. -- **ProcessorArchitecture** Processor architecture of the system (x86, AMD64, ARM). - **QualityUpdatePause** Indicates whether quality OS updates are paused on the device. - **RelatedCV** The previous Correlation Vector that was used before swapping with a new one - **RepeatFailFlag** Indicates whether this specific piece of content had previously failed to download. - **RevisionNumber** Identifies the revision number of this specific piece of content. -- **ServiceGuid** An ID which represents which service the software distribution client is installing content for (Windows Update, Microsoft Store, etc.). +- **ServiceGuid** An ID which represents which service the software distribution client is installing content for (Windows Update, Windows Store, etc.). - **Setup360Phase** If the download is for an operating system upgrade, this datapoint indicates which phase of the upgrade is underway. - **ShippingMobileOperator** The mobile operator that a device shipped on. - **StatusCode** Indicates the result of a Download event (success, cancellation, failure code HResult). @@ -3308,93 +3505,65 @@ The following fields are available: - **TimeToEstablishConnection** Time (in ms) it took to establish the connection prior to beginning downloaded. - **TotalExpectedBytes** The total count of bytes that the download is expected to be. - **UpdateId** An identifier associated with the specific piece of content. +- **UpdateID** An identifier associated with the specific piece of content. - **UpdateImportance** Indicates whether a piece of content was marked as Important, Recommended, or Optional. - **UsedDO** Whether the download used the delivery optimization service. - **UsedSystemVolume** Indicates whether the content was downloaded to the device's main system storage drive, or an alternate storage drive. - **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. -- **WUSetting** Indicates the users' current updating settings. -### SoftwareUpdateClientTelemetry.CheckForUpdates +### SoftwareUpdateClientTelemetry.DownloadCheckpoint -This event sends tracking data about the software distribution client check for content that is applicable to a device, to help keep Windows up to date +This event provides a checkpoint between each of the Windows Update download phases for UUP content The following fields are available: -- **ActivityMatchingId** Contains a unique ID identifying a single CheckForUpdates session from initialization to completion. -- **AllowCachedResults** Indicates if the scan allowed using cached results. -- **BiosFamily** The family of the BIOS (Basic Input Output System). -- **BiosName** The name of the device BIOS. -- **BiosReleaseDate** The release date of the device BIOS. -- **BiosSKUNumber** The sku number of the device BIOS. -- **BIOSVendor** The vendor of the BIOS. -- **BiosVersion** The version of the BIOS. -- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. -- **CapabilityDetectoidGuid** The GUID for a hardware applicability detectoid that could not be evaluated. -- **CDNCountryCode** Two letter country abbreviation for the CDN's location. -- **CDNId** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. -- **ClientVersion** The version number of the software distribution client. -- **CurrentMobileOperator** The mobile operator the device is currently connected to. -- **DeviceModel** What is the device model. -- **DriverError** The error code hit during a driver scan. This is 0 if no error was encountered. -- **EventInstanceID** A globally unique identifier for event instance. -- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. -- **ExtendedMetadataCabUrl** Hostname that is used to download an update. -- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. -- **FailedUpdateGuids** The GUIDs for the updates that failed to be evaluated during the scan. -- **FailedUpdatesCount** The number of updates that failed to be evaluated during the scan. -- **FlightBranch** The branch that a device is on if participating in flighting (pre-release builds). -- **FlightRing** The ring (speed of getting builds) that a device is on if participating in flighting (pre-release builds). -- **HomeMobileOperator** The mobile operator that the device was originally intended to work with. -- **IPVersion** Indicates whether the download took place over IPv4 or IPv6 -- **IsWUfBDualScanEnabled** Indicates if Windows Update for Business dual scan is enabled on the device. -- **IsWUfBEnabled** Indicates if Windows Update for Business is enabled on the device. -- **MetadataIntegrityMode** The mode of the update transport metadata integrity check. 0-Unknown, 1-Ignoe, 2-Audit, 3-Enforce -- **MSIError** The last error that was encountered during a scan for updates. -- **NetworkConnectivityDetected** Indicates the type of network connectivity that was detected. 0 - IPv4, 1 - IPv6 -- **NumberOfApplicationsCategoryScanEvaluated** The number of categories (apps) for which an app update scan checked -- **NumberOfLoop** The number of round trips the scan required -- **NumberOfNewUpdatesFromServiceSync** The number of updates which were seen for the first time in this scan -- **NumberOfUpdatesEvaluated** The total number of updates which were evaluated as a part of the scan -- **NumFailedMetadataSignatures** The number of metadata signatures checks which failed for new metadata synced down. -- **Online** Indicates if this was an online scan. -- **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting (pre-release builds) being introduced. -- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. +- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client +- **ClientVersion** The version number of the software distribution client +- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed +- **EventType** Possible values are "Child", "Bundle", "Relase" or "Driver" +- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough +- **FileId** A hash that uniquely identifies a file +- **FileName** Name of the downloaded file +- **FlightId** The unique identifier for each flight - **RelatedCV** The previous Correlation Vector that was used before swapping with a new one -- **ScanDurationInSeconds** The number of seconds a scan took -- **ScanEnqueueTime** The number of seconds it took to initialize a scan -- **ServiceGuid** An ID which represents which service the software distribution client is checking for content (Windows Update, Microsoft Store, etc.). -- **ServiceUrl** The environment URL a device is configured to scan with -- **ShippingMobileOperator** The mobile operator that a device shipped on. -- **StatusCode** Indicates the result of a CheckForUpdates event (success, cancellation, failure code HResult). -- **SyncType** Describes the type of scan the event was -- **SystemBIOSMajorRelease** Major version of the BIOS. -- **SystemBIOSMinorRelease** Minor version of the BIOS. -- **TotalNumMetadataSignatures** The total number of metadata signatures checks done for new metadata that was synced down. -- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. -- **ApplicableUpdateInfo** Metadata for the updates which were detected as applicable -- **NumberOfApplicableUpdates** The number of updates which were ultimately deemed applicable to the system after the detection process is complete -- **WebServiceRetryMethods** Web service method requests that needed to be retried to complete operation. -- **BranchReadinessLevel** The servicing branch configured on the device. -- **DeferralPolicySources** Sources for any update deferral policies defined (GPO = 0x10, MDM = 0x100, Flight = 0x1000, UX = 0x10000). -- **DeferredUpdates** Update IDs which are currently being deferred until a later time -- **DriverExclusionPolicy** Indicates if the policy for not including drivers with Windows Update is enabled. -- **FeatureUpdateDeferral** The deferral period configured for feature OS updates on the device (in days). -- **FeatureUpdatePause** Indicates whether feature OS updates are paused on the device. -- **FeatureUpdatePausePeriod** The pause duration configured for feature OS updates on the device (in days). -- **QualityUpdateDeferral** The deferral period configured for quality OS updates on the device (in days). -- **QualityUpdatePause** Indicates whether quality OS updates are paused on the device. -- **QualityUpdatePausePeriod** The pause duration configured for quality OS updates on the device (in days). -- **IntentPFNs** Intended application-set metadata for atomic update scenarios. -- **PausedUpdates** A list of UpdateIds which that currently being paused. -- **PauseFeatureUpdatesEndTime** If feature OS updates are paused on the device, this is the date and time for the end of the pause time window. -- **PauseFeatureUpdatesStartTime** If feature OS updates are paused on the device, this is the date and time for the beginning of the pause time window. -- **PauseQualityUpdatesEndTime** If quality OS updates are paused on the device, this is the date and time for the end of the pause time window. -- **PauseQualityUpdatesStartTime** If quality OS updates are paused on the device, this is the date and time for the beginning of the pause time window. -- **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. -- **TargetMetadataVersion** For self-initiated healing, this is the target version of the SIH engine to download (if needed). If not, the value is null. -- **Context** Gives context on where the error has occurred. Example: AutoEnable, GetSLSData, AddService, Misc, or Unknown -- **DriverSyncPassPerformed** Were drivers scanned this time? +- **RevisionNumber** Unique revision number of Update +- **ServiceGuid** An ID which represents which service the software distribution client is checking for content (Windows Update, Microsoft Store, etc.) +- **StatusCode** Indicates the result of a CheckForUpdates event (success, cancellation, failure code HResult) +- **UpdateId** Unique Update ID +- **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue + + +### SoftwareUpdateClientTelemetry.DownloadHeartbeat + +This event allows tracking of ongoing downloads and contains data to explain the current state of the download + +The following fields are available: + +- **BundleID** Identifier associated with the specific content bundle. If this value is found, it shouldn't report as all zeros +- **BytesTotal** Total bytes to transfer for this content +- **BytesTransferred** Total bytes transferred for this content at the time of heartbeat +- **CallerApplicationName** Name provided by the caller who initiated API calls into the software distribution client +- **ClientVersion** The version number of the software distribution client +- **ConnectionStatus** Indicates the connectivity state of the device at the time of heartbeat +- **CurrentError** Last (transient) error encountered by the active download +- **DownloadFlags** Flags indicating if power state is ignored +- **DownloadState** Current state of the active download for this content (queued, suspended, or progressing) +- **EventType** Possible values are "Child", "Bundle", or "Driver" +- **FlightId** The unique identifier for each flight +- **IsNetworkMetered** Indicates whether Windows considered the current network to be ?metered" +- **MOAppDownloadLimit** Mobile operator cap on size of application downloads, if any +- **MOUpdateDownloadLimit** Mobile operator cap on size of operating system update downloads, if any +- **PowerState** Indicates the power state of the device at the time of heartbeart (DC, AC, Battery Saver, or Connected Standby) +- **RelatedCV** The previous correlation vector that was used by the client, before swapping with a new one +- **ResumeCount** Number of times this active download has resumed from a suspended state +- **RevisionNumber** Identifies the revision number of this specific piece of content +- **ServiceGuid** Identifier for the service to which the software distribution client is connecting (Windows Update, Windows Store, etc) +- **ServiceID** Identifier for the service to which the software distribution client is connecting (Windows Update, Microsoft Store, etc) +- **SuspendCount** Number of times this active download has entered a suspended state +- **SuspendReason** Last reason for why this active download entered a suspended state +- **UpdateId** Identifier associated with the specific piece of content +- **WUDeviceID** Unique device id controlled by the software distribution client ### SoftwareUpdateClientTelemetry.Install @@ -3409,30 +3578,22 @@ The following fields are available: - **BiosSKUNumber** The sku number of the device BIOS. - **BIOSVendor** The vendor of the BIOS. - **BiosVersion** The version of the BIOS. -- **BundleBytesDownloaded** How many bytes were downloaded for the specific content bundle? - **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. - **BundleRepeatFailFlag** Has this particular update bundle previously failed to install? - **BundleRevisionNumber** Identifies the revision number of the content bundle. - **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. - **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. -- **CbsDownloadMethod** Was the download a full download or a partial download? -- **ClientManagedByWSUSServer** Is the client managed by Windows Server Update Services (WSUS)? - **ClientVersion** The version number of the software distribution client. - **CSIErrorType** The stage of CBS installation where it failed. - **CurrentMobileOperator** Mobile operator that device is currently connected to. - **DeviceModel** What is the device model. -- **DeviceOEM** What OEM does this device belong to. -- **DownloadPriority** The priority of the download activity. -- **DownloadScenarioId** A unique ID for a given download used to tie together WU and DO events. - **DriverPingBack** Contains information about the previous driver and system state. -- **Edition** Indicates the edition of Windows being used. - **EventInstanceID** A globally unique identifier for event instance. -- **EventNamespaceID** Indicates whether the event succeeded or failed. Has the format EventType+Event where Event is Succeeded, Cancelled, Failed, etc. - **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started installing content, or whether it was cancelled, succeeded, or failed. - **EventType** Possible values are Child, Bundle, or Driver. - **ExtendedErrorCode** The extended error code. - **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. -- **FeatureUpdatePause** Are feature OS updates paused on the device? +- **FeatureUpdatePause** Indicates whether feature OS updates are paused on the device. - **FlightBranch** The branch that a device is on if participating in the Windows Insider Program. - **FlightBuildNumber** If this installation was for a Windows Insider build, this is the build number of that build. - **FlightId** The specific ID of the Windows Insider build the device is getting. @@ -3441,27 +3602,23 @@ The following fields are available: - **HardwareId** If this install was for a driver targeted to a particular device model, this ID indicates the model of the device. - **HomeMobileOperator** The mobile operator that the device was originally intended to work with. - **IntentPFNs** Intended application-set metadata for atomic update scenarios. -- **IsAOACDevice** Is it Always On, Always Connected? (Mobile device usage model) - **IsDependentSet** Is the driver part of a larger System Hardware/Firmware update? - **IsFinalOutcomeEvent** Does this event signal the end of the update/upgrade process? - **IsFirmware** Is this update a firmware update? - **IsSuccessFailurePostReboot** Did it succeed and then fail after a restart? - **IsWUfBDualScanEnabled** Is Windows Update for Business dual scan enabled on the device? -- **IsWUfBEnabled** Is Windows Update for Business enabled on the device? +- **IsWUfBEnabled** Indicates whether Windows Update for Business is enabled on the device. - **MergedUpdate** Was the OS update and a BSP update merged for installation? - **MsiAction** The stage of MSI installation where it failed. - **MsiProductCode** The unique identifier of the MSI installer. - **PackageFullName** The package name of the content being installed. - **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting being introduced. -- **PlatformRole** The PowerPlatformRole as defined on MSDN. - **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. -- **ProcessorArchitecture** Processor architecture of the system (x86, AMD64, ARM). - **QualityUpdatePause** Are quality OS updates paused on the device? - **RelatedCV** The previous Correlation Vector that was used before swapping with a new one - **RepeatFailFlag** Indicates whether this specific piece of content had previously failed to install. -- **RepeatSuccessInstallFlag** Indicates whether this specific piece of content had previously installed successful, for example if another user had already installed it. - **RevisionNumber** The revision number of this specific piece of content. -- **ServiceGuid** An ID which represents which service the software distribution client is installing content for (Windows Update, Microsoft Store, etc.). +- **ServiceGuid** An ID which represents which service the software distribution client is installing content for (Windows Update, Windows Store, etc.). - **Setup360Phase** If the install is for an operating system upgrade, indicates which phase of the upgrade is underway. - **ShippingMobileOperator** The mobile operator that a device shipped on. - **StatusCode** Indicates the result of an installation event (success, cancellation, failure code HResult). @@ -3471,420 +3628,540 @@ The following fields are available: - **TargetingVersion** For drivers targeted to a specific device model, this is the version number of the drivers being distributed to the device. - **TransactionCode** The ID which represents a given MSI installation - **UpdateId** Unique update ID +- **UpdateID** An identifier associated with the specific piece of content. - **UpdateImportance** Indicates whether a piece of content was marked as Important, Recommended, or Optional. - **UsedSystemVolume** Indicates whether the content was downloaded and then installed from the device's main system storage drive, or an alternate storage drive. - **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. -- **WUSetting** Indicates the user's current updating settings. -### SoftwareUpdateClientTelemetry.DownloadHeartbeat +### SoftwareUpdateClientTelemetry.UpdateDetected -This event allows tracking of ongoing downloads and contains data to explain the current state of the download +This event sends data about an AppX app that has been updated from the Microsoft Store, including what app needs an update and what version/architecture is required, in order to understand and address problems with apps getting required updates. The following fields are available: -- **BundleID** Identifier associated with the specific content bundle. If this value is found, it shouldn't report as all zeros -- **BytesTotal** Total bytes to transfer for this content -- **BytesTransferred** Total bytes transferred for this content at the time of heartbeat -- **ConnectionStatus** Indicates the connectivity state of the device at the time of heartbeat -- **CurrentError** Last (transient) error encountered by the active download -- **DownloadFlags** Flags indicating if power state is ignored -- **DownloadState** Current state of the active download for this content (queued, suspended, or progressing) -- **IsNetworkMetered** "Indicates whether Windows considered the current network to be ?metered""" -- **MOAppDownloadLimit** Mobile operator cap on size of application downloads, if any -- **MOUpdateDownloadLimit** Mobile operator cap on size of operating system update downloads, if any -- **PowerState** Indicates the power state of the device at the time of heartbeart (DC, AC, Battery Saver, or Connected Standby) -- **RelatedCV** "The previous correlation vector that was used by the client, before swapping with a new one " -- **ResumeCount** Number of times this active download has resumed from a suspended state -- **ServiceID** "Identifier for the service to which the software distribution client is connecting (Windows Update, Microsoft Store, etc) " -- **SuspendCount** Number of times this active download has entered a suspended state -- **SuspendReason** Last reason for why this active download entered a suspended state -- **CallerApplicationName** Name provided by the caller who initiated API calls into the software distribution client -- **ClientVersion** The version number of the software distribution client -- **EventType** "Possible values are ""Child"", ""Bundle"", or ""Driver""" -- **FlightId** The unique identifier for each flight -- **RevisionNumber** Identifies the revision number of this specific piece of content -- **ServiceGuid** Identifier for the service to which the software distribution client is connecting (Windows Update, Microsoft Store, etc) -- **UpdateId** "Identifier associated with the specific piece of content " -- **WUDeviceID** "Unique device id controlled by the software distribution client " +- **ApplicableUpdateInfo** Metadata for the updates which were detected as applicable. +- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. +- **IntentPFNs** Intended application-set metadata for atomic update scenarios. +- **NumberOfApplicableUpdates** The number of updates ultimately deemed applicable to the system after the detection process is complete. +- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one. +- **ServiceGuid** An ID that represents which service the software distribution client is connecting to (Windows Update, Windows Store, etc.). +- **WUDeviceID** The unique device ID controlled by the software distribution client. -## Update Assistant Orchestrator events ->[!NOTE] ->Events from this provider are sent with the installation of KB4023814. For details, see [this support article](https://support.microsoft.com/help/4023814). +### SoftwareUpdateClientTelemetry.UpdateMetadataIntegrity + +Ensures Windows Updates are secure and complete. Event helps to identify whether update content has been tampered with and protects against man-in-the-middle attack. + +The following fields are available: + +- **EndpointUrl** The endpoint URL where the device obtains update metadata. This is used to distinguish between test, staging, and production environments. +- **EventScenario** The purpose of this event, such as scan started, scan succeeded, or scan failed. +- **ExtendedStatusCode** The secondary status code of the event. +- **LeafCertId** Integral ID from the FragmentSigning data for certificate that failed. +- **ListOfSHA256OfIntermediateCerData** A semicolon delimited list of base64 encoding of hashes for the Base64CerData in the FragmentSigning data of an intermediate certificate. +- **MetadataIntegrityMode** The mode of the transport metadata integrity check. 0 = unknown; 1 = ignore; 2 = audit; 3 = enforce +- **MetadataSignature** A base64-encoded string of the signature associated with the update metadata (specified by revision ID). +- **RawMode** The raw unparsed mode string from the SLS response. This field is null if not applicable. +- **RawValidityWindowInDays** The raw unparsed validity window string in days of the timestamp token. This field is null if not applicable. +- **RevisionId** The revision ID for a specific piece of content. +- **RevisionNumber** The revision number for a specific piece of content. +- **ServiceGuid** Identifies the service to which the software distribution client is connected, Example: Windows Update or Windows Store +- **SHA256OfLeafCerData** A base64 encoding of the hash for the Base64CerData in the FragmentSigning data of the leaf certificate. +- **SHA256OfLeafCertPublicKey** A base64 encoding of the hash of the Base64CertData in the FragmentSigning data of the leaf certificate. +- **SHA256OfTimestampToken** A base64-encoded string of hash of the timestamp token blob. +- **SignatureAlgorithm** The hash algorithm for the metadata signature. +- **SLSPrograms** A test program to which a device may have opted in. Example: Insider Fast +- **StatusCode** The status code of the event. +- **TimestampTokenCertThumbprint** The thumbprint of the encoded timestamp token. +- **TimestampTokenId** The time this was created. It is encoded in a timestamp blob and will be zero if the token is malformed. +- **UpdateId** The update ID for a specific piece of content. +- **ValidityWindowInDays** The validity window that's in effect when verifying the timestamp. + + +## Update Assistant events ### Microsoft.Windows.UpdateAssistant.Orchestrator.BlockingEventId -Event sends basic info on the reason that Windows 10 was not updated due to compatibility issues, previous rollbacks, or admin policies.. +The event sends basic info on the reason that Windows 10 was not updated due to compatibility issues, previous rollbacks, or admin policies. The following fields are available: -- **ApplicabilityBlockedReason** Blocked due to an applicability issue. -- **ClientId** Identification of the current installed version of Update Assistant. -- **TriggerTaskSource** Describes which task launched this instance of Update Assistant. +- **ApplicabilityBlockedReason** Blocked due to an applicability issue. +- **BlockWuUpgrades** The upgrade assistant is currently blocked. +- **clientID** An identification of the current release of Update Assistant. +- **CloverTrail** This device is Clovertrail. +- **DeviceIsMdmManaged** This device is MDM managed. +- **IsNetworkAvailable** If the device network is not available. +- **IsNetworkMetered** If network is metered. +- **IsSccmManaged** This device is SCCM managed. +- **NewlyInstalledOs** OS is newly installed quiet period. +- **PausedByPolicy** Updates are paused by policy. +- **RecoveredFromRS3** Previously recovered from RS3. +- **RS1UninstallActive** Blocked due to an active RS1 uninstall. +- **RS3RollBacks** Exceeded number of allowable RS3 rollbacks. +- **triggerTaskSource** Describe which task launches this instance. +- **WsusManaged** This device is WSUS managed. +- **ZeroExhaust** This device is zero exhaust. + ### Microsoft.Windows.UpdateAssistant.Orchestrator.DeniedLaunchEventId -Event sends basic info on the reason the Windows 10 update was blocked or prevented. +The event sends basic info when a device was blocked or prevented from updating to the latest Windows 10 version. The following fields are available: -- **ClientId** Identification of the current installed version of Update Assistant. -- **DenyReason** Reasons why Update Assistant was prevented from launching. -- **TriggerTaskSource** Describes which task launched this instance of Update Assistant. +- **calendarRun** Indicates the calendar run task invoked the update assistant wrapper. +- **clientID** An identification of the current release of Update Assistant. +- **denyReason** All the reasons why the Update Assistant was prevented from launching. Bitmask with values from UpdateAssistant.cpp eUpgradeModeReason. +- **triggerTaskSource** Describe which task launches this instance. + ### Microsoft.Windows.UpdateAssistant.Orchestrator.FailedLaunchEventId -Event sends basic info when the Windows 10 Update Assistant tool could not be launched due to an error.. +Event to mark that Update Assistant Orchestrator failed to launch Update Assistant. The following fields are available: -- **ClientId** Identification of the current installed version of Update Assistant. -- **HResult** Error code of the Update Assistant Orchestrator error. -- **TriggerTaskSource** Describes which task launched this instance of Update Assistant. +- **clientID** An identification of the current release of Update Assistant. +- **hResult** Error code of the Update Assistant Orchestrator failure. +- **triggerTaskSource** Describe which task launches this instance. + ### Microsoft.Windows.UpdateAssistant.Orchestrator.FailedOneSettingsQueryEventId -Event sends basic info to signal when the settings related to the Windows 10 update could not be downloaded. +Event indicating One Settings was not queried by update assistant. The following fields are available: -- **ClientId** Identification of the current installed version of Update Assistant. -- **HResult** Error code of the attempted query for the settings. +- **clientID** An identification of the current release of Update Assistant. +- **hResult** Error code of One Settings query failure. + ### Microsoft.Windows.UpdateAssistant.Orchestrator.LaunchEventId -Event sends basic info on whether the device should or should not be updated to the latest Windows 10 version. +This event sends basic information on whether the device should be updated to the latest Windows 10 version. The following fields are available: -- **ClientId** Identification of the current installed version of Update Assistant. -- **LaunchMode** Type of launch performed. -- **LaunchTypeReason** All of the reasons for the type of launch performed. -- **TriggerTaskSource** Describes which task launched this instance of Update Assistant. -- **UALaunchRunCount** Total number of times Update Assistant was launched. +- **autoStartRunCount** The auto start run count of Update Assistant. +- **clientID** The ID of the current release of Update Assistant. +- **launchMode** Indicates the type of launch performed. +- **launchTypeReason** A bitmask of all the reasons for type of launch. +- **triggerTaskSource** Indicates which task launches this instance. +- **UALaunchRunCount** Total number of times Update Assistant launched. + ### Microsoft.Windows.UpdateAssistant.Orchestrator.RestoreEventId -Event sends basic info on whether the Windows 10 update notification had launched previously. +The event sends basic info on whether the Windows 10 update notification has previously launched. The following fields are available: -- **ClientId** Identification of the current installed version of Update Assistant. -- **RestoreReason** All of the reasons for being restored. -- **TriggerTaskSource** Describes which task launched this instance of Update Assistant. +- **calendarRun** Indicates the update assistant wrapper was started by the calendar run task. +- **clientID** ID of the current release of Update Assistant. +- **restoreReason** All the reasons for the restore. +- **triggerTaskSource** Indicates which task launches this instance. + ## Update events -### Update360Telemetry.UpdateAgentPostRebootResult +### Update360Telemetry.UpdateAgentCommit -This event collects information for both Mobile and Desktop regarding the post reboot phase of the new UUP (Unified Update Platform) update scenario - -The following fields are available: - -- **ErrorCode** The error code returned for the current post reboot phase -- **FlightId** The unique identifier for each flight -- **ObjectId** Unique value for each Update Agent mode -- **RelatedCV** Correlation vector value generated from the latest USO scan -- **Result** Indicates the Hresult -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **SessionId** Unique value for each Update Agent mode attempt -- **UpdateId** Unique ID for each update -- **PostRebootResult** Indicates the Hresult - - -### Update360Telemetry.UpdateAgent_Initialize - -This event sends data during the initialize phase of updating Windows. - -The following fields are available: - -- **ErrorCode** The error code returned for the current initialize phase. -- **FlightId** Unique ID for each flight. -- **FlightMetadata** Contains the FlightId and the build being flighted. -- **ObjectId** Unique value for each Update Agent mode. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **SessionData** Contains instructions to update agent for processing FODs and DUICs (Null for other scenarios). -- **SessionId** Unique value for each Update Agent mode attempt . -- **UpdateId** Unique ID for each update. -- **Result** Result of the initialize phase of update. 0 = Succeeded, 1 = Failed, 2 = Cancelled, 3 = Blocked, 4 = BlockCancelled - - -### Update360Telemetry.UpdateAgent_DownloadRequest - -This event sends data during the download request phase of updating Windows. - -The following fields are available: - -- **ErrorCode** The error code returned for the current download request phase. -- **ObjectId** Unique value for each Update Agent mode. -- **PackageCountOptional** Number of optional packages requested. -- **PackageCountRequired** Number of required packages requested. -- **PackageCountTotal** Total number of packages needed. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **SessionId** Unique value for each Update Agent mode attempt. -- **PackageSizeCanonical** Size of canonical packages in bytes -- **PackageSizeDiff** Size of diff packages in bytes -- **PackageSizeExpress** Size of express packages in bytes -- **Result** Result of the download request phase of update. -- **FlightId** Unique ID for each flight. -- **UpdateId** Unique ID for each update. -- **PackageCountTotalCanonical** Total number of canonical packages. -- **PackageCountTotalDiff** Total number of diff packages. -- **PackageCountTotalExpress** Total number of express packages. -- **DeletedCorruptFiles** Indicates if UpdateAgent found any corrupt payload files and whether the payload was deleted. -- **RangeRequestState** Represents the state of the download range request. - - -### Update360Telemetry.UpdateAgent_Install - -This event sends data during the install phase of updating Windows. +This event collects information regarding the commit phase of the new Unified Update Platform (UUP) update scenario, which is leveraged by both Mobile and Desktop. The following fields are available: - **ErrorCode** The error code returned for the current install phase. -- **ObjectId** Unique value for each Update Agent mode. -- **RelatedCV** Correlation vector value generated from the latest scan. -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **SessionId** Unique value for each Update Agent mode attempt. -- **Result** "Result of the install phase of update. 0 = Succeeded 1 = Failed, 2 = Cancelled, 3 = Blocked, 4 = BlockCancelled " - **FlightId** Unique ID for each flight. +- **ObjectId** Unique value for each Update Agent mode. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **Result** Outcome of the install phase of the update. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. - **UpdateId** Unique ID for each update. -### Update360Telemetry.UpdateAgent_ModeStart +### Update360Telemetry.UpdateAgentDownloadRequest -This event sends data for the start of each mode during the process of updating Windows. +This event sends data for the download request phase of updating Windows via the new Unified Update Platform (UUP) scenario. Applicable to PC and Mobile. The following fields are available: -- **Mode** Indicates that the Update Agent mode that has started. 1 = Initialize, 2 = DownloadRequest, 3 = Install, 4 = Commit -- **ObjectId** Unique value for each Update Agent mode. -- **RelatedCV** The correlation vector value generated from the latest scan. -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **SessionId** Unique value for each Update Agent mode attempt. +- **DeletedCorruptFiles** Boolean indicating whether corrupt payload was deleted. +- **DownloadRequests** Number of times a download was retried. +- **ErrorCode** The error code returned for the current download request phase. +- **ExtensionName** Indicates whether the payload is related to Operating System content or a plugin. - **FlightId** Unique ID for each flight. -- **UpdateId** Unique ID for each update. +- **InternalFailureResult** Indicates a non-fatal error from a plugin. +- **ObjectId** Unique value for each Update Agent mode (same concept as InstanceId for Setup360). +- **PackageCountOptional** # of optional packages requested. +- **PackageCountRequired** # of required packages requested. +- **PackageCountTotal** Total # of packages needed. +- **PackageCountTotalCanonical** Total number of canonical packages. +- **PackageCountTotalDiff** Total number of diff packages. +- **PackageCountTotalExpress** Total number of express packages. +- **PackageExpressType** Type of express package. +- **PackageSizeCanonical** Size of canonical packages in bytes. +- **PackageSizeDiff** Size of diff packages in bytes. +- **PackageSizeExpress** Size of express packages in bytes. +- **RangeRequestState** Indicates the range request type used. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **Result** Outcome of the download request phase of update. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each attempt (same value for initialize, download, install commit phases). +- **UpdateId** Unique ID for each Update. -### Update360Telemetry.UpdateAgent_SetupBoxLaunch +### Update360Telemetry.UpdateAgentExpand -This event sends data during the launching of the setup box when updating Windows. +This event collects information regarding the expansion phase of the new Unified Update Platform (UUP) update scenario, which is leveraged by both Mobile and Desktop. The following fields are available: -- **ObjectId** Unique value for each Update Agent mode. -- **Quiet** Indicates whether setup is running in quiet mode. 0 = false 1 = true -- **RelatedCV** Correlation vector value generated from the latest scan. -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **SessionId** Unique value for each Update Agent mode attempt. +- **ElapsedTickCount** Time taken for expand phase. +- **EndFreeSpace** Free space after expand phase. +- **EndSandboxSize** Sandbox size after expand phase. +- **ErrorCode** The error code returned for the current install phase. - **FlightId** Unique ID for each flight. +- **ObjectId** Unique value for each Update Agent mode. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. +- **StartFreeSpace** Free space before expand phase. +- **StartSandboxSize** Sandbox size after expand phase. +- **UpdateId** Unique ID for each Update. + + +### Update360Telemetry.UpdateAgentFellBackToCanonical + +This event collects information when express could not be used and we fall back to canonical during the new Unified Update Platform (UUP) update scenario, which is leveraged by both Mobile and Desktop. + +The following fields are available: + +- **FlightId** Unique ID for each flight. +- **ObjectId** Unique value for each Update Agent mode. +- **PackageCount** Number of packages that feel back to canonical. +- **PackageList** PackageIds which fell back to canonical. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. - **UpdateId** Unique ID for each update. -- **SetupMode** Setup mode 1 = predownload, 2 = install, 3 = finalize -- **SandboxSize** The size of the sandbox folder on the device. + + +### Update360Telemetry.UpdateAgentInitialize + +This event sends data for the initialize phase of updating Windows via the new Unified Update Platform (UUP) scenario, which is applicable to both PCs and Mobile. + +The following fields are available: + +- **ErrorCode** The error code returned for the current install phase. +- **FlightId** Unique ID for each flight. +- **FlightMetadata** Contains the FlightId and the build being flighted. +- **ObjectId** Unique value for each Update Agent mode. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **Result** Outcome of the install phase of the update. +- **ScenarioId** Indicates the update scenario. +- **SessionData** String containing instructions to update agent for processing FODs and DUICs (Null for other scenarios). +- **SessionId** Unique value for each update attempt. +- **UpdateId** Unique ID for each update. + + +### Update360Telemetry.UpdateAgentInstall + +This event sends data for the install phase of updating Windows. + +The following fields are available: + +- **ErrorCode** The error code returned for the current install phase. +- **FlightId** Unique value for each Update Agent mode (same concept as InstanceId for Setup360). +- **ObjectId** Correlation vector value generated from the latest USO scan. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **Result** The result for the current install phase. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. +- **UpdateId** Unique ID for each update. + + +### Update360Telemetry.UpdateAgentMerge + +The UpdateAgentMerge event sends data on the merge phase when updating Windows. + +The following fields are available: + +- **ErrorCode** The error code returned for the current merge phase. +- **FlightId** Unique ID for each flight. +- **ObjectId** Unique value for each Update Agent mode. +- **RelatedCV** Related correlation vector value. +- **Result** Outcome of the merge phase of the update. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each attempt. +- **UpdateId** Unique ID for each update. + + +### Update360Telemetry.UpdateAgentMitigationResult + +This event sends data indicating the result of each update agent mitigation. + +The following fields are available: + +- **Applicable** Indicates whether the mitigation is applicable for the current update. +- **CommandCount** The number of command operations in the mitigation entry. +- **CustomCount** The number of custom operations in the mitigation entry. +- **FileCount** The number of file operations in the mitigation entry. +- **FlightId** Unique identifier for each flight. +- **Index** The mitigation index of this particular mitigation. +- **MitigationScenario** The update scenario in which the mitigation was executed. +- **Name** The friendly name of the mitigation. +- **ObjectId** Unique value for each Update Agent mode. +- **OperationIndex** The mitigation operation index (in the event of a failure). +- **OperationName** The friendly name of the mitigation operation (in the event of failure). +- **RegistryCount** The number of registry operations in the mitigation entry. +- **RelatedCV** The correlation vector value generated from the latest USO scan. +- **Result** The HResult of this operation. +- **ScenarioId** The update agent scenario ID. +- **SessionId** Unique value for each update attempt. +- **TimeDiff** The amount of time spent performing the mitigation (in 100-nanosecond increments). +- **UpdateId** Unique ID for each Update. + + +### Update360Telemetry.UpdateAgentMitigationSummary + +This event sends a summary of all the update agent mitigations available for an this update. + +The following fields are available: + +- **Applicable** The count of mitigations that were applicable to the system and scenario. +- **Failed** The count of mitigations that failed. +- **FlightId** Unique identifier for each flight. +- **MitigationScenario** The update scenario in which the mitigations were attempted. +- **ObjectId** The unique value for each Update Agent mode. +- **RelatedCV** The correlation vector value generated from the latest USO scan. +- **Result** The HResult of this operation. +- **ScenarioId** The update agent scenario ID. +- **SessionId** Unique value for each update attempt. +- **TimeDiff** The amount of time spent performing all mitigations (in 100-nanosecond increments). +- **Total** Total number of mitigations that were available. +- **UpdateId** Unique ID for each update. + + +### Update360Telemetry.UpdateAgentModeStart + +This event sends data for the start of each mode during the process of updating Windows via the new Unified Update Platform (UUP) scenario. Applicable to both PCs and Mobile. + +The following fields are available: + +- **FlightId** Unique ID for each flight. +- **Mode** Indicates the mode that has started. +- **ObjectId** Unique value for each Update Agent mode. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. +- **UpdateId** Unique ID for each update. +- **Version** Version of update + + +### Update360Telemetry.UpdateAgentPostRebootResult + +This event collects information for both Mobile and Desktop regarding the post reboot phase of the new Unified Update Platform (UUP) update scenario. + +The following fields are available: + +- **ErrorCode** The error code returned for the current post reboot phase. +- **FlightId** The specific ID of the Windows Insider build the device is getting. +- **ObjectId** Unique value for each Update Agent mode. +- **PostRebootResult** Indicates the Hresult. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **Result** Indicates the Hresult +- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate. +- **SessionId** Unique value for each update attempt. +- **UpdateId** Unique ID for each update. + + +### Update360Telemetry.UpdateAgentSetupBoxLaunch + +The UpdateAgent_SetupBoxLaunch event sends data for the launching of the setup box when updating Windows via the new Unified Update Platform (UUP) scenario. This event is only applicable to PCs. + +The following fields are available: + +- **ContainsExpressPackage** Indicates whether the download package is express. +- **FlightId** Unique ID for each flight. +- **FreeSpace** Free space on OS partition. +- **InstallCount** Number of install attempts using the same sandbox. +- **ObjectId** Unique value for each Update Agent mode. +- **Quiet** Indicates whether setup is running in quiet mode. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **SandboxSize** Size of the sandbox. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. +- **SetupMode** Mode of setup to be launched. +- **UpdateId** Unique ID for each update. +- **UserSession** Indicates whether install was invoked by user actions. ## Update notification events ### Microsoft.Windows.UpdateNotificationPipeline.JavascriptJavascriptCriticalGenericMessage -This event indicates that Javascript is reporting a schema and a set of values for critical diagnostic data. +This event indicates that Javascript is reporting a schema and a set of values for critical telemetry. The following fields are available: -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Currently campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP -- **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user +- **CampaignConfigVersion** Configuration version of the current campaign. +- **CampaignID** ID of the currently running campaign. +- **ConfigCatalogVersion** Current catalog version of the update notification. +- **ContentVersion** Content version of the current update notification campaign. +- **CV** Correlation vector. +- **DetectorVersion** Most recently run detector version for the current campaign. +- **GlobalEventCounter** Client side counter that indicates the ordering of events sent by this user. - **key1** Interaction data for the UI -- **key10** Interaction data for the UI -- **key11** Interaction data for the UI -- **key12** Interaction data for the UI -- **key13** Interaction data for the UI -- **key14** Interaction data for the UI -- **key15** Interaction data for the UI -- **key16** Interaction data for the UI -- **key17** Interaction data for the UI -- **key18** Interaction data for the UI -- **key19** Interaction data for the UI +- **key10** UI interaction data +- **key11** UI interaction data +- **key12** UI interaction data +- **key13** UI interaction data +- **key14** UI interaction data +- **key15** UI interaction data +- **key16** UI interaction data +- **key17** UI interaction data +- **key18** UI interaction data +- **key19** UI interaction data - **key2** Interaction data for the UI -- **key20** Interaction data for the UI +- **key20** UI interaction data - **key21** Interaction data for the UI -- **key22** Interaction data for the UI -- **key23** Interaction data for the UI -- **key24** Interaction data for the UI -- **key25** Interaction data for the UI -- **key26** Interaction data for the UI -- **key27** Interaction data for the UI -- **key28** Interaction data for the UI -- **key29** Interaction data for the UI +- **key22** UI interaction data +- **key23** UI interaction data +- **key24** UI interaction data +- **key25** UI interaction data +- **key26** UI interaction data +- **key27** UI interaction data +- **key28** UI interaction data +- **key29** UI interaction data - **key3** Interaction data for the UI -- **key30** Interaction data for the UI +- **key30** UI interaction data - **key4** Interaction data for the UI -- **key5** Interaction data for the UI -- **key6** Interaction data for the UI +- **key5** UI interaction data +- **key6** UI interaction data - **key7** Interaction data for the UI - **key8** Interaction data for the UI -- **key9** Interaction data for the UI -- **PackageVersion** Current package version of UNP -- **schema** Type of UI interaction +- **key9** UI interaction data +- **PackageVersion** Current package version of the update notification. +- **schema** UI interaction type. ### Microsoft.Windows.UpdateNotificationPipeline.UNPCampaignHeartbeat -This event is sent at the start of each campaign, to be used as a heartbeat +This event is sent at the start of each campaign, to be used as a heartbeat. The following fields are available: -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Currently campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP -- **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user -- **PackageVersion** Current UNP package version +- **CampaignConfigVersion** Configuration version for the current campaign. +- **CampaignID** Current campaign that is running on Update Notification Pipeline. +- **ConfigCatalogVersion** Current catalog version of Update Notification Pipeline. +- **ContentVersion** Content version for the current campaign on Update Notification Pipeline. +- **CV** Correlation vector. +- **DetectorVersion** Most recently run detector version for the current campaign on Update Notification Pipeline. +- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user. +- **PackageVersion** Current package version for Update Notification Pipeline. ### Microsoft.Windows.UpdateNotificationPipeline.UNPCampaignManagerCleaningCampaign -This event indicates that the Campaign Manager is cleaning up the campaign content +This event indicates that the Campaign Manager is cleaning up the campaign content. The following fields are available: -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Current campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP +- **CampaignConfigVersion** Configuration version for the current campaign. +- **CampaignID** The current campaign that is running on Update Notification Pipeline (UNP). +- **ConfigCatalogVersion** The current catalog version of the Update Notification Pipeline (UNP). +- **ContentVersion** Content version for the current campaign on UNP. - **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user -- **PackageVersion** Current UNP package version +- **DetectorVersion** Most recently run detector version for the current campaign on UNP. +- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user. +- **PackageVersion** Current UNP package version. ### Microsoft.Windows.UpdateNotificationPipeline.UnpCampaignManagerGetIsCamppaignCompleteFailed -This event is sent when a campaign completion status query fails +This event is sent when a campaign completion status query fails. The following fields are available: -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Current campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP -- **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user -- **hresult** HRESULT of the failure -- **PackageVersion** Current UNP package version +- **CampaignConfigVersion** Configuration version for the current campaign. +- **CampaignID** Current campaign that is running on Update Notification Pipeline (UNP). +- **ConfigCatalogVersion** Current catalog version of UNP. +- **ContentVersion** Content version for the current campaign on UNP. +- **CV** Correlation vector. +- **DetectorVersion** Most recently run detector version for the current campaign on UNP. +- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user. +- **hresult** HRESULT of the failure. +- **PackageVersion** Current UNP package version. ### Microsoft.Windows.UpdateNotificationPipeline.UNPCampaignManagerHeartbeat -This event is sent at the start of the CampaignManager event and is intended to be used as a heartbeat +This event is sent at the start of the CampaignManager event and is intended to be used as a heartbeat. The following fields are available: -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Currently campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP -- **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user -- **PackageVersion** Current UNP package version +- **CampaignConfigVersion** Configuration version for the current campaign. +- **CampaignID** Currently campaign that is running on Update Notification Pipeline (UNP). +- **ConfigCatalogVersion** Current catalog version of UNP. +- **ContentVersion** Content version for the current campaign on UNP. +- **CV** Correlation vector. +- **DetectorVersion** Most recently run detector version for the current campaign on UNP. +- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user. +- **PackageVersion** Current UNP package version. ### Microsoft.Windows.UpdateNotificationPipeline.UnpCampaignManagerRunCampaignFailed -This event is sent when the Campaign Manager encounters an unexpected error while running the campaign +This event is sent when the Campaign Manager encounters an unexpected error while running the campaign. The following fields are available: -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Currently campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP -- **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user -- **hresult** HRESULT of the failure#N# -- **PackageVersion** Current UNP package version +- **CampaignConfigVersion** Configuration version for the current campaign. +- **CampaignID** Currently campaign that's running on Update Notification Pipeline (UNP). +- **ConfigCatalogVersion** Current catalog version of UNP. +- **ContentVersion** Content version for the current campaign on UNP. +- **CV** Correlation vector. +- **DetectorVersion** Most recently run detector version for the current campaign on UNP. +- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user. +- **hresult** HRESULT of the failure. +- **PackageVersion** Current UNP package version. ## Upgrade events -### Setup360Telemetry.PreDownloadUX +### FacilitatorTelemetry.DCATDownload -The event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, the Setup360Telemetry.PredownloadUX indicates the outcome of the PredownloadUX portion of the update process. +This event indicates whether devices received additional or critical supplemental content during an OS Upgrade, to help keep Windows up-to-date and secure. + + + +### Setup360Telemetry.Downlevel + +This event sends data indicating that the device has started the downlevel phase of the upgrade, to help keep Windows up-to-date and secure. The following fields are available: -- **ClientId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. -- **HostOSBuildNumber** The build number of the previous operating system. -- **HostOsSkuName** The OS edition which is running the Setup360 instance (previous operating system). -- **InstanceId** Unique GUID that identifies each instance of setuphost.exe. -- **ReportId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback -- **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type. Examplle: Boot, Media, Update, MCT +- **ClientId** If using Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, the default value is Media360, but it can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the downlevel OS. +- **HostOsSkuName** The operating system edition which is running Setup360 instance (downlevel OS). +- **InstanceId** A unique GUID that identifies each instance of setuphost.exe. +- **ReportId** In the Windows Update scenario, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. +- **Setup360Extended** More detailed information about phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360 (for example, Predownload, Install, Finalize, Rollback). +- **Setup360Result** The result of Setup360 (HRESULT used to diagnose errors). +- **Setup360Scenario** The Setup360 flow type (for example, Boot, Media, Update, MCT). - **SetupVersionBuildNumber** The build number of Setup360 (build number of the target OS). -- **State** The exit state of the Setup360 run. Example: succeeded, failed, blocked, cancelled -- **TestId** A string to uniquely identify a group of events. -- **WuId** Windows Update client ID. - - -### Setup360Telemetry.UnexpectedEvent - -This event sends data indicating that the device has invoked the unexpected event phase of the upgrade, to help keep Windows up to date. - -The following fields are available: - -- **ClientId** With Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. -- **HostOSBuildNumber** The build number of the previous OS. -- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). -- **InstanceId** A unique GUID that identifies each instance of setuphost.exe -- **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback -- **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT -- **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **TestId** A string to uniquely identify a group of events. -- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. - - -### Setup360Telemetry.PreInstallQuiet - -This event sends data indicating that the device has invoked the preinstall quiet phase of the upgrade, to help keep Windows up to date. - -The following fields are available: - -- **ClientId** With Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. -- **HostOSBuildNumber** The build number of the previous OS. -- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). -- **InstanceId** A unique GUID that identifies each instance of setuphost.exe -- **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback etc. -- **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. -- **Setup360Scenario** Setup360 flow type (Boot, Media, Update, MCT) -- **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **TestId** A string to uniquely identify a group of events. -- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. +- **State** Exit state of given Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** An ID that uniquely identifies a group of events. +- **WuId** This is the Windows Update Client ID. In the Windows Update scenario, this is the same as the clientId. ### Setup360Telemetry.Finalize -This event sends data indicating that the device has invoked the finalize phase of the upgrade, to help keep Windows up-to-date. +This event sends data indicating that the device has started the phase of finalizing the upgrade, to help keep Windows up-to-date and secure. The following fields are available: @@ -3893,19 +4170,40 @@ The following fields are available: - **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe - **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** d +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. - **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **TestId** A string to uniquely identify a group of events. +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** ID that uniquely identifies a group of events. - **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. +### Setup360Telemetry.OsUninstall + +This event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, it indicates the outcome of an OS uninstall. + +The following fields are available: + +- **ClientId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the previous OS. +- **HostOsSkuName** The OS edition which is running the Setup360 instance (previous OS). +- **InstanceId** A unique GUID that identifies each instance of setuphost.exe. +- **ReportId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, this is the GUID for the install.wim. +- **Setup360Extended** Detailed information about the phase or action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. +- **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT +- **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). +- **State** Exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** A string to uniquely identify a group of events. +- **WuId** Windows Update client ID. + + ### Setup360Telemetry.PostRebootInstall -This event sends data indicating that the device has invoked the postrebootinstall phase of the upgrade, to help keep Windows up-to-date. +This event sends data indicating that the device has invoked the post reboot install phase of the upgrade, to help keep Windows up-to-date. The following fields are available: @@ -3933,63 +4231,63 @@ The following fields are available: - **ClientId** Using Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. - **HostOSBuildNumber** The build number of the previous OS. - **HostOsSkuName** The OS edition which is running Setup360 instance (previous operating system). -- **InstanceId** A unique GUID that identifies each instance of setuphost.exe +- **InstanceId** A unique GUID that identifies each instance of setuphost.exe. - **ReportId** Using Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, canceled -- **TestId** A string to uniquely identify a group of events. +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, canceled. +- **TestId** ID that uniquely identifies a group of events. - **WuId** This is the Windows Update Client ID. Using Windows Update, this is the same as the clientId. -### Setup360Telemetry.OsUninstall +### Setup360Telemetry.PreDownloadUX -The event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, the Setup360Telemetry.OSUninstall indicates the outcome of an OS uninstall. +This event sends data regarding OS Updates and Upgrades from Windows 7.X, Windows 8.X, Windows 10 and RS, to help keep Windows up-to-date and secure. Specifically, it indicates the outcome of the PredownloadUX portion of the update process. The following fields are available: - **ClientId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. -- **HostOSBuildNumber** The build number of the previous OS. -- **HostOsSkuName** The OS edition which is running the Setup360 instance (previous OS). -- **InstanceId** A unique GUID that identifies each instance of setuphost.exe. +- **HostOSBuildNumber** The build number of the previous operating system. +- **HostOsSkuName** The OS edition which is running the Setup360 instance (previous operating system). +- **InstanceId** Unique GUID that identifies each instance of setuphost.exe. - **ReportId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback -- **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT -- **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** Exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. +- **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. +- **SetupVersionBuildNumber** The build number of Setup360 (build number of the target OS). +- **State** The exit state of the Setup360 run. Example: succeeded, failed, blocked, cancelled. - **TestId** A string to uniquely identify a group of events. - **WuId** Windows Update client ID. -### Setup360Telemetry.Downlevel +### Setup360Telemetry.PreInstallQuiet -This event sends data indicating that the device has invoked the downlevel phase of the upgrade. It's used to help keep Windows up-to-date and secure. +This event sends data indicating that the device has invoked the preinstall quiet phase of the upgrade, to help keep Windows up-to-date. The following fields are available: -- **ClientId** If using Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, the default value is Media360, but it can be overwritten by the caller to a unique value. -- **HostOSBuildNumber** The build number of the downlevel OS. -- **HostOsSkuName** The operating system edition which is running Setup360 instance (downlevel OS). -- **InstanceId** A unique GUID that identifies each instance of setuphost.exe. -- **ReportId** In the Windows Update scenario, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback -- **Setup360Result** The result of Setup360. It's an HRESULT error code that can be used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT -- **SetupVersionBuildNumber** The build number of Setup360 (build number of the target OS). -- **State** Exit state of given Setup360 run. Example: succeeded, failed, blocked, cancelled -- **TestId** A string that uniquely identifies a group of events. -- **WuId** This is the Windows Update Client ID. In the Windows Update scenario, this is the same as the clientId. +- **ClientId** With Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the previous OS. +- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). +- **InstanceId** A unique GUID that identifies each instance of setuphost.exe +- **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. +- **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. +- **Setup360Scenario** Setup360 flow type (Boot, Media, Update, MCT). +- **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** A string to uniquely identify a group of events. +- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. ### Setup360Telemetry.PreInstallUX -This event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, the Setup360Telemetry.PreinstallUX indicates the outcome of the PreinstallUX portion of the update process. +This event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10, to help keep Windows up-to-date. Specifically, it indicates the outcome of the PreinstallUX portion of the update process. The following fields are available: @@ -3998,12 +4296,12 @@ The following fields are available: - **HostOsSkuName** The OS edition which is running the Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe. - **ReportId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type, Example: Boot, Media, Update, MCT +- **Setup360Scenario** The Setup360 flow type, Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. - **TestId** A string to uniquely identify a group of events. - **WuId** Windows Update client ID. @@ -4014,37 +4312,56 @@ This event sends data about OS deployment scenarios, to help keep Windows up-to- The following fields are available: +- **ClientId** Retrieves the upgrade ID. In the Windows Update scenario, this will be the Windows Update client ID. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. - **FieldName** Retrieves the data point. - **FlightData** Specifies a unique identifier for each group of Windows Insider builds. - **InstanceId** Retrieves a unique identifier for each instance of a setup session. - **ReportId** Retrieves the report ID. - **ScenarioId** Retrieves the deployment scenario. - **Value** Retrieves the value associated with the corresponding FieldName. -- **ClientId** Retrieves the upgrade ID: Upgrades via Windows Update - specifies the WU clientID. All other deployment - static string. -## Windows as a Service diagnostic events +### Setup360Telemetry.Setup360DynamicUpdate -### Microsoft.Windows.WaaSMedic.SummaryEvent +This event helps determine whether the device received supplemental content during an operating system upgrade, to help keep Windows up-to-date. -This event provides the results from the WaaSMedic engine + + +### Setup360Telemetry.Setup360MitigationResult + +This event sends data indicating the result of each setup mitigation. + + + +### Setup360Telemetry.Setup360MitigationSummary + +This event sends a summary of all the setup mitigations available for this update. + + + +### Setup360Telemetry.UnexpectedEvent + +This event sends data indicating that the device has invoked the unexpected event phase of the upgrade, to help keep Windows up to date. The following fields are available: -- **detectionSummary** Result of each detection that ran -- **featureAssessmentImpact** Windows as a Service (WaaS) Assessment impact on feature updates -- **insufficientSessions** True, if the device has enough activity to be eligible for update diagnostics. False, if otherwise -- **isManaged** Indicates the device is managed for updates -- **isWUConnected** Indicates the device is connected to Windows Update -- **noMoreActions** All available WaaSMedic diagnostics have run. There are no pending diagnostics and corresponding actions -- **qualityAssessmentImpact** Windows as a Service (WaaS) Assessment impact for quality updates -- **remediationSummary** Result of each operation performed on a device to fix an invalid state or configuration that's preventing the device from getting updates. For example, if Windows Update service is turned off, the fix is to turn the it back on -- **usingBackupFeatureAssessment** The WaaSMedic engine contacts Windows as a Service (WaaS) Assessment to determine whether the device is up-to-date. If WaaS Assessment isn't available, the engine falls back to backup feature assessments, which are determined programmatically on the client#N# -- **usingBackupQualityAssessment** The WaaSMedic engine contacts Windows as a Service (WaaS) Assessment to determine whether the device is up-to-date. If WaaS Assessment isn't available, the engine falls back to backup quality assessments, which are determined programmatically on the client#N# -- **versionString** Installed version of the WaaSMedic engine -- **hrEngineResult** Indicates the WaaSMedic engine operation error codes +- **ClientId** With Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **HostOSBuildNumber** The build number of the previous OS. +- **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). +- **InstanceId** A unique GUID that identifies each instance of setuphost.exe +- **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. +- **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used used to diagnose errors. +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. +- **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** A string to uniquely identify a group of events. +- **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. +## Windows as a Service diagnostic events + ### Microsoft.Windows.WaaSMedic.Summary This event provides the results of the WaaSMedic diagnostic run @@ -4052,39 +4369,45 @@ This event provides the results of the WaaSMedic diagnostic run The following fields are available: - **detectionSummary** Result of each detection that ran -- **remediationSummary** Result of each operation performed on a device to fix an invalid state or configuration that's preventing the device from getting updates. For example, if Windows Update service is turned off, the fix is to turn the it back on -- **versionString** Installed version of the WaaSMedic engine - **featureAssessmentImpact** Windows as a Service (WaaS) Assessment impact on feature updates - **insufficientSessions** True, if the device has enough activity to be eligible for update diagnostics. False, if otherwise - **isManaged** Indicates the device is managed for updates - **isWUConnected** Indicates the device is connected to Windows Update - **noMoreActions** All available WaaSMedic diagnostics have run. There are no pending diagnostics and corresponding actions - **qualityAssessmentImpact** Windows as a Service (WaaS) Assessment impact for quality updates +- **remediationSummary** Result of each operation performed on a device to fix an invalid state or configuration that's preventing the device from getting updates. For example, if Windows Update service is turned off, the fix is to turn the it back on - **usingBackupFeatureAssessment** The WaaSMedic engine contacts Windows as a Service (WaaS) Assessment to determine whether the device is up-to-date. If WaaS Assessment isn't available, the engine falls back to backup feature assessments, which are determined programmatically on the client - **usingBackupQualityAssessment** The WaaSMedic engine contacts Windows as a Service (WaaS) Assessment to determine whether the device is up-to-date. If WaaS Assessment isn't available, the engine falls back to backup quality assessments, which are determined programmatically on the client +- **versionString** Installed version of the WaaSMedic engine -## Windows Error Reporting events +### Microsoft.Windows.WaaSMedic.SummaryEvent -### Microsoft.Windows.WERVertical.OSCrash - -This event sends binary data from the collected dump file wheneveer a bug check occurs, to help keep Windows up to date. The is the OneCore version of this event. +This event provides the results from the WaaSMedic engine The following fields are available: -- **BootId** Uint32 identifying the boot number for this device. -- **BugCheckCode** "Uint64 ""bugcheck code"" that identifies a proximate cause of the bug check." -- **BugCheckParameter1** Uint64 parameter providing additional information. -- **BugCheckParameter2** Uint64 parameter providing additional information. -- **BugCheckParameter3** Uint64 parameter providing additional information. -- **BugCheckParameter4** Uint64 parameter providing additional information. -- **DumpFileAttributes** Codes that identify the type of data contained in the dump file -- **DumpFileSize** Size of the dump file -- **IsValidDumpFile** True if the dump file is valid for the debugger, false otherwise -- **ReportId** WER Report Id associated with this bug check (used for finding the corresponding report archive in Watson). +- **detectionSummary** Result of each applicable detection that was run. +- **featureAssessmentImpact** WaaS Assessment impact for feature updates. +- **hrEngineResult** Indicates the WaaSMedic engine operation error codes +- **insufficientSessions** Device not eligible for diagnostics. +- **isManaged** Device is managed for updates. +- **isWUConnected** Device is connected to Windows Update. +- **noMoreActions** No more applicable diagnostics. +- **qualityAssessmentImpact** WaaS Assessment impact for quality updates. +- **remediationSummary** Result of each operation performed on a device to fix an invalid state or configuration that's preventing the device from getting updates. For example, if Windows Update service is turned off, the fix is to turn the it back on. +- **usingBackupFeatureAssessment** Relying on backup feature assessment. +- **usingBackupQualityAssessment** Relying on backup quality assessment. +- **versionString** Version of the WaaSMedic engine. + + +## Windows Store events + +### Microsoft.Windows.Store.Partner.ReportApplication + +Report application event for Windows Store client. -## Microsoft Store events ### Microsoft.Windows.StoreAgent.Telemetry.AbortedInstallation @@ -4098,281 +4421,30 @@ The following fields are available: - **CategoryId** The Item Category ID. - **ClientAppId** The identity of the app that initiated this operation. - **HResult** The result code of the last action performed before this operation. -- **IntentPFNs** Intent Product Family Name - **IsBundle** Is this a bundle? - **IsInteractive** Was this requested by a user? - **IsMandatory** Was this a mandatory update? - **IsRemediation** Was this a remediation install? - **IsRestore** Is this automatically restoring a previously acquired product? - **IsUpdate** Flag indicating if this is an update. -- **IsWin32** Flag indicating if this is a Win32 app (not used). - **ParentBundleId** The product ID of the parent (if this product is part of a bundle). - **PFN** The product family name of the product being installed. - **ProductId** The identity of the package or packages being installed. - **SystemAttemptNumber** The total number of automatic attempts at installation before it was canceled. -- **UpdateId** Update ID (if this is an update) - **UserAttemptNumber** The total number of user attempts at installation before it was canceled. -- **WUContentId** The Windows Update content ID +- **WUContentId** Licensing identity of this package. -### Microsoft.Windows.StoreAgent.Telemetry.EndAcquireLicense +### Microsoft.Windows.StoreAgent.Telemetry.BeginGetInstalledContentIds -This event is sent after the license is acquired when a product is being installed. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AggregatedPackageFullNames** Includes a set of package full names for each app that is part of an atomic set. -- **AttemptNumber** The total number of attempts to acquire this product. -- **BundleId** The bundle ID -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** HResult code to show the result of the operation (success/failure). -- **IntentPFNs** Intent Product Family Name -- **IsBundle** Is this a bundle? -- **IsInteractive** Did the user initiate the installation? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this happening after a device restore? -- **IsUpdate** Is this an update? -- **IsWin32** Flag indicating if this is a Win32app. -- **ParentBundledId** The product's parent bundle ID. -- **ParentBundleId** The parent bundle ID (if it's part of a bundle). -- **PFN** Product Family Name of the product being installed. -- **ProductId** The Store Product ID for the product being installed. -- **SystemAttemptNumber** The number of attempts by the system to acquire this product. -- **UpdateId** The update ID (if this is an update) -- **UserAttemptNumber** The number of attempts by the user to acquire this product -- **WUContentId** The Windows Update content ID +This event is sent when an inventory of the apps installed is started to determine whether updates for those apps are available. It's used to help keep Windows up-to-date and secure. -### Microsoft.Windows.StoreAgent.Telemetry.EndDownload -This event happens during the app update or installation when content is being downloaded at the end of the process to report success or failure. It's used to help keep Windows up-to-date and secure. +### Microsoft.Windows.StoreAgent.Telemetry.BeginUpdateMetadataPrepare -The following fields are available: +This event is sent when the Store Agent cache is refreshed with any available package updates. It's used to help keep Windows up-to-date and secure. -- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. -- **AttemptNumber** Number of retry attempts before it was canceled. -- **BundleId** The identity of the Windows Insider build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **DownloadSize** The total size of the download. -- **ExtendedHResult** Any extended HResult error codes. -- **HResult** The result code of the last action performed. -- **IntentPFNs** Intent Product Family Name -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this initiated by the user? -- **IsMandatory** Is this a mandatory installation? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this a restore of a previously acquired product? -- **IsUpdate** Is this an update? -- **IsWin32** Flag indicating if this is a Win32 app (unused). -- **ParentBundleId** The parent bundle ID (if it's part of a bundle). -- **PFN** The Product Family Name of the app being download. -- **ProductId** The Store Product ID for the product being installed. -- **SystemAttemptNumber** The number of attempts by the system to download. -- **UpdateId** Update ID (if this is an update) -- **UserAttemptNumber** The number of attempts by the user to download. -- **WUContentId** The Windows Update content ID. - - -### Microsoft.Windows.StoreAgent.Telemetry.EndFrameworkUpdate - -This event happens when an app update requires an updated Framework package and the process starts to download it. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **HResult** The result code of the last action performed before this operation. - - -### Microsoft.Windows.StoreAgent.Telemetry.EndGetInstalledContentIds - -This event is sent after sending the inventory of the products installed to determine whether updates for those products are available. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **HResult** The result code of the last action performed before this operation. - - -### Microsoft.Windows.StoreAgent.Telemetry.EndInstall - -This event is sent after a product has been installed. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. -- **AttemptNumber** The number of retry attempts before it was canceled. -- **BundleId** The identity of the build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **ExtendedHResult** The extended HResult error code. -- **HResult** The result code of the last action performed. -- **IntentPFNs** Intent Product Family Name -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this an interactive installation? -- **IsMandatory** Is this a mandatory installation? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this automatically restoring a previously acquired product? -- **IsUpdate** Is this an update? -- **IsWin32** Flag indicating if this a Win32 app (unused). -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** Product Family Name of the product being installed. -- **ProductId** The Store Product ID for the product being installed. -- **SystemAttemptNumber** The total number of system attempts. -- **UpdateId** Update ID (if this is an update) -- **UserAttemptNumber** The total number of user attempts. -- **WUContentId** The Windows Update content ID - - -### Microsoft.Windows.StoreAgent.Telemetry.EndScanForUpdates - -This event is sent after a scan for product updates to determine if there are packages to install. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** The result code of the last action performed. -- **IsApplicability** Is this request to only check if there are any applicable packages to install? -- **IsInteractive** Is this user requested? -- **IsOnline** Is the request doing an online check? - - -### Microsoft.Windows.StoreAgent.Telemetry.EndSearchUpdatePackages - -This event is sent after searching for update packages to install. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. -- **AttemptNumber** The total number of retry attempts before it was canceled. -- **BundleId** The identity of the build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** The result code of the last action performed. -- **IntentPFNs** The licensing identity of this package. -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this user requested? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this restoring previously acquired content? -- **IsUpdate** Is this an update? -- **IsWin32** Flag indicating if this a Win32 app (unused). -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** The name of the package or packages requested for install. -- **ProductId** The Store Product ID for the product being installed. -- **SystemAttemptNumber** The total number of system attempts. -- **UpdateId** Update ID (if this is an update) -- **UserAttemptNumber** The total number of user attempts. -- **WUContentId** The Windows Update content ID - - -### Microsoft.Windows.StoreAgent.Telemetry.EndStageUserData - -This event is sent between download and installation to see if there is app data that needs to be restored from the cloud. It's used to keep Windows up-to-date and secure. - -The following fields are available: - -- **AttemptNumber** The total number of retry attempts before it was canceled. -- **BundleId** The identity of the build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** The result code of the last action performed. -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this user requested? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this restoring previously acquired content? -- **IsUpdate** Is this an update? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** The name of the package or packages requested for install. -- **ProductId** The Store Product ID for the product being installed. -- **SystemAttemptNumber** The total number of system attempts. -- **UserAttemptNumber** The total number of system attempts. -- **WUContentId** The Windows Update content ID -- **IntentPFNs** The licensing identity of this package. -- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. - - -### Microsoft.Windows.StoreAgent.Telemetry.InstallOperationRequest - -This event happens at the beginning of the install process when an app update or new app is installed. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **BundleId** The identity of the build associated with this product. -- **CatalogId** If this product is from a private catalog, the Store Product ID for the product being installed. -- **ProductId** The Store Product ID for the product being installed. -- **SkuId** Specific edition ID being installed. -- **VolumePath** The disk path of the installation. - - -### Microsoft.Windows.StoreAgent.Telemetry.PauseInstallation - -This event is sent when a product install or update is paused either by a user or the system. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AttemptNumber** The total number of retry attempts before it was canceled. -- **BundleId** The identity of the build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this user requested? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this restoring previously acquired content? -- **IsUpdate** Is this an update? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** The Product Full Name. -- **PreviousHResult** The result code of the last action performed before this operation. -- **PreviousInstallState** Previous state before the installation or update was paused. -- **ProductId** The Store Product ID for the product being installed. -- **RelatedCV** Correlation Vector of a previous performed action on this product. -- **SystemAttemptNumber** The total number of system attempts. -- **UserAttemptNumber** The total number of user attempts. -- **WUContentId** The Windows Update content ID -- **IntentPFNs** The licensing identity of this package. -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. - - -### Microsoft.Windows.StoreAgent.Telemetry.ResumeInstallation - -This event happens when a product install or update is resumed either by a user or the system. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AttemptNumber** The number of retry attempts before it was canceled. -- **BundleId** The identity of the build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this user requested? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this restoring previously acquired content? -- **IsUpdate** Is this an update? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** The name of the package or packages requested for install. -- **PreviousHResult** The previous HResult error code. -- **PreviousInstallState** Previous state before the installation was paused. -- **ProductId** The Store Product ID for the product being installed. -- **RelatedCV** Correlation Vector for the original install before it was resumed. -- **SystemAttemptNumber** The total number of system attempts. -- **UserAttemptNumber** The total number of user attempts. -- **WUContentId** The Windows Update content ID -- **IntentPFNs** Intent Product Family Name -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. -- **HResult** The result code of the last action performed before this operation. -- **IsUserRetry** Did the user initiate the retry? - - -### Microsoft.Windows.StoreAgent.Telemetry.UpdateAppOperationRequest - -This event happens an app for a user needs to be updated. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **PFamN** The name of the product that is requested for update. ### Microsoft.Windows.StoreAgent.Telemetry.CancelInstallation @@ -4381,6 +4453,7 @@ This event is sent when an app update or installation is canceled while in inter The following fields are available: +- **AggregatedPackageFullNames** The names of all package or packages to be downloaded and installed. - **AttemptNumber** Total number of installation attempts. - **BundleId** The identity of the Windows Insider build that is associated with this product. - **CategoryId** The identity of the package or packages being installed. @@ -4399,34 +4472,12 @@ The following fields are available: - **RelatedCV** Correlation Vector of a previous performed action on this product. - **SystemAttemptNumber** Total number of automatic attempts to install before it was canceled. - **UserAttemptNumber** Total number of user attempts to install before it was canceled. -- **WUContentId** The Windows Update content ID -- **IntentPFNs** Intent Product Family Name -- **AggregatedPackageFullNames** The names of all package or packages to be downloaded and installed. - - -### Microsoft.Windows.StoreAgent.Telemetry.SearchForUpdateOperationRequest - -This event is sent when searching for update packages to install. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **CatalogId** The Store Product ID for the product being installed. -- **ProductId** The Store Product ID for the product being installed. -- **SkuId** Specfic edition of the app being updated. - - -### Microsoft.Windows.StoreAgent.Telemetry.EndUpdateMetadataPrepare - -This event happens after a scan for available app updates. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **HResult** The result code of the last action performed. +- **WUContentId** The Windows Update content ID. ### Microsoft.Windows.StoreAgent.Telemetry.CompleteInstallOperationRequest -This event is sent after the app installations or updates. It's used to help keep Windows up-to-date and secure +This event is sent at the end of the installs or updates. Store Agent events are needed to help keep Windows Apps up to date and secure, like the Mail and Calendar Apps. App install or update failures can be unique across devices and without this data from every device we will not be able to track failures and fix future vulnerabilities related to these Windows Apps. The following fields are available: @@ -4438,39 +4489,334 @@ The following fields are available: - **SkuId** Specific edition of the item being installed. +### Microsoft.Windows.StoreAgent.Telemetry.EndAcquireLicense + +This event is sent after the license is acquired when a product is being installed. It's used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** Includes a set of package full names for each app that is part of an atomic set. +- **AttemptNumber** The total number of attempts to acquire this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** HResult code to show the result of the operation (success/failure). +- **IsBundle** Is this a bundle? +- **IsInteractive** Did the user initiate the installation? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this happening after a device restore? +- **IsUpdate** Is this an update? +- **PFN** Product Family Name of the product being installed. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The number of attempts by the system to acquire this product. +- **UserAttemptNumber** The number of attempts by the user to acquire this product +- **WUContentId** Licensing identity of this package. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndDownload + +This event is sent after an app is downloaded to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. +- **AttemptNumber** Number of retry attempts before it was canceled. +- **BundleId** The identity of the Windows Insider build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **DownloadSize** The total size of the download. +- **ExtendedHResult** Any extended HResult error codes. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this initiated by the user? +- **IsMandatory** Is this a mandatory installation? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this a restore of a previously acquired product? +- **IsUpdate** Is this an update? +- **ParentBundleId** The parent bundle ID (if it's part of a bundle). +- **PFN** The Product Family Name of the app being download. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The number of attempts by the system to download. +- **UserAttemptNumber** The number of attempts by the user to download. +- **WUContentId** The Windows Update content ID. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndFrameworkUpdate + +This event is sent when an app update requires an updated Framework package and the process starts to download it. It is used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **HResult** The result code of the last action performed before this operation. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndGetInstalledContentIds + +This event is sent after sending the inventory of the products installed to determine whether updates for those products are available. It's used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **HResult** The result code of the last action performed before this operation. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndInstall + +This event is sent after a product has been installed to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** The number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **ExtendedHResult** The extended HResult error code. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this an interactive installation? +- **IsMandatory** Is this a mandatory installation? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this automatically restoring a previously acquired product? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** Product Family Name of the product being installed. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The total number of system attempts. +- **UserAttemptNumber** The total number of user attempts. +- **WUContentId** Licensing identity of this package. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndScanForUpdates + +This event is sent after a scan for product updates to determine if there are packages to install. It's used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed. +- **IsApplicability** Is this request to only check if there are any applicable packages to install? +- **IsInteractive** Is this user requested? +- **IsOnline** Is the request doing an online check? + + +### Microsoft.Windows.StoreAgent.Telemetry.EndSearchUpdatePackages + +This event is sent after searching for update packages to install. It is used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** The total number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this user requested? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of the package or packages requested for install. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The total number of system attempts. +- **UserAttemptNumber** The total number of user attempts. +- **WUContentId** The Windows Update content ID. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndStageUserData + +This event is sent after restoring user data (if any) that needs to be restored following a product install. Store Agent events are needed to help keep Windows Apps up to date and secure, like the Mail and Calendar Apps. App install or update failures can be unique across devices and without this data from every device we will not be able to track failures and fix future vulnerabilities related to these Windows Apps. + +The following fields are available: + +- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. +- **AttemptNumber** The total number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this user requested? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of the package or packages requested for install. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The total number of system attempts. +- **UserAttemptNumber** The total number of system attempts. +- **WUContentId** Licensing identity of this package. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndUpdateMetadataPrepare + +This event happens after a scan for available app updates. It's used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **HResult** The result code of the last action performed. + + +### Microsoft.Windows.StoreAgent.Telemetry.FulfillmentComplete + +FulfillmentComplete event is fired at the end of an app install or update. We use this to track the very end of the install/update process. StoreAgent events are needed to help keep Windows pre-installed 1st party apps up to date and secure such as the mail and calendar apps. App update failure can be unique across devices and without this data from every device we will not be able to track the success/failure and fix any future vulnerabilities related to these built in Windows Apps. + +The following fields are available: + +- **FailedRetry** Tells us if the retry for an install or update was successful or not. +- **HResult** Resulting HResult error/success code of this call +- **PFN** Package Family Name of the app that being installed or updated +- **ProductId** Product Id of the app that is being updated or installed + + +### Microsoft.Windows.StoreAgent.Telemetry.FulfillmentInitiate + +FulfillmentInitiate event is fired at the start of an app install or update. We use this to track the very beginning of the install/update process. StoreAgent events are needed to help keep Windows pre-installed 1st party apps up to date and secure such as the mail and calendar apps. App update failure can be unique across devices and without this data from every device we will not be able to track the success/failure and fix any future vulnerabilities related to these built in Windows Apps. + +The following fields are available: + +- **PFN** The Package Family Name of the app that is being installed or updated. +- **ProductId** The product ID of the app that is being updated or installed. + + +### Microsoft.Windows.StoreAgent.Telemetry.InstallOperationRequest + +This event is sent when a product install or update is initiated. Store Agent events are needed to help keep Windows Apps up to date and secure, like the Mail and Calendar Apps. App install or update failures can be unique across devices and without this data from every device we will not be able to track failures and fix future vulnerabilities related to these Windows Apps. + +The following fields are available: + +- **BundleId** The identity of the build associated with this product. +- **CatalogId** If this product is from a private catalog, the Store Product ID for the product being installed. +- **ProductId** The Store Product ID for the product being installed. +- **SkuId** Specific edition ID being installed. +- **VolumePath** The disk path of the installation. + + +### Microsoft.Windows.StoreAgent.Telemetry.PauseInstallation + +This event is sent when a product install or update is paused either by a user or the system. Store Agent events are needed to help keep Windows Apps up to date and secure, like the Mail and Calendar Apps. App install or update failures can be unique across devices and without this data from every device we will not be able to track failures and fix future vulnerabilities related to these Windows Apps. + +The following fields are available: + +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** The total number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this user requested? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The Product Full Name. +- **PreviousHResult** The result code of the last action performed before this operation. +- **PreviousInstallState** Previous state before the installation or update was paused. +- **ProductId** The Store Product ID for the product being installed. +- **RelatedCV** Correlation Vector of a previous performed action on this product. +- **SystemAttemptNumber** The total number of system attempts. +- **UserAttemptNumber** The total number of user attempts. +- **WUContentId** Licensing identity of this package. + + +### Microsoft.Windows.StoreAgent.Telemetry.ResumeInstallation + +This event is sent when a product install or update is resumed either by a user or the system. Store Agent events are needed to help keep Windows Apps up to date and secure, like the Mail and Calendar Apps. App install or update failures can be unique across devices and without this data from every device we will not be able to track failures and fix future vulnerabilities related to these Windows Apps. + +The following fields are available: + +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** The number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed before this operation. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this user requested? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **IsUserRetry** Did the user initiate the retry? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of the package or packages requested for install. +- **PreviousHResult** The previous HResult error code. +- **PreviousInstallState** Previous state before the installation was paused. +- **ProductId** The Store Product ID for the product being installed. +- **RelatedCV** Correlation Vector for the original install before it was resumed. +- **SystemAttemptNumber** The total number of system attempts. +- **UserAttemptNumber** The total number of user attempts. +- **WUContentId** Licensing identity of this package. + + ### Microsoft.Windows.StoreAgent.Telemetry.ResumeOperationRequest -This event happens when a product install or update is resumed by a user and on installation retries. It's used to help keep Windows up-to-date and secure. +This event is sent when a product install or update is resumed by a user and on install retries. Store Agent events are needed to help keep Windows Apps up to date and secure, like the Mail and Calendar Apps. App install or update failures can be unique across devices and without this data from every device we will not be able to track failures and fix future vulnerabilities related to these Windows Apps. The following fields are available: - **ProductId** The Store Product ID for the product being installed. -### Microsoft.Windows.StoreAgent.Telemetry.FulfillmentComplete +### Microsoft.Windows.StoreAgent.Telemetry.SearchForUpdateOperationRequest -This event is sent at the end of an app install or update and is used to track the very end of the install or update process. +This event is sent when searching for update packages to install. Store Agent events are needed to help keep Windows Apps up to date and secure, like the Mail and Calendar Apps. App install or update failures can be unique across devices and without this data from every device we will not be able to track failures and fix future vulnerabilities related to these Windows Apps. The following fields are available: -- **FailedRetry** Was the installation or update retry successful? -- **HResult** The HResult code of the operation. -- **PFN** The Package Family Name of the app that is being installed or updated. -- **ProductId** The product ID of the app that is being updated or installed. +- **CatalogId** The Store Catalog ID for the product being installed. +- **ProductId** The Store Product ID for the product being installed. +- **SkuId** Specfic edition of the app being updated. -### Microsoft.Windows.StoreAgent.Telemetry.FulfillmentInitiate +### Microsoft.Windows.StoreAgent.Telemetry.UpdateAppOperationRequest -This event is sent at the beginning of an app install or update and is used to track the very beginning of the install or update process. +This event occurs when an update is requested for an app, to help keep Windows up-to-date and secure. The following fields are available: -- **PFN** The Package Family Name of the app that is being installed or updated. -- **ProductId** The product ID of the app that is being updated or installed. +- **PFamN** The name of the app that is requested for update. ## Windows Update Delivery Optimization events +### Microsoft.OSG.DU.DeliveryOptClient.DownloadCanceled + +This event describes when a download was canceled with Delivery Optimization. It's used to understand and address problems regarding downloads. + +The following fields are available: + +- **background** Is the download being done in the background? +- **bytesFromCacheServer** Bytes received from a cache host. +- **bytesFromCDN** The number of bytes received from a CDN source. +- **bytesFromGroupPeers** The number of bytes received from a peer in the same group. +- **bytesFromIntPeers** The number of bytes received from peers not in the same LAN or in the same group. +- **bytesFromLocalCache** Bytes copied over from local (on disk) cache. +- **bytesFromPeers** The number of bytes received from a peer in the same LAN. +- **callerName** Name of the API caller. +- **cdnErrorCodes** A list of CDN connection errors since the last FailureCDNCommunication event. +- **cdnErrorCounts** The number of times each error in cdnErrorCodes was encountered. +- **clientTelId** A random number used for device sampling. +- **dataSourcesTotal** Bytes received per source type, accumulated for the whole session. +- **doErrorCode** The Delivery Optimization error code that was returned. +- **errorCode** The error code that was returned. +- **experimentId** When running a test, this is used to correlate events that are part of the same test. +- **fileID** The ID of the file being downloaded. +- **gCurMemoryStreamBytes** Current usage for memory streaming. +- **gMaxMemoryStreamBytes** Maximum usage for memory streaming. +- **isVpn** Is the device connected to a Virtual Private Network? +- **jobID** Identifier for the Windows Update job. +- **reasonCode** Reason the action or event occurred. +- **scenarioID** The ID of the scenario. +- **sessionID** The ID of the file download session. +- **updateID** The ID of the update being downloaded. +- **usedMemoryStream** Did the download use memory streaming? + + ### Microsoft.OSG.DU.DeliveryOptClient.DownloadCompleted This event describes when a download has completed with Delivery Optimization. It's used to understand and address problems regarding downloads. @@ -4478,24 +4824,35 @@ This event describes when a download has completed with Delivery Optimization. I The following fields are available: - **background** Is the download a background download? +- **bytesFromCacheServer** Bytes received from a cache host. - **bytesFromCDN** The number of bytes received from a CDN source. - **bytesFromGroupPeers** The number of bytes received from a peer in the same domain group. - **bytesFromIntPeers** The number of bytes received from peers not in the same LAN or in the same domain group. +- **bytesFromLocalCache** Bytes copied over from local (on disk) cache. - **bytesFromPeers** The number of bytes received from a peer in the same LAN. - **bytesRequested** The total number of bytes requested for download. +- **cacheServerConnectionCount** Number of connections made to cache hosts. +- **callerName** Name of the API caller. - **cdnConnectionCount** The total number of connections made to the CDN. - **cdnErrorCodes** A list of CDN connection errors since the last FailureCDNCommunication event. - **cdnErrorCounts** The number of times each error in cdnErrorCodes was encountered. - **cdnIp** The IP address of the source CDN. - **clientTelId** A random number used for device sampling. +- **dataSourcesTotal** Bytes received per source type, accumulated for the whole session. - **doErrorCode** The Delivery Optimization error code that was returned. - **downlinkBps** The maximum measured available download bandwidth (in bytes per second). - **downlinkUsageBps** The download speed (in bytes per second). - **downloadMode** The download mode used for this file download session. +- **downloadModeSrc** Source of the DownloadMode setting (KvsProvider = 0, GeoProvider = 1, GeoVerProvider = 2, CpProvider = 3, DiscoveryProvider = 4, RegistryProvider = 5, GroupPolicyProvider = 6, MdmProvider = 7, SettingsProvider = 8, InvalidProviderType = 9). +- **experimentId** When running a test, this is used to correlate with other events that are part of the same test. - **fileID** The ID of the file being downloaded. - **fileSize** The size of the file being downloaded. +- **gCurMemoryStreamBytes** Current usage for memory streaming. +- **gMaxMemoryStreamBytes** Maximum usage for memory streaming. - **groupConnectionCount** The total number of connections made to peers in the same group. - **internetConnectionCount** The total number of connections made to peers not in the same LAN or the same group. +- **isVpn** Is the device connected to a Virtual Private Network? +- **jobID** Identifier for the Windows Update job. - **lanConnectionCount** The total number of connections made to peers in the same LAN. - **numPeers** The total number of peers used for this download. - **restrictedUpload** Is the upload restricted? @@ -4505,8 +4862,6 @@ The following fields are available: - **updateID** The ID of the update being downloaded. - **uplinkBps** The maximum measured available upload bandwidth (in bytes per second). - **uplinkUsageBps** The upload speed (in bytes per second). -- **experimentId** When running a test, this is used to correlate with other events that are part of the same test. -- **isVpn** Is the device connected to a Virtual Private Network? - **usedMemoryStream** Did the download use memory streaming? @@ -4517,15 +4872,77 @@ This event represents a temporary suspension of a download with Delivery Optimiz The following fields are available: - **background** Is the download a background download? +- **callerName** The name of the API caller. - **clientTelId** A random number used for device sampling. - **errorCode** The error code that was returned. +- **experimentId** When running a test, this is used to correlate with other events that are part of the same test. - **fileID** The ID of the file being paused. +- **isVpn** Is the device connected to a Virtual Private Network? +- **jobID** Identifier for the Windows Update job. - **reasonCode** The reason for pausing the download. - **scenarioID** The ID of the scenario. - **sessionID** The ID of the download session. - **updateID** The ID of the update being paused. + + +### Microsoft.OSG.DU.DeliveryOptClient.DownloadStarted + +This event sends data describing the start of a new download to enable Delivery Optimization. It's used to understand and address problems regarding downloads. + +The following fields are available: + +- **background** Indicates whether the download is happening in the background. +- **bytesRequested** Number of bytes requested for the download. +- **callerName** Name of the API caller. +- **cdnUrl** The URL of the source CDN. +- **clientTelId** Random number used for device selection +- **costFlags** A set of flags representing network cost. +- **deviceProfile** Identifies the usage or form factor (such as Desktop, Xbox, or VM). +- **diceRoll** Random number used for determining if a client will use peering. +- **doClientVersion** The version of the Delivery Optimization client. +- **doErrorCode** The Delivery Optimization error code that was returned. +- **downloadMode** The download mode used for this file download session (CdnOnly = 0, Lan = 1, Group = 2, Internet = 3, Simple = 99, Bypass = 100). +- **downloadModeSrc** Source of the DownloadMode setting (KvsProvider = 0, GeoProvider = 1, GeoVerProvider = 2, CpProvider = 3, DiscoveryProvider = 4, RegistryProvider = 5, GroupPolicyProvider = 6, MdmProvider = 7, SettingsProvider = 8, InvalidProviderType = 9). +- **errorCode** The error code that was returned. +- **experimentId** ID used to correlate client/services calls that are part of the same test during A/B testing. +- **fileID** The ID of the file being downloaded. +- **filePath** The path to where the downloaded file will be written. +- **fileSize** Total file size of the file that was downloaded. +- **fileSizeCaller** Value for total file size provided by our caller. +- **groupID** ID for the group. +- **isVpn** Indicates whether the device is connected to a Virtual Private Network. +- **jobID** The ID of the Windows Update job. +- **minDiskSizeGB** The minimum disk size (in GB) policy set for the device to allow peering with delivery optimization. +- **minDiskSizePolicyEnforced** Indicates whether there is an enforced minimum disk size requirement for peering. +- **minFileSizePolicy** The minimum content file size policy to allow the download using peering with delivery optimization. +- **peerID** The ID for this delivery optimization client. +- **scenarioID** The ID of the scenario. +- **sessionID** The ID for the file download session. +- **updateID** The ID of the update being downloaded. +- **usedMemoryStream** Indicates whether the download used memory streaming. + + +### Microsoft.OSG.DU.DeliveryOptClient.FailureCdnCommunication + +This event represents a failure to download from a CDN with Delivery Optimization. It's used to understand and address problems regarding downloads. + +The following fields are available: + +- **cdnHeaders** The HTTP headers returned by the CDN. +- **cdnIp** The IP address of the CDN. +- **cdnUrl** The URL of the CDN. +- **clientTelId** A random number used for device sampling. +- **errorCode** The error code that was returned. +- **errorCount** The total number of times this error code was seen since the last FailureCdnCommunication event was encountered. - **experimentId** When running a test, this is used to correlate with other events that are part of the same test. -- **isVpn** Is the device connected to a Virtual Private Network? +- **fileID** The ID of the file being downloaded. +- **httpStatusCode** The HTTP status code returned by the CDN. +- **isHeadRequest** The type of HTTP request that was sent to the CDN. Example: HEAD or GET +- **peerType** The type of peer (LAN, Group, Internet, CDN, Cache Host, etc.). +- **requestOffset** The byte offset within the file in the sent request. +- **requestSize** The size of the range requested from the CDN. +- **responseSize** The size of the range response received from the CDN. +- **sessionID** The ID of the download session. ### Microsoft.OSG.DU.DeliveryOptClient.JobError @@ -4535,105 +4952,56 @@ This event represents a Windows Update job error. It allows for investigation of The following fields are available: - **clientTelId** A random number used for device sampling. +- **doErrorCode** Error code returned for delivery optimization. - **errorCode** The error code returned. - **experimentId** When running a test, this is used to correlate with other events that are part of the same test. - **fileID** The ID of the file being downloaded. - **jobID** The Windows Update job ID. -### Microsoft.OSG.DU.DeliveryOptClient.DownloadCanceled - -This event describes when a download was canceled with Delivery Optimization. It's used to understand and address problems regarding downloads. - -The following fields are available: - -- **background** Is the download being done in the background? -- **bytesFromCDN** The number of bytes received from a CDN source. -- **bytesFromGroupPeers** The number of bytes received from a peer in the same group. -- **bytesFromIntPeers** The number of bytes received from peers not in the same LAN or in the same group. -- **bytesFromPeers** The number of bytes received from a peer in the same LAN. -- **cdnErrorCodes** A list of CDN connection errors since the last FailureCDNCommunication event. -- **cdnErrorCounts** The number of times each error in cdnErrorCodes was encountered. -- **clientTelId** A random number used for device sampling. -- **doErrorCode** The Delivery Optimization error code that was returned. -- **errorCode** The error code that was returned. -- **experimentId** When running a test, this is used to correlate events that are part of the same test. -- **fileID** The ID of the file being downloaded. -- **isVpn** Is the device connected to a Virtual Private Network? -- **scenarioID** The ID of the scenario. -- **sessionID** The ID of the file download session. -- **updateID** The ID of the update being downloaded. -- **usedMemoryStream** Did the download use memory streaming? - - -### Microsoft.OSG.DU.DeliveryOptClient.DownloadStarted - -This event describes the start of a new download with Delivery Optimization. It's used to understand and address problems regarding downloads. - -The following fields are available: - -- **background** Is the download a background download? -- **cdnUrl** The URL of the CDN. -- **clientTelId** A random number used for device sampling. -- **deviceProfile** Identifies the usage or form factor. Example: Desktop or Xbox -- **diceRoll** The dice roll value used in sampling events. -- **doClientVersion** The version of the Delivery Optimization client. -- **doErrorCode** The Delivery Optimization error code that was returned. -- **downloadMode** The download mode used for this file download session. -- **errorCode** The error code that was returned. -- **experimentId** When running a test, this is used to correlate with other events that are part of the same test. -- **fileID** The ID of the file being downloaded. -- **filePath** The path where the file will be written. -- **groupID** ID for the group. -- **isVpn** Is the device connected to a Virtual Private Network? -- **jobID** The ID of the Windows Update job. -- **minDiskSizeGB** The minimum disk size (in GB) required for Peering. -- **minDiskSizePolicyEnforced** Is the minimum disk size enforced via policy? -- **minFileSizePolicy** The minimum content file size policy to allow the download using Peering. -- **peerID** The ID for this Delivery Optimization client. -- **scenarioID** The ID of the scenario. -- **sessionID** The ID of the download session. -- **updateID** The ID of the update being downloaded. -- **usedMemoryStream** Did the download use memory streaming? -- **costFlags** A set of flags representing network cost. - - -### Microsoft.OSG.DU.DeliveryOptClient.FailureCdnCommunication - -This event represents a failure to download from a CDN with Delivery Optimization. It's used to understand and address problems regarding downloads. - -The following fields are available: - -- **cdnIp** The IP address of the CDN. -- **cdnUrl** The URL of the CDN. -- **clientTelId** A random number used for device sampling. -- **errorCode** The error code that was returned. -- **errorCount** The total number of times this error code was seen since the last FailureCdnCommunication event was encountered. -- **httpStatusCode** The HTTP status code returned by the CDN. -- **sessionID** The ID of the download session. -- **cdnHeaders** The HTTP headers returned by the CDN. -- **experimentId** When running a test, this is used to correlate with other events that are part of the same test. -- **fileID** The ID of the file being downloaded. -- **isHeadRequest** The type of HTTP request that was sent to the CDN. Example: HEAD or GET -- **requestSize** The size of the range requested from the CDN. -- **responseSize** The size of the range response received from the CDN. - - ## Windows Update events -### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentModeStart +### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentCommit -This event sends data for the start of each mode during the process of updating device manifest assets via the UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages. +This event collects information regarding the final commit phase of the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages The following fields are available: -- **flightId** The unique identifier for each flight -- **mode** Indicates that the Update Agent mode that has started. 1 = Initialize, 2 = DownloadRequest, 3 = Install, 4 = Commit -- **objectId** Unique value for each Update Agent mode -- **relatedCV** Correlation vector value generated from the latest scan -- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **sessionId** Unique value for each Update Agent mode attempt -- **updateId** Unique ID for each update +- **errorCode** The error code returned for the current session initialization. +- **flightId** The unique identifier for each flight. +- **objectId** The unique GUID for each diagnostics session. +- **relatedCV** A correlation vector value generated from the latest USO scan. +- **result** Outcome of the initialization of the session. +- **scenarioId** Identifies the Update scenario. +- **sessionId** The unique value for each update session. +- **updateId** The unique identifier for each Update. + + +### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentDownloadRequest + +This event collects information regarding the download request phase of the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages + +The following fields are available: + +- **deletedCorruptFiles** Indicates if UpdateAgent found any corrupt payload files and whether the payload was deleted. +- **errorCode** The error code returned for the current session initialization. +- **flightId** The unique identifier for each flight. +- **objectId** Unique value for each Update Agent mode. +- **packageCountOptional** Number of optional packages requested. +- **packageCountRequired** Number of required packages requested. +- **packageCountTotal** Total number of packages needed. +- **packageCountTotalCanonical** Total number of canonical packages. +- **packageCountTotalDiff** Total number of diff packages. +- **packageCountTotalExpress** Total number of express packages. +- **packageSizeCanonical** Size of canonical packages in bytes. +- **packageSizeDiff** Size of diff packages in bytes. +- **packageSizeExpress** Size of express packages in bytes +- **rangeRequestState** Represents the state of the download range request. +- **relatedCV** Correlation vector value generated from the latest USO scan. +- **result** Result of the download request phase of update. +- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate. +- **sessionId** Unique value for each Update Agent mode attempt. +- **updateId** Unique ID for each update. ### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentInitialize @@ -4642,32 +5010,16 @@ This event sends data for initializing a new update session for the new device m The following fields are available: -- **errorCode** The error code returned for the current initialize phase -- **flightId** The unique identifier for each flight -- **flightMetadata** Contains the FlightId and the build being flighted -- **objectId** Unique value for each Update Agent mode -- **relatedCV** Correlation vector value generated from the latest USO scan -- **result** Result of the initialize phase of update. 0 = Succeeded, 1 = Failed, 2 = Cancelled, 3 = Blocked, 4 = BlockCancelled -- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate#N# -- **sessionData** Contains instructions to update agent for processing FODs and DUICs (Null for other scenarios) -- **sessionId** "Unique value for each Update Agent mode attempt " -- **updateId** Unique ID for each update - - -### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentCommit - -This event collects information regarding the final commit phase of the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages - -The following fields are available: - -- **errorCode** The error code returned for the current session initialization -- **flightId** The unique identifier for each flight -- **objectId** The unique GUID for each diagnostics session -- **relatedCV** A correlation vector value, generated from the latest USO scan -- **result** Outcome of the initialization of the session -- **scenarioId** Identifies the Update scenario -- **sessionId** The unique value for each update session -- **updateId** The unique identifier for each Update +- **errorCode** The error code returned for the current session initialization. +- **flightId** The unique identifier for each flight. +- **flightMetadata** Contains the FlightId and the build being flighted. +- **objectId** Unique value for each Update Agent mode. +- **relatedCV** Correlation vector value generated from the latest USO scan. +- **result** Result of the initialize phase of the update. 0 = Succeeded, 1 = Failed, 2 = Cancelled, 3 = Blocked, 4 = BlockCancelled. +- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate. +- **sessionData** Contains instructions to update agent for processing FODs and DUICs (Null for other scenarios). +- **sessionId** Unique value for each Update Agent mode attempt. +- **updateId** Unique ID for each update. ### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentInstall @@ -4686,252 +5038,143 @@ The following fields are available: - **updateId** Unique ID for each update -### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentDownloadRequest +### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentModeStart -This event collects information regarding the download request phase of the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages +This event sends data for the start of each mode during the process of updating device manifest assets via the UUP (Unified Update Platform) update scenario. The update scenario is used to install a device manifest describing a set of driver packages. The following fields are available: -- **deletedCorruptFiles** Indicates if UpdateAgent found any corrupt payload files and whether the payload was deleted -- **errorCode** The error code returned for the current session initialization -- **flightId** The unique identifier for each flight -- **objectId** Unique value for each Update Agent mode -- **packageCountOptional** Number of optional packages requested -- **packageCountRequired** Number of required packages requested -- **packageCountTotal** Total number of packages needed -- **packageCountTotalCanonical** Total number of canonical packages -- **packageCountTotalDiff** Total number of diff packages -- **packageCountTotalExpress** Total number of express packages -- **packageSizeCanonical** Size of canonical packages in bytes -- **packageSizeDiff** Size of diff packages in bytes -- **packageSizeExpress** Size of express packages in bytes -- **rangeRequestState** Represents the state of the download range request -- **relatedCV** Correlation vector value generated from the latest USO scan -- **result** Result of the download request phase of update -- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **sessionId** Unique value for each Update Agent mode attempt -- **updateId** Unique ID for each update +- **flightId** Unique ID for each flight. +- **mode** The mode that is starting. +- **objectId** Unique value for each diagnostics session. +- **relatedCV** Correlation vector value generated from the latest USO scan. +- **scenarioId** Indicates the update scenario. +- **sessionId** Unique value for each update session. +- **updateId** Unique ID for each Update. -### Microsoft.Windows.Update.Orchestrator.GameActive +### Microsoft.Windows.Update.NotificationUx.RebootScheduled -This event indicates that an enabled GameMode process prevented the device from restarting to complete an update +Indicates when a reboot is scheduled by the system or a user for a security, quality, or feature update. The following fields are available: -- **eventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed -- **gameModeReason** Name of the enabled GameMode process that prevented the device from restarting to complete an update -- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue - - -### Microsoft.Windows.Update.DataMigrationFramework.DmfMigrationCompleted - -This event sends data collected at the end of the Data Migration Framework (DMF) and parameters involved in its invocation, to help keep Windows up to date. - -The following fields are available: - -- **MigrationDurationInMilliseconds** How long the DMF migration took (in milliseconds) -- **MigrationEndTime** A system timestamp of when the DMF migration completed. -- **RevisionNumbers** A collection of revision numbers for the updates associated with the DMF session. -- **UpdateIds** A collection of GUIDs for updates that are associated with the DMF session. -- **WuClientId** The GUID of the Windows Update client responsible for triggering the DMF migration - - -### Microsoft.Windows.Update.DataMigrationFramework.DmfMigrationStarted - -This event sends data collected at the beginning of the Data Migration Framework (DMF) and parameters involved in its invocation, to help keep Windows up to date. - -The following fields are available: - -- **MigrationMicrosoftPhases** Revision numbers for the updates that were installed. -- **MigrationOEMPhases** WU Update IDs for the updates that were installed. -- **MigrationStartTime** The timestamp representing the beginning of the DMF migration -- **WuClientId** The GUID of the Windows Update client invoking DMF -- **RevisionNumbers** A collection of the revision numbers associated with the UpdateIds. -- **UpdateIds** A collection of GUIDs identifying the upgrades that are running. - - -### Microsoft.Windows.Update.DataMigrationFramework.MigratorResult - -This event sends DMF migrator data to help keep Windows up to date. - -The following fields are available: - -- **CurrentStep** This is the last step the migrator reported before returning a result. This tells us how far through the individual migrator the device was before failure. -- **ErrorCode** The result (as an HRESULT) of the migrator that just completed. -- **MigratorId** A GUID identifying the migrator that just completed. -- **MigratorName** The name of the migrator that just completed. -- **RunDurationInSeconds** The time it took for the migrator to complete. -- **TotalSteps** Migrators report progress in number of completed steps against the total steps. This is the total number of steps. - - -### Microsoft.Windows.Update.Orchestrator.Download - -This event sends launch data for a Windows Update download to help keep Windows up to date. - -The following fields are available: - -- **deferReason** Reason for download not completing -- **detectionDeferreason** Reason for download not completing -- **errorCode** An error code represented as a hexadecimal value -- **eventScenario** End to end update session ID. -- **flightID** Unique update ID. -- **interactive** Identifies if session is user initiated. -- **revisionNumber** Update revision number. -- **updateId** Update ID. -- **updateScenarioType** The update session type. -- **wuDeviceid** Unique device ID used by Windows Update. - - -### Microsoft.Windows.Update.Orchestrator.FlightInapplicable - -This event sends data on whether the update was applicable to the device, to help keep Windows up to date. - -The following fields are available: - -- **EventPublishedTime** time that the event was generated -- **revisionNumber** Revision Number of the Update -- **updateId** Unique Update ID -- **UpdateStatus** Integer that describes Update state -- **wuDeviceid** Unique Device ID -- **flightID** Unique Update ID -- **updateScenarioType** The update session type. - - -### Microsoft.Windows.Update.Orchestrator.PostInstall - -This event sends data about lite stack devices (mobile, IOT, anything non-PC) immediately before data migration is launched to help keep Windows up to date. - -The following fields are available: - -- **batteryLevel** Current battery capacity in mWh or percentage left. -- **bundleId** Update grouping ID. -- **bundleRevisionnumber** Bundle revision number. -- **errorCode** Hex code for the error message, to allow lookup of the specific error. -- **eventScenario** End to end update session ID. -- **flightID** Unique update ID. -- **sessionType** Interactive vs. Background. -- **wuDeviceid** Unique device ID used by Windows Update. - - -### Microsoft.Windows.Update.Orchestrator.RebootFailed - -This event sends information about whether an update required a reboot and reasons for failure to help keep Windows up to date. - -The following fields are available: - -- **batteryLevel** Current battery capacity in mWh or percentage left. -- **deferReason** Reason for install not completing. -- **EventPublishedTime** The time that the reboot failure occurred. -- **flightID** Unique update ID. -- **installRebootDeferreason** Reason for reboot not occurring. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. -- **RebootResults** Hex code indicating failure reason. Typically, we expect this to be a specific USO generated hex code. -- **revisionNumber** Update revision number. -- **updateId** Update ID. -- **updateScenarioType** The update session type. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. -- **wuDeviceid** Unique device ID used by Windows Update. - - -### Microsoft.Windows.Update.Orchestrator.UpdatePolicyCacheRefresh - -This event sends data on whether Update Management Policies were enabled on a device, to help keep Windows up to date. - -The following fields are available: - -- **configuredPoliciescount** Policy Count -- **policiesNamevaluesource** Policy Name -- **policyCacherefreshtime** Refresh time -- **updateInstalluxsetting** This shows whether a user has set policies via UX option -- **wuDeviceid** Unique device ID used by Windows Update. - - -### Microsoft.Windows.Update.Orchestrator.UpdateRebootRequired - -This event sends data about whether an update required a reboot to help keep Windows up to date. - -The following fields are available: - -- **revisionNumber** Update revision number. -- **updateId** Update ID. -- **wuDeviceid** Unique device ID used by Windows Update. -- **flightID** Unique update ID. -- **interactive** Indicates the reboot initiation stage of the update process was entered as a result of user action or not. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. -- **updateScenarioType** The update session type. - - -### Microsoft.Windows.Update.Ux.MusNotification.RebootScheduled - -This event sends data about a required reboot that is scheduled with no user interaction, to help keep Windows up to date. - -The following fields are available: - -- **activeHoursApplicable** True, If Active Hours applicable on this device. False, otherwise. -- **forcedReboot** True, if a reboot is forced on the device. Otherwise, this is False +- **activeHoursApplicable** Indicates whether an Active Hours policy is present on the device. - **rebootArgument** Argument for the reboot task. It also represents specific reboot related action. -- **rebootOutsideOfActiveHours** True, if a reboot is scheduled outside of active hours. False, otherwise. -- **rebootScheduledByUser** True, if a reboot is scheduled by user. False, if a reboot is scheduled automatically. -- **revisionNumber** Revision number of the update that is getting installed with this reboot. -- **scheduledRebootTime** Time of the scheduled reboot -- **updateId** Update ID of the update that is getting installed with this reboot. +- **rebootOutsideOfActiveHours** Indicates whether a restart is scheduled outside of active hours. +- **rebootScheduledByUser** Indicates whether the restart was scheduled by user (if not, it was scheduled automatically). +- **rebootState** The current state of the restart. +- **revisionNumber** Revision number of the update that is getting installed with this restart. +- **scheduledRebootTime** Time of the scheduled restart. +- **scheduledRebootTimeInUTC** Time of the scheduled restart in Coordinated Universal Time. +- **updateId** ID of the update that is getting installed with this restart. +- **wuDeviceid** Unique device ID used by Windows Update. + + +### Microsoft.Windows.Update.Orchestrator.CommitFailed + +This event indicates that a device was unable to restart after an update. + +The following fields are available: + +- **errorCode** The error code that was returned. +- **wuDeviceid** The Windows Update device GUID. + + +### Microsoft.Windows.Update.Orchestrator.DeferRestart + +This event indicates that a restart required for installing updates was postponed. + +The following fields are available: + +- **eventScenario** Indicates the purpose of the event (scan started, succeeded, failed, etc.). +- **filteredDeferReason** Applicable filtered reasons why reboot was postponed (such as user active, or low battery). +- **raisedDeferReason** Indicates all potential reasons for postponing restart (such as user active, or low battery). - **wuDeviceid** Unique device ID used by Windows Update. -- **rebootState** The state of the reboot. ### Microsoft.Windows.Update.Orchestrator.Detection -This event sends launch data for a Windows Update scan to help keep Windows up to date. +This event indicates that a scan for a Windows Update occurred. The following fields are available: - **deferReason** Reason why the device could not check for updates. - **detectionBlockreason** Reason for detection not completing. -- **detectionDeferreason** A log of deferral reasons for every update state. +- **detectionRetryMode** Indicates whether we will try to scan again. - **errorCode** The returned error code. -- **eventScenario** End to end update session ID, or indicates the purpose of sending this event - whether because the software distribution just started installing content, or whether it was cancelled, succeeded, or failed. -- **flightID** A unique update ID. -- **interactive** Identifies if session is User Initiated. +- **eventScenario** End-to-end update session ID, or indicates the purpose of sending this event - whether because the software distribution just started installing content, or whether it was cancelled, succeeded, or failed. +- **flightID** The specific ID of the Windows Insider build the device is getting. +- **interactive** Indicates whether the session was user initiated. - **revisionNumber** Update revision number. - **updateId** Update ID. -- **updateScenarioType** The update session type. -- **wuDeviceid** Unique device ID used by Windows Update. +- **updateScenarioType** Device ID +- **wuDeviceid** Device ID -### Microsoft.Windows.Update.Orchestrator.InitiatingReboot +### Microsoft.Windows.Update.Orchestrator.DisplayNeeded -This event sends data about an Orchestrator requesting a reboot from power management to help keep Windows up to date. +This event indicates the reboot was postponed due to needing a display. The following fields are available: -- **EventPublishedTime** Time of the event. +- **displayNeededReason** Reason the display is needed. +- **eventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **rebootOutsideOfActiveHours** Indicates whether the reboot was to occur outside of active hours. - **revisionNumber** Revision number of the update. - **updateId** Update ID. -- **wuDeviceid** Unique device ID used by Windows Update. -- **flightID** Unique update ID -- **interactive** Indicates the reboot initiation stage of the update process was entered as a result of user action or not. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. - **updateScenarioType** The update session type. +- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated. +- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue -### Microsoft.Windows.Update.Ux.MusUpdateSettings.RebootScheduled +### Microsoft.Windows.Update.Orchestrator.FlightInapplicable -This event sends basic information for scheduling a device restart to install security updates. It's used to help keep Windows up-to-date. +This event indicates that the update is no longer applicable to this device. The following fields are available: -- **activeHoursApplicable** Is the restart respecting Active Hours? -- **rebootArgument** The arguments that are passed to the OS for the restarted. -- **rebootOutsideOfActiveHours** Was the restart scheduled outside of Active Hours? -- **rebootScheduledByUser** Was the restart scheduled by the user? If the value is false, the restart was scheduled by the device. -- **rebootState** The state of the restart. -- **revisionNumber** The revision number of the OS being updated. -- **scheduledRebootTime** Time of the scheduled reboot -- **updateId** The Windows Update device GUID. -- **wuDeviceid** The Windows Update device GUID. -- **forcedReboot** True, if a reboot is forced on the device. Otherwise, this is False +- **EventPublishedTime** Time when this event was generated. +- **flightID** The specific ID of the Windows Insider build. +- **revisionNumber** Update revision number. +- **updateId** Unique Windows Update ID. +- **updateScenarioType** Update session type. +- **UpdateStatus** Last status of update. +- **UUPFallBackConfigured** Indicates whether UUP fallback is configured. +- **wuDeviceid** Unique Device ID. + + +### Microsoft.Windows.Update.Orchestrator.GameActive + +This event indicates that an enabled GameMode process prevented the device from restarting to complete an update. + +The following fields are available: + +- **eventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **gameModeReason** Name of the enabled GameMode process that prevented the device from restarting to complete an update. +- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. + + +### Microsoft.Windows.Update.Orchestrator.LowUptimes + +This event is sent if a device is identified as not having sufficient uptime to reliably process updates in order to keep secure. + +The following fields are available: + +- **isLowUptimeMachine** Is the machine considered low uptime or not. +- **lowUptimeMinHours** Current setting for the minimum number of hours needed to not be considered low uptime. +- **lowUptimeQueryDays** Current setting for the number of recent days to check for uptime. +- **uptimeMinutes** Number of minutes of uptime measured. +- **wuDeviceid** Unique device ID for Windows Update. + + +### Microsoft.Windows.Update.Orchestrator.PreShutdownStart + +This event is generated before the shutdown and commit operations. + +The following fields are available: + +- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. ### Microsoft.Windows.Update.Ux.MusNotification.RebootNoLongerNeeded @@ -4943,148 +5186,56 @@ The following fields are available: - **UtcTime** The Coordinated Universal Time that the restart was no longer needed. -### Microsoft.Windows.Update.Ux.MusNotification.ToastDisplayedToScheduleReboot +### Microsoft.Windows.Update.Ux.MusNotification.RebootRequestReasonsToIgnore -This event is sent when a toast notification is shown to the user about scheduling a device restart. +This event is sent when the reboot can be deferred based on some reasons, before reboot attempts The following fields are available: -- **UtcTime** The Coordinated Universal Time when the toast notification was shown. +- **Reason** The reason sent which will cause the reboot to defer. -### Microsoft.Windows.Update.Orchestrator.RestoreRebootTask +### Microsoft.Windows.Update.Ux.MusNotification.UxBrokerFirstReadyToReboot -This event sends data indicating that a reboot task is missing unexpectedly on a device and the task is restored because a reboot is still required, to help keep Windows up to date. +This event is fired the first time when the reboot is required. + + + +### Microsoft.Windows.Update.Ux.MusNotification.UxBrokerScheduledTask + +This event is sent when MUSE broker schedules a task The following fields are available: -- **RebootTaskRestoredTime** Time at which this reboot task was restored. -- **revisionNumber** Update revision number. -- **updateId** Update ID. -- **wuDeviceid** Device id on which the reboot is restored +- **TaskArgument** The arguments which the task is scheduled with +- **TaskName** Name of the task -### Microsoft.Windows.Update.Orchestrator.SystemNeeded +### Microsoft.Windows.Update.Ux.MusUpdateSettings.RebootScheduled -This event sends data about why a device is unable to reboot, to help keep Windows up to date. +This event sends basic information for scheduling a device restart to install security updates. It's used to help keep Windows up-to-date The following fields are available: -- **eventScenario** End to end update session ID. -- **revisionNumber** Update revision number. -- **systemNeededReason** Reason ID -- **updateId** Update ID. -- **wuDeviceid** Unique device ID used by Windows Update. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. -- **updateScenarioType** The update session type. - - -### Microsoft.Windows.Update.UpdateStackServicing.CheckForUpdates - -This event sends data about the UpdateStackServicing check for updates, to help keep Windows up to date. - -The following fields are available: - -- **BspVersion** The version of the BSP. -- **CallerApplicationName** The name of the USS scheduled task. Example UssScheduled or UssBoot -- **ClientVersion** The version of the client. -- **CommercializationOperator** The name of the operator. -- **DetectionVersion** The string returned from the GetDetectionVersion export of the downloaded detection DLL. -- **DeviceName** The name of the device. -- **EventInstanceID** The USS session ID. -- **EventScenario** The scenario of the event. Example: Started, Failed, or Succeeded -- **OemName** The name of the manufacturer. -- **ServiceGuid** The GUID of the service. -- **StatusCode** The HRESULT code of the operation. -- **WUDeviceID** The Windows Update device ID. - - -### Microsoft.Windows.Update.Orchestrator.CommitFailed - -This events tracks when a device needs to restart after an update but did not. - -The following fields are available: - -- **errorCode** The error code that was returned. +- **activeHoursApplicable** Is the restart respecting Active Hours? +- **forcedReboot** True, if a reboot is forced on the device. Otherwise, this is False +- **rebootArgument** The arguments that are passed to the OS for the restarted. +- **rebootOutsideOfActiveHours** Was the restart scheduled outside of Active Hours? +- **rebootScheduledByUser** Was the restart scheduled by the user? If the value is false, the restart was scheduled by the device. +- **rebootState** The state of the restart. +- **revisionNumber** The revision number of the OS being updated. +- **scheduledRebootTime** Time of the scheduled reboot +- **scheduledRebootTimeInUTC** Time of the scheduled restart, in Coordinated Universal Time. +- **updateId** The Windows Update device GUID. - **wuDeviceid** The Windows Update device GUID. -### Microsoft.Windows.Update.Orchestrator.Install +## Winlogon events -This event sends launch data for a Windows Update install to help keep Windows up to date. +### Microsoft.Windows.Security.Winlogon.SetupCompleteLogon -The following fields are available: - -- **batteryLevel** Current battery capacity in mWh or percentage left. -- **deferReason** Reason for install not completing. -- **eventScenario** End to end update session ID. -- **interactive** Identifies if session is user initiated. -- **wuDeviceid** Unique device ID used by Windows Update. -- **flightUpdate** Flight update -- **installRebootinitiatetime** The time it took for a reboot to be attempted. -- **minutesToCommit** The time it took to install updates. -- **revisionNumber** Update revision number. -- **updateId** Update ID. -- **errorCode** The error code reppresented by a hexadecimal value. -- **installCommitfailedtime** The time it took for a reboot to happen but the upgrade failed to progress. -- **flightID** Unique update ID -- **ForcedRebootReminderSet** A boolean value that indicates if a forced reboot will happen for updates. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. -- **updateScenarioType** The update session type. +This event signals the completion of the setup process. It happens only once during the first logon. -### Microsoft.Windows.Update.Orchestrator.PreShutdownStart - -This event is generated right before the shutdown and commit operations - -The following fields are available: - -- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue -### Microsoft.Windows.Update.Orchestrator.DeferRestart - -This event indicates that a restart required for installing updates was postponed - -The following fields are available: - -- **filteredDeferReason** Indicates the raised, but ignorable, reasons that the USO didn't restart (for example, user active or low battery) -- **raisedDeferReason** Indicates the reason that the USO didn't restart. For example, user active or low battery -- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue -- **eventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed - - -### Microsoft.Windows.Update.Orchestrator.DisplayNeeded - -Reboot postponed due to needing a display - -The following fields are available: - -- **displayNeededReason** Reason the display is needed -- **eventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date -- **revisionNumber** Revision number of the update -- **updateId** Update ID -- **updateScenarioType** The update session type -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date -- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue - - -### Microsoft.Windows.Update.NotificationUx.RebootScheduled - -Indicates when a reboot is scheduled by the system or a user for a security, quality, or feature update - -The following fields are available: - -- **activeHoursApplicable** True, If Active Hours applicable on this device. False, otherwise -- **rebootArgument** Argument for the reboot task. It also represents specific reboot related action -- **rebootOutsideOfActiveHours** True, if a reboot is scheduled outside of active hours. False, otherwise -- **rebootScheduledByUser** True, if a reboot is scheduled by user. False, if a reboot is scheduled automatically -- **rebootState** The state of the reboot -- **revisionNumber** Revision number of the update that is getting installed with this reboot -- **scheduledRebootTime** Time of the scheduled reboot -- **updateId** ID of the update that is getting installed with this reboot -- **wuDeviceid** Unique device ID used by Windows Update -- **scheduledRebootTimeInUTC** Time of the scheduled reboot in Coordinated Universal Time diff --git a/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1803.md b/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1803.md index 84da766a22..55efbb3633 100644 --- a/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1803.md +++ b/windows/privacy/basic-level-windows-diagnostic-events-and-fields-1803.md @@ -1,27 +1,26 @@ --- description: Use this article to learn more about what Windows diagnostic data is gathered at the basic level. title: Windows 10, version 1803 basic diagnostic events and fields (Windows 10) -keywords: privacy, telemetry, diagnostic data +keywords: privacy, telemetry ms.prod: w10 ms.mktglfcycl: manage ms.sitesec: library ms.pagetype: security -ms.localizationpriority: high +localizationpriority: high author: brianlic-msft ms.author: brianlic -ms.date: 4/30/2018 +ms.date: 09/10/2018 --- # Windows 10, version 1803 basic level Windows diagnostic events and fields - **Applies to** - Windows 10, version 1803 -The Basic level gathers a limited set of information that is critical for understanding the device and its configuration including: basic device information, quality-related information, app compatibility, and Microsoft Store. When the level is set to Basic, it also includes the Security level information. +The Basic level gathers a limited set of information that is critical for understanding the device and its configuration including: basic device information, quality-related information, app compatibility, and Windows Store. When the level is set to Basic, it also includes the Security level information. The Basic level helps to identify problems that can occur on a particular device hardware or software configuration. For example, it can help determine if crashes are more frequent on devices with a specific amount of memory or that are running a particular driver version. This helps Microsoft fix operating system or app problems. @@ -33,227 +32,11 @@ You can learn more about Windows functional and diagnostic data through these ar - [Windows 10, version 1709 basic diagnostic events and fields](basic-level-windows-diagnostic-events-and-fields-1709.md) - [Windows 10, version 1703 basic diagnostic events and fields](basic-level-windows-diagnostic-events-and-fields-1703.md) - [Manage connections from Windows operating system components to Microsoft services](manage-connections-from-windows-operating-system-components-to-microsoft-services.md) -- [Manage Windows 10 connection endpoints](manage-windows-endpoints.md) - [Configure Windows diagnostic data in your organization](configure-windows-diagnostic-data-in-your-organization.md) -## Common data extensions - -### Common Data Extensions.App - - - -The following fields are available: - -- **expId** Associates a flight, such as an OS flight, or an experiment, such as a web site UX experiment, with an event. -- **userId** The userID as known by the application. -- **env** The environment from which the event was logged. -- **asId** An integer value that represents the app session. This value starts at 0 on the first app launch and increments after each subsequent app launch per boot session. -- **id** Represents a unique identifier of the client application currently loaded in the process producing the event; and is used to group events together and understand usage pattern, errors by application. -- **ver** Represents the version number of the application. Used to understand errors by Version, Usage by Version across an app. - - -### Common Data Extensions.CS - - - -The following fields are available: - -- **sig** A common schema signature that identifies new and modified event schemas. - - -### Common Data Extensions.CUET - - - -The following fields are available: - -- **stId** Represents the Scenario Entry Point ID. This is a unique GUID for each event in a diagnostic scenario. This used to be Scenario Trigger ID. -- **aId** Represents the ETW ActivityId. Logged via TraceLogging or directly via ETW. -- **raId** Represents the ETW Related ActivityId. Logged via TraceLogging or directly via ETW. -- **op** Represents the ETW Op Code. -- **cat** Represents a bitmask of the ETW Keywords associated with the event. -- **flags** Represents the bitmap that captures various Windows specific flags. -- **cpId** The composer ID, such as Reference, Desktop, Phone, Holographic, Hub, IoT Composer. -- **tickets** A list of strings that represent entries in the HTTP header of the web request that includes this event. -- **bseq** Upload buffer sequence number in the format \:\ -- **mon** Combined monitor and event sequence numbers in the format \:\ -- **epoch** Represents the epoch and seqNum fields, which help track how many events were fired and how many events were uploaded, and enables identification of data lost during upload and de-duplication of events on the ingress server. -- **seq** Represents the sequence field used to track absolute order of uploaded events. It is an incrementing identifier for each event added to the upload queue.  The Sequence helps track how many events were fired and how many events were uploaded and enables identification of data lost during upload and de-duplication of events on the ingress server. - - -### Common Data Extensions.Device - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **localId** Represents a locally defined unique ID for the device, not the human readable device name. Most likely equal to the value stored at HKLM\Software\Microsoft\SQMClient\MachineId -- **deviceClass** Represents the classification of the device, the device “family”.  For example, Desktop, Server, or Mobile. - - -### Common Data Extensions.Envelope - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **name** Represents the uniquely qualified name for the event. -- **time** Represents the event date time in Coordinated Universal Time (UTC) when the event was generated on the client. This should be in ISO 8601 format. -- **popSample** Represents the effective sample rate for this event at the time it was generated by a client. -- **iKey** Represents an ID for applications or other logical groupings of events. -- **flags** Represents a collection of bits that describe how the event should be processed by the Connected User Experience and Telemetry component pipeline. The lowest-order byte is the event persistence. The next byte is the event latency. -- **cV** Represents the Correlation Vector: A single field for tracking partial order of related telemetry events across component boundaries. - - -### Common Data Extensions.OS - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **expId** Represents the experiment ID. The standard for associating a flight, such as an OS flight (pre-release build), or an experiment, such as a web site UX experiment, with an event is to record the flight / experiment IDs in Part A of the common schema. -- **locale** Represents the locale of the operating system. -- **bootId** An integer value that represents the boot session. This value starts at 0 on first boot after OS install and increments after every reboot. -- **os** Represents the operating system name. -- **ver** Represents the OS version, and its format is OS dependent. - - -### Common Data Extensions.User - - - -The following fields are available: - -- **ver** Represents the major and minor version of the extension. -- **localId** Represents a unique user identity that is created locally and added by the client. This is not the user's account ID. - - -### Common Data Extensions.XBL - - - -The following fields are available: - -- **nbf** Not before time -- **expId** Expiration time -- **sbx** XBOX sandbox identifier -- **dty** XBOX device type -- **did** XBOX device ID -- **xid** A list of base10-encoded XBOX User IDs. -- **uts** A bit field, with 2 bits being assigned to each user ID listed in xid. This field is omitted if all users are retail accounts. - - -### Common Data Extensions.Consent UI Event - -This User Account Control (UAC) telemetry point collects information on elevations that originate from low integrity levels. This occurs when a process running at low integrity level (IL) requires higher (administrator) privileges, and therefore requests for elevation via UAC (consent.exe). By better understanding the processes requesting these elevations, Microsoft can in turn improve the detection and handling of potentially malicious behavior in this path. - -The following fields are available: - -- **eventType** Represents the type of elevation: If it succeeded, was cancelled, or was auto-approved. -- **splitToken** Represents the flag used to distinguish between administrators and standard users. -- **friendlyName** Represents the name of the file requesting elevation from low IL. -- **elevationReason** Represents the distinction between various elevation requests sources (appcompat, installer, COM, MSI and so on). -- **exeName** Represents the name of the file requesting elevation from low IL. -- **signatureState** Represents the state of the signature, if it signed, unsigned, OS signed and so on. -- **publisherName** Represents the name of the publisher of the file requesting elevation from low IL. -- **cmdLine** Represents the full command line arguments being used to elevate. -- **Hash.Length** Represents the length of the hash of the file requesting elevation from low IL. -- **Hash** Represents the hash of the file requesting elevation from low IL. -- **HashAlgId** Represents the algorithm ID of the hash of the file requesting elevation from low IL. -- **telemetryFlags** Represents the details about the elevation prompt for CEIP data. -- **timeStamp** Represents the time stamp on the file requesting elevation. -- **fileVersionMS** Represents the major version of the file requesting elevation. -- **fileVersionLS** Represents the minor version of the file requesting elevation. - - -## Common data fields - -### Common Data Fields.MS.Device.DeviceInventory.Change - -These fields are added whenever Ms.Device.DeviceInventoryChange is included in the event. - -The following fields are available: - -- **syncId** A string used to group StartSync, EndSync, Add, and Remove operations that belong together. This field is unique by Sync period and is used to disambiguate in situations where multiple agents perform overlapping inventories for the same object. -- **objectType** Indicates the object type that the event applies to. -- **Action** The change that was invoked on a device inventory object. -- **inventoryId** Device ID used for Compatibility testing - - -### Common Data Fields.TelClientSynthetic.PrivacySettingsAfterCreatorsUpdate.PreUpgradeSettings - -These fields are added whenever PreUpgradeSettings is included in the event. - -The following fields are available: - -- **HKLM_SensorPermissionState.SensorPermissionState** The state of the Location service before the feature update completed. -- **HKLM_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the device. -- **HKCU_SensorPermissionState.SensorPermissionState** The state of the Location service when a user signs on before the feature update completed. -- **HKCU_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the current user. -- **HKLM_LocationPlatform.Status** The state of the location platform after the feature update has completed. -- **HKLM_LocationPlatform.HRESULT** The error code returned when trying to query the location platform for the device. -- **HKLM_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the device before the feature update completed. -- **HKLM_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the device. -- **HKCU_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the current user before the feature update completed. -- **HKCU_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the current user. -- **HKLM_AllowTelemetry.AllowTelemetry** The state of the Connected User Experiences and Telemetry component for the device before the feature update. -- **HKLM_AllowTelemetry.HRESULT** The error code returned when trying to query the Connected User Experiences and Telemetry conponent for the device. -- **HKLM_TIPC.Enabled** The state of TIPC for the device. -- **HKLM_TIPC.HRESULT** The error code returned when trying to query TIPC for the device. -- **HKCU_TIPC.Enabled** The state of TIPC for the current user. -- **HKCU_TIPC.HRESULT** The error code returned when trying to query TIPC for the current user. -- **HKLM_FlipAhead.FPEnabled** Is Flip Ahead enabled for the device before the feature update was completed? -- **HKLM_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the device. -- **HKCU_FlipAhead.FPEnabled** Is Flip Ahead enabled for the current user before the feature update was completed? -- **HKCU_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the current user. -- **HKLM_TailoredExperiences.TailoredExperiencesWithDiagnosticDataEnabled** Is Tailored Experiences with Diagnostics Data enabled for the current user after the feature update had completed? -- **HKCU_TailoredExperiences.HRESULT** The error code returned when trying to query Tailored Experiences with Diagnostics Data for the current user. -- **HKLM_AdvertisingID.Enabled** Is the adveristing ID enabled for the device? -- **HKLM_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the device. -- **HKCU_AdvertisingID.Enabled** Is the adveristing ID enabled for the current user? -- **HKCU_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the user. - - -### Common Data Fields.TelClientSynthetic.PrivacySettingsAfterCreatorsUpdate.PostUpgradeSettings - -These fields are added whenever PostUpgradeSettings is included in the event. - -The following fields are available: - -- **HKLM_SensorPermissionState.SensorPermissionState** The state of the Location service after the feature update has completed. -- **HKLM_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the device. -- **HKCU_SensorPermissionState.SensorPermissionState** The state of the Location service when a user signs on after a feature update has completed. -- **HKCU_SensorPermissionState.HRESULT** The error code returned when trying to query the Location service for the current user. -- **HKLM_LocationPlatform.Status** The state of the location platform after the feature update has completed. -- **HKLM_LocationPlatform.HRESULT** The error code returned when trying to query the location platform for the device. -- **HKLM_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the device after the feature update has completed. -- **HKLM_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the device. -- **HKCU_LocationSyncEnabled.AcceptedPrivacyPolicy** The speech recognition state for the current user after the feature update has completed. -- **HKCU_LocationSyncEnabled.HRESULT** The error code returned when trying to query the Find My Device service for the current user. -- **HKLM_AllowTelemetry.AllowTelemetry** The state of the Connected User Experiences and Telemetry component for the device after the feature update. -- **HKLM_AllowTelemetry.HRESULT** The error code returned when trying to query the Connected User Experiences and Telemetry conponent for the device. -- **HKLM_TIPC.Enabled** The state of TIPC for the device. -- **HKLM_TIPC.HRESULT** The error code returned when trying to query TIPC for the device. -- **HKCU_TIPC.Enabled** The state of TIPC for the current user. -- **HKCU_TIPC.HRESULT** The error code returned when trying to query TIPC for the current user. -- **HKLM_FlipAhead.FPEnabled** Is Flip Ahead enabled for the device after the feature update has completed? -- **HKLM_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the device. -- **HKCU_FlipAhead.FPEnabled** Is Flip Ahead enabled for the current user after the feature update has completed? -- **HKCU_FlipAhead.HRESULT** The error code returned when trying to query Flip Ahead for the current user. -- **HKLM_TailoredExperiences.TailoredExperiencesWithDiagnosticDataEnabled** Is Tailored Experiences with Diagnostics Data enabled for the current user after the feature update had completed? -- **HKCU_TailoredExperiences.HRESULT** The error code returned when trying to query Tailored Experiences with Diagnostics Data for the current user. -- **HKLM_AdvertisingID.Enabled** Is the adveristing ID enabled for the device? -- **HKLM_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the device. -- **HKCU_AdvertisingID.Enabled** Is the adveristing ID enabled for the current user? -- **HKCU_AdvertisingID.HRESULT** The error code returned when trying to query the state of the advertising ID for the user. - - ## Appraiser events ### Microsoft.Windows.Appraiser.General.ChecksumTotalPictureCount @@ -262,143 +45,82 @@ This event lists the types of objects and how many of each exist on the client d The following fields are available: -- **PCFP** An ID for the system, calculated by hashing hardware identifiers. -- **SystemProcessorLahfSahf** The count of the number of this particular object type present on this device. -- **SystemProcessorCompareExchange** The count of the number of this particular object type present on this device. -- **SystemProcessorSse2** The count of the number of this particular object type present on this device. -- **SystemProcessorNx** The count of the number of this particular object type present on this device. -- **SystemWim** The count of the number of this particular object type present on this device. -- **SystemWlan** The count of the number of this particular object type present on this device. +- **DatasourceApplicationFile_RS1** An ID for the system, calculated by hashing hardware identifiers. +- **DatasourceApplicationFile_RS3** The total DecisionApplicationFile objects targeting the next release of Windows on this device. - **DatasourceDevicePnp_RS1** The total DataSourceDevicePnp objects targeting Windows 10 version 1607 on this device. -- **DecisionDevicePnp_RS1** The total DecisionDevicePnp objects targeting Windows 10 version 1607 on this device. -- **InventorySystemBios** The count of the number of this particular object type present on this device. -- **DataSourceMatchingInfoPostUpgrade_RS1** The total DataSourceMatchingInfoPostUpgrade objects targeting Windows 10 version 1607 on this device. -- **DecisionMatchingInfoPostUpgrade_RS1** The total DecisionMatchingInfoPostUpgrade objects targeting Windows 10 version 1607 on this device. -- **SystemMemory** The count of the number of this particular object type present on this device. -- **SystemProcessorPrefetchW** The count of the number of this particular object type present on this device. -- **DatasourceSystemBios_RS1** The total DatasourceSystemBios objects targeting Windows 10 version 1607 present on this device. -- **DecisionSystemBios_RS1** The total DecisionSystemBios objects targeting Windows 10 version 1607 on this device. -- **DataSourceMatchingInfoPassive_RS1** The total DataSourceMatchingInfoPassive objects targeting Windows 10 version 1607 on this device. -- **DecisionMatchingInfoPassive_RS1** The total DecisionMatchingInfoPassive objects targeting Windows 10 version 1607 on this device. -- **InventoryUplevelDriverPackage** The count of the number of this particular object type present on this device. -- **DatasourceDriverPackage_RS1** The total DataSourceDriverPackage objects targeting Windows 10 version 1607 on this device. -- **DecisionDriverPackage_RS1** The total DecisionDriverPackage objects targeting Windows 10 version 1607 on this device. -- **Wmdrm_RS1** An ID for the system, calculated by hashing hardware identifiers. -- **DecisionTest_RS1** An ID for the system, calculated by hashing hardware identifiers. -- **SystemWindowsActivationStatus** The count of the number of this particular object type present on this device. -- **SystemTouch** The count of the number of this particular object type present on this device. -- **InventoryApplicationFile** The count of the number of this particular object type present on this device. -- **InventoryLanguagePack** The count of InventoryLanguagePack objects present on this machine. -- **InventoryMediaCenter** The count of the number of this particular object type present on this device. -- **DatasourceSystemBios_RS3** The total DatasourceSystemBios objects targeting the next release of Windows on this device. -- **DecisionSystemBios_RS3** The total DecisionSystemBios objects targeting the next release of Windows on this device. -- **DatasourceApplicationFile_RS3** The total DecisionApplicationFile objects targeting the next release of Windows on this device. - **DatasourceDevicePnp_RS3** The total DatasourceDevicePnp objects targeting the next release of Windows on this device. +- **DatasourceDriverPackage_RS1** The total DataSourceDriverPackage objects targeting Windows 10 version 1607 on this device. - **DatasourceDriverPackage_RS3** The total DatasourceDriverPackage objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoBlock_RS3** The total DataSourceMatchingInfoBlock objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPassive objects targeting the next release of Windows on this device. -- **DataSourceMatchingInfoPostUpgrade_RS3** The total DataSourceMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. -- **DecisionApplicationFile_RS3** The total DecisionApplicationFile objects targeting the next release of Windows on this device. -- **DecisionDevicePnp_RS3** The total DecisionDevicePnp objects targeting the next release of Windows on this device. -- **DecisionDriverPackage_RS3** The total DecisionDriverPackage objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoBlock_RS3** The total DecisionMatchingInfoBlock objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPassive objects targeting the next release of Windows on this device. -- **DecisionMatchingInfoPostUpgrade_RS3** The total DecisionMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. -- **DecisionMediaCenter_RS3** The total DecisionMediaCenter objects targeting the next release of Windows on this device. -- **Wmdrm_RS3** The total Wmdrm objects targeting the next release of Windows on this device. -- **DatasourceApplicationFile_RS1** An ID for the system, calculated by hashing hardware identifiers. -- **DecisionApplicationFile_RS1** An ID for the system, calculated by hashing hardware identifiers. - **DataSourceMatchingInfoBlock_RS1** The total DataSourceMatchingInfoBlock objects targeting Windows 10 version 1607 on this device. +- **DataSourceMatchingInfoBlock_RS3** The total DataSourceMatchingInfoBlock objects targeting the next release of Windows on this device. +- **DataSourceMatchingInfoPassive_RS1** The total DataSourceMatchingInfoPassive objects targeting Windows 10 version 1607 on this device. +- **DataSourceMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPassive objects targeting the next release of Windows on this device. +- **DataSourceMatchingInfoPostUpgrade_RS1** The total DataSourceMatchingInfoPostUpgrade objects targeting Windows 10 version 1607 on this device. +- **DataSourceMatchingInfoPostUpgrade_RS3** The total DataSourceMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. +- **DatasourceSystemBios_RS1** The total DatasourceSystemBios objects targeting Windows 10 version 1607 present on this device. +- **DatasourceSystemBios_RS3** The total DatasourceSystemBios objects targeting the next release of Windows on this device. +- **DecisionApplicationFile_RS1** An ID for the system, calculated by hashing hardware identifiers. +- **DecisionApplicationFile_RS3** The total DecisionApplicationFile objects targeting the next release of Windows on this device. +- **DecisionDevicePnp_RS1** The total DecisionDevicePnp objects targeting Windows 10 version 1607 on this device. +- **DecisionDevicePnp_RS3** The total DecisionDevicePnp objects targeting the next release of Windows on this device. +- **DecisionDriverPackage_RS1** The total DecisionDriverPackage objects targeting Windows 10 version 1607 on this device. +- **DecisionDriverPackage_RS3** The total DecisionDriverPackage objects targeting the next release of Windows on this device. - **DecisionMatchingInfoBlock_RS1** The total DecisionMatchingInfoBlock objects targeting Windows 10 version 1607 present on this device. +- **DecisionMatchingInfoBlock_RS3** The total DecisionMatchingInfoBlock objects targeting the next release of Windows on this device. +- **DecisionMatchingInfoPassive_RS1** The total DecisionMatchingInfoPassive objects targeting Windows 10 version 1607 on this device. +- **DecisionMatchingInfoPassive_RS3** The total DataSourceMatchingInfoPassive objects targeting the next release of Windows on this device. +- **DecisionMatchingInfoPostUpgrade_RS1** The total DecisionMatchingInfoPostUpgrade objects targeting Windows 10 version 1607 on this device. +- **DecisionMatchingInfoPostUpgrade_RS3** The total DecisionMatchingInfoPostUpgrade objects targeting the next release of Windows on this device. - **DecisionMediaCenter_RS1** The total DecisionMediaCenter objects targeting Windows 10 version 1607 present on this device. +- **DecisionMediaCenter_RS3** The total DecisionMediaCenter objects targeting the next release of Windows on this device. +- **DecisionSystemBios_RS1** The total DecisionSystemBios objects targeting Windows 10 version 1607 on this device. +- **DecisionSystemBios_RS3** The total DecisionSystemBios objects targeting the next release of Windows on this device. +- **DecisionTest_RS1** An ID for the system, calculated by hashing hardware identifiers. +- **InventoryApplicationFile** The count of the number of this particular object type present on this device. +- **InventoryLanguagePack** The count of the number of this particular object type present on this device. +- **InventoryMediaCenter** The count of the number of this particular object type present on this device. +- **InventorySystemBios** The count of the number of this particular object type present on this device. +- **InventoryTest** The count of the number of this particular object type present on this device. +- **InventoryUplevelDriverPackage** The count of the number of this particular object type present on this device. +- **PCFP** An ID for the system, calculated by hashing hardware identifiers. +- **SystemMemory** The count of the number of this particular object type present on this device. +- **SystemProcessorCompareExchange** The count of the number of this particular object type present on this device. +- **SystemProcessorLahfSahf** The count of the number of this particular object type present on this device. +- **SystemProcessorNx** The count of SystemProcessorNx objects present on this machine. +- **SystemProcessorPrefetchW** The count of the number of this particular object type present on this device. +- **SystemProcessorSse2** The count of SystemProcessorSse2 objects present on this machine. +- **SystemTouch** The count of SystemTouch objects present on this machine. +- **SystemWim** The count of SystemWim objects present on this machine. +- **SystemWindowsActivationStatus** The count of SystemWindowsActivationStatus objects present on this machine. +- **SystemWlan** The count of SystemWlan objects present on this machine. +- **Wmdrm_RS1** An ID for the system, calculated by hashing hardware identifiers. +- **Wmdrm_RS3** The total Wmdrm objects targeting the next release of Windows on this device. -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockAdd +### Microsoft.Windows.Appraiser.General.DatasourceApplicationFileAdd -This event sends blocking data about any compatibility blocking entries hit on the system that are not directly related to specific applications or devices, to help keep Windows up-to-date. +Represents the basic metadata about specific application files installed on the system. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **AppraiserVersion** The version of the appraiser file generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockRemove - -This event indicates that the DataSourceMatchingInfoBlock object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockStartSync - -This event indicates that a full set of DataSourceMatchingInfoBlockStAdd events have been sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveAdd - -This event sends compatibility database information about non-blocking compatibility entries on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. - -The following fields are available: - -- **AppraiserVersion** The version of the appraiser file generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveRemove - -This event indicates that the DataSourceMatchingInfoPassive object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveStartSync - -This event indicates that a new set of DataSourceMatchingInfoPassiveAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeAdd - -This event sends compatibility database information about entries requiring reinstallation after an upgrade on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. - -The following fields are available: - -- **AppraiserVersion** The version of the appraiser file generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeRemove - -This event indicates that the DataSourceMatchingInfoPostUpgrade object is no longer present. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - - -### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeStartSync - -This event indicates that a new set of DataSourceMatchingInfoPostUpgradeAdd events will be sent. - -The following fields are available: - -- **AppraiserVersion** The version of the Appraiser file that is generating the events. - +- **AppraiserVersion** The version of the appraiser file that is generating the events. +- **AvDisplayName** If the app is an antivirus app, this is its display name. +- **CompatModelIndex** The compatibility prediction for this file. +- **HasCitData** Indicates whether the file is present in CIT data. +- **HasUpgradeExe** Indicates whether the anti-virus app has an upgrade.exe file. +- **IsAv** Is the file an antivirus reporting EXE? +- **ResolveAttempted** This will always be an empty string when sent. +- **SdbEntries** An array of fields that indicates the SDB entries that apply to this file. ### Microsoft.Windows.Appraiser.General.DatasourceApplicationFileRemove This event indicates that the DatasourceApplicationFile object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -408,6 +130,8 @@ The following fields are available: This event indicates that a new set of DatasourceApplicationFileAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -415,23 +139,26 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DatasourceDevicePnpAdd -This event sends compatibility data for a PNP device, to help keep Windows up-to-date. +This event sends compatibility data for a Plug and Play device, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **ActiveNetworkConnection** Is the device an active network device? +- **ActiveNetworkConnection** Indicates whether the device is an active network device. - **AppraiserVersion** The version of the appraiser file generating the events. -- **IsBootCritical** Is the device boot critical? -- **SdbEntries** An array of fields indicating the SDB entries that apply to this device. -- **WuDriverCoverage** Is there a driver uplevel for this device according to Windows Update? -- **WuDriverUpdateId** The Windows Update ID of the applicable uplevel driver -- **WuPopulatedFromId** The expected up-level driver matching ID based on driver coverage from Windows Update +- **IsBootCritical** Indicates whether the device boot is critical. +- **WuDriverCoverage** Indicates whether there is a driver uplevel for this device, according to Windows Update. +- **WuDriverUpdateId** The Windows Update ID of the applicable uplevel driver. +- **WuPopulatedFromId** The expected uplevel driver matching ID based on driver coverage from Windows Update. ### Microsoft.Windows.Appraiser.General.DatasourceDevicePnpRemove This event indicates that the DatasourceDevicePnp object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -441,6 +168,8 @@ The following fields are available: This event indicates that a new set of DatasourceDevicePnpAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -448,7 +177,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DatasourceDriverPackageAdd -This event sends compatibility database data about driver packages to help keep Windows up-to-date. +This event sends compatibility database data about driver packages to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -459,6 +190,8 @@ The following fields are available: This event indicates that the DatasourceDriverPackage object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -468,6 +201,107 @@ The following fields are available: This event indicates that a new set of DatasourceDriverPackageAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockAdd + +This event sends blocking data about any compatibility blocking entries hit on the system that are not directly related to specific applications or devices, to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the appraiser file generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockRemove + +This event indicates that the DataSourceMatchingInfoBlock object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoBlockStartSync + +This event indicates that a full set of DataSourceMatchingInfoBlockStAdd events have been sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveAdd + +This event sends compatibility database information about non-blocking compatibility entries on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the appraiser file generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveRemove + +This event indicates that the DataSourceMatchingInfoPassive object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPassiveStartSync + +This event indicates that a new set of DataSourceMatchingInfoPassiveAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeAdd + +This event sends compatibility database information about entries requiring reinstallation after an upgrade on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the appraiser file generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeRemove + +This event indicates that the DataSourceMatchingInfoPostUpgrade object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **AppraiserVersion** The version of the Appraiser file that is generating the events. + + +### Microsoft.Windows.Appraiser.General.DataSourceMatchingInfoPostUpgradeStartSync + +This event indicates that a new set of DataSourceMatchingInfoPostUpgradeAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -477,16 +311,19 @@ The following fields are available: This event sends compatibility database information about the BIOS to help keep Windows up-to-date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file generating the events. -- **SdbEntries** An array of fields indicating the SDB entries that apply to this BIOS. ### Microsoft.Windows.Appraiser.General.DatasourceSystemBiosRemove This event indicates that the DatasourceSystemBios object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -496,6 +333,8 @@ The following fields are available: This event indicates that a new set of DatasourceSystemBiosAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -505,11 +344,13 @@ The following fields are available: This event sends compatibility decision data about a file to help keep Windows up-to-date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: -- **AppraiserVersion** The version of the appraiser file generating the events. +- **AppraiserVersion** The version of the appraiser file that is generating the events. - **BlockAlreadyInbox** The uplevel runtime block on the file already existed on the current OS. -- **BlockingApplication** Are there any application issues that interfere with upgrade due to the file in question? +- **BlockingApplication** Indicates whether there are any application issues that interfere with the upgrade due to the file in question. - **DisplayGenericMessage** Will be a generic message be shown for this file? - **HardBlock** This file is blocked in the SDB. - **HasUxBlockOverride** Does the file have a block that is overridden by a tag in the SDB? @@ -530,7 +371,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionApplicationFileRemove -This event indicates that the DecisionApplicationFile object is no longer present. +This event indicates Indicates that the DecisionApplicationFile object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -541,6 +384,8 @@ The following fields are available: This event indicates that a new set of DecisionApplicationFileAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -548,7 +393,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionDevicePnpAdd -This event sends compatibility decision data about a PNP device to help keep Windows up-to-date. +This event sends compatibility decision data about a PNP device to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -574,6 +421,8 @@ The following fields are available: This event indicates that the DecisionDevicePnp object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -581,7 +430,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionDevicePnpStartSync -This event indicates that the DecisionDevicePnp object is no longer present. +The DecisionDevicePnpStartSync event indicates that a new set of DecisionDevicePnpAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -590,7 +441,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionDriverPackageAdd -This event sends decision data about driver package compatibility to help keep Windows up-to-date. +This event sends decision data about driver package compatibility to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -606,6 +459,8 @@ The following fields are available: This event indicates that the DecisionDriverPackage object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -615,6 +470,8 @@ The following fields are available: This event indicates that a new set of DecisionDriverPackageAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -622,7 +479,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoBlockAdd -This event sends compatibility decision data about blocking entries on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. +This event sends compatibility decision data about blocking entries on the system that are not keyed by either applications or devices, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -639,6 +498,8 @@ The following fields are available: This event indicates that the DecisionMatchingInfoBlock object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -648,6 +509,8 @@ The following fields are available: This event indicates that a new set of DecisionMatchingInfoBlockAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -657,6 +520,8 @@ The following fields are available: This event sends compatibility decision data about non-blocking entries on the system that are not keyed by either applications or devices, to help keep Windows up-to-date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -668,6 +533,8 @@ The following fields are available: This event Indicates that the DecisionMatchingInfoPassive object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -677,6 +544,8 @@ The following fields are available: This event indicates that a new set of DecisionMatchingInfoPassiveAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -684,7 +553,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionMatchingInfoPostUpgradeAdd -This event sends compatibility decision data about entries that require reinstall after upgrade. It's used to help keep Windows up-to-date. +This event sends compatibility decision data about entries that require reinstall after upgrade. It's used to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -699,6 +570,8 @@ The following fields are available: This event indicates that the DecisionMatchingInfoPostUpgrade object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -706,7 +579,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionMediaCenterAdd -This event sends decision data about the presence of Windows Media Center, to help keep Windows up-to-date. +This event sends decision data about the presence of Windows Media Center, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -723,6 +598,8 @@ The following fields are available: This event indicates that the DecisionMediaCenter object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -732,6 +609,8 @@ The following fields are available: This event indicates that a new set of DecisionMediaCenterAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -739,7 +618,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.DecisionSystemBiosAdd -This event sends compatibility decision data about the BIOS to help keep Windows up-to-date. +This event sends compatibility decision data about the BIOS to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -752,6 +633,8 @@ The following fields are available: This event indicates that the DecisionSystemBios object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -761,6 +644,8 @@ The following fields are available: This event indicates that a new set of DecisionSystemBiosAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -782,12 +667,14 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.InventoryApplicationFileAdd -This event represents the basic metadata about a file on the system. The file must be part of an app and either have a block in the compatibility database or are part of an anti-virus program. +This event represents the basic metadata about a file on the system. The file must be part of an app and either have a block in the compatibility database or be part of an antivirus program. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file generating the events. -- **BinaryType** A binary type. Example: UNINITIALIZED, ZERO_BYTE, DATA_ONLY, DOS_MODULE, NE16_MODULE, PE32_UNKNOWN, PE32_I386, PE32_ARM, PE64_UNKNOWN, PE64_AMD64, PE64_ARM64, PE64_IA64, PE32_CLR_32, PE32_CLR_IL, PE32_CLR_IL_PREFER32, PE64_CLR_64 +- **BinaryType** A binary type. Example: UNINITIALIZED, ZERO_BYTE, DATA_ONLY, DOS_MODULE, NE16_MODULE, PE32_UNKNOWN, PE32_I386, PE32_ARM, PE64_UNKNOWN, PE64_AMD64, PE64_ARM64, PE64_IA64, PE32_CLR_32, PE32_CLR_IL, PE32_CLR_IL_PREFER32, PE64_CLR_64. - **BinFileVersion** An attempt to clean up FileVersion at the client that tries to place the version into 4 octets. - **BinProductVersion** An attempt to clean up ProductVersion at the client that tries to place the version into 4 octets. - **BoeProgramId** If there is no entry in Add/Remove Programs, this is the ProgramID that is generated from the file metadata. @@ -807,6 +694,8 @@ The following fields are available: This event indicates that the InventoryApplicationFile object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -814,7 +703,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.InventoryApplicationFileStartSync -This event indicates that a new set of InventoryApplicationFileAdd events will be sent. +This event indicates indicates that a new set of InventoryApplicationFileAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -823,19 +714,23 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.InventoryLanguagePackAdd -This event sends data about the number of language packs installed on the system, to help keep Windows up-to-date. +This event sends data about the number of language packs installed on the system, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **HasLanguagePack** Does this device have 2 or more language packs? -- **LanguagePackCount** How many language packs are installed? +- **HasLanguagePack** Indicates whether this device has 2 or more language packs. +- **LanguagePackCount** The number of language packs are installed. ### Microsoft.Windows.Appraiser.General.InventoryLanguagePackRemove This event indicates that the InventoryLanguagePack object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -845,6 +740,8 @@ The following fields are available: This event indicates that a new set of InventoryLanguagePackAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -854,6 +751,8 @@ The following fields are available: This event sends true/false data about decision points used to understand whether Windows Media Center is used on the system, to help keep Windows up to date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file generating the events. @@ -870,6 +769,8 @@ The following fields are available: This event indicates that the InventoryMediaCenter object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -879,6 +780,8 @@ The following fields are available: This event indicates that a new set of InventoryMediaCenterAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -888,6 +791,8 @@ The following fields are available: This event sends basic metadata about the BIOS to determine whether it has a compatibility block. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -899,7 +804,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.InventorySystemBiosRemove -This event indicates that the InventorySystemBios object is no longer present. +This event indicates that the InventorySystemBios object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -910,6 +817,8 @@ The following fields are available: This event indicates that a new set of InventorySystemBiosAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -919,6 +828,8 @@ The following fields are available: This event indicates that the InventoryUplevelDriverPackage object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -928,6 +839,8 @@ The following fields are available: This event indicates that a new set of InventoryUplevelDriverPackageAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -935,7 +848,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.RunContext -This event indicates what should be expected in the data payload. +This event indicates what should be expected in the data payload. The following fields are available: @@ -951,6 +864,8 @@ The following fields are available: This event sends data on the amount of memory on the system and whether it meets requirements, to help keep Windows up-to-date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file generating the events. @@ -967,6 +882,8 @@ The following fields are available: This event that the SystemMemory object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -976,6 +893,8 @@ The following fields are available: This event indicates that a new set of SystemMemoryAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -985,6 +904,8 @@ The following fields are available: This event sends data indicating whether the system supports the CompareExchange128 CPU requirement, to help keep Windows up to date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file generating the events. @@ -994,7 +915,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemProcessorCompareExchangeRemove -This event indicates that the SystemProcessorCompareExchange object is no longer present. +This event indicates that the SystemProcessorCompareExchange object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1005,6 +928,8 @@ The following fields are available: This event indicates that a new set of SystemProcessorCompareExchangeAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1014,6 +939,8 @@ The following fields are available: This event sends data indicating whether the system supports the LahfSahf CPU requirement, to help keep Windows up-to-date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file generating the events. @@ -1023,7 +950,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemProcessorLahfSahfRemove -This event indicates that the SystemProcessorLahfSahf object is no longer present. +This event indicates that the SystemProcessorLahfSahf object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1034,6 +963,8 @@ The following fields are available: This event indicates that a new set of SystemProcessorLahfSahfAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1043,6 +974,8 @@ The following fields are available: This event sends data indicating whether the system supports the NX CPU requirement, to help keep Windows up-to-date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1055,6 +988,8 @@ The following fields are available: This event indicates that the SystemProcessorNx object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1064,6 +999,8 @@ The following fields are available: This event indicates that a new set of SystemProcessorNxAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1071,7 +1008,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemProcessorPrefetchWAdd -This event sends data indicating whether the system supports the PrefetchW CPU requirement, to help keep Windows up-to-date. +This event sends data indicating whether the system supports the PrefetchW CPU requirement, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1084,6 +1023,8 @@ The following fields are available: This event indicates that the SystemProcessorPrefetchW object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1093,6 +1034,8 @@ The following fields are available: This event indicates that a new set of SystemProcessorPrefetchWAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1100,7 +1043,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemProcessorSse2Add -This event sends data indicating whether the system supports the SSE2 CPU requirement, to help keep Windows up-to-date. +This event sends data indicating whether the system supports the SSE2 CPU requirement, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1113,6 +1058,8 @@ The following fields are available: This event indicates that the SystemProcessorSse2 object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1122,6 +1069,8 @@ The following fields are available: This event indicates that a new set of SystemProcessorSse2Add events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1129,7 +1078,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemTouchAdd -This event sends data indicating whether the system supports touch, to help keep Windows up-to-date. +This event sends data indicating whether the system supports touch, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1140,7 +1091,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemTouchRemove -This event indicates that the SystemTouch object is no longer present. +This event indicates that the SystemTouch object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1151,6 +1104,8 @@ The following fields are available: This event indicates that a new set of SystemTouchAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1158,7 +1113,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemWimAdd -This event sends data indicating whether the operating system is running from a compressed WIM file, to help keep Windows up-to-date. +This event sends data indicating whether the operating system is running from a compressed Windows Imaging Format (WIM) file, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1169,7 +1126,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemWimRemove -This event indicates that the SystemWim object is no longer present. +This event indicates that the SystemWim object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1180,6 +1139,8 @@ The following fields are available: This event indicates that a new set of SystemWimAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1187,7 +1148,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemWindowsActivationStatusAdd -This event sends data indicating whether the current operating system is activated, to help keep Windows up-to-date. +This event sends data indicating whether the current operating system is activated, to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1200,6 +1163,8 @@ The following fields are available: This event indicates that the SystemWindowsActivationStatus object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1209,6 +1174,8 @@ The following fields are available: This event indicates that a new set of SystemWindowsActivationStatusAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1216,7 +1183,9 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.SystemWlanRemove -This event indicates that the SystemWlan object is no longer present. +This event indicates that the SystemWlan object is no longer present. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -1227,6 +1196,8 @@ The following fields are available: This event indicates that a new set of SystemWlanAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1234,7 +1205,7 @@ The following fields are available: ### Microsoft.Windows.Appraiser.General.TelemetryRunHealth -A summary event indicating the parameters and result of a telemetry run. This allows the rest of the data sent over the course of the run to be properly contextualized and understood, which is then used to keep Windows up-to-date. +This event indicates the parameters and result of a telemetry (diagnostic) run. This allows the rest of the data sent over the course of the run to be properly contextualized and understood, which is then used to keep Windows up to date. The following fields are available: @@ -1242,7 +1213,7 @@ The following fields are available: - **AppraiserDataVersion** The version of the data files being used by the Appraiser telemetry run. - **AppraiserProcess** The name of the process that launched Appraiser. - **AppraiserVersion** The file version (major, minor and build) of the Appraiser DLL, concatenated without dots. -- **AuxFinal** Obsolete, always set to false +- **AuxFinal** Obsolete, always set to false. - **AuxInitial** Obsolete, indicates if Appraiser is writing data files to be read by the Get Windows 10 app. - **DeadlineDate** A timestamp representing the deadline date, which is the time until which appraiser will wait to do a full scan. - **EnterpriseRun** Indicates if the telemetry run is an enterprise run, which means appraiser was run from the command line with an extra enterprise parameter. @@ -1269,14 +1240,16 @@ The following fields are available: This event sends data about the usage of older digital rights management on the system, to help keep Windows up to date. This data does not indicate the details of the media using the digital rights management, only whether any such files exist. Collecting this data was critical to ensuring the correct mitigation for customers, and should be able to be removed once all mitigations are in place. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. -- **BlockingApplication** Same as NeedsDismissAction +- **BlockingApplication** Same as NeedsDismissAction. - **NeedsDismissAction** Indicates if a dismissible message is needed to warn the user about a potential loss of data due to DRM deprecation. - **WmdrmApiResult** Raw value of the API used to gather DRM state. - **WmdrmCdRipped** Indicates if the system has any files encrypted with personal DRM, which was used for ripped CDs. -- **WmdrmIndicators** WmdrmCdRipped OR WmdrmPurchased +- **WmdrmIndicators** WmdrmCdRipped OR WmdrmPurchased. - **WmdrmInUse** WmdrmIndicators AND dismissible block in setup was not dismissed. - **WmdrmNonPermanent** Indicates if the system has any files with non-permanent licenses. - **WmdrmPurchased** Indicates if the system has any files with permanent licenses. @@ -1286,6 +1259,8 @@ The following fields are available: This event indicates that the Wmdrm object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1295,6 +1270,8 @@ The following fields are available: This event indicates that a new set of WmdrmAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **AppraiserVersion** The version of the Appraiser file that is generating the events. @@ -1304,10 +1281,18 @@ The following fields are available: ### Census.App -This event sends version data about the Apps running on this device, to help keep Windows up to date. +Provides information on IE and Census versions running on the device. The following fields are available: +- **AppraiserEnterpriseErrorCode** The error code of the last Appraiser enterprise run. +- **AppraiserErrorCode** The error code of the last Appraiser run. +- **AppraiserRunEndTimeStamp** The end time of the last Appraiser run. +- **AppraiserRunIsInProgressOrCrashed** Flag that indicates if the Appraiser run is in progress or has crashed. +- **AppraiserRunStartTimeStamp** The start time of the last Appraiser run. +- **AppraiserTaskEnabled** Whether the Appraiser task is enabled. +- **AppraiserTaskExitCode** The Appraiser task exist code. +- **AppraiserTaskLastRun** The last runtime for the Appraiser task. - **CensusVersion** The version of Census that generated the current data for this device. - **IEVersion** Retrieves which version of Internet Explorer is running on this device. @@ -1341,6 +1326,7 @@ This event sends data about Azure presence, type, and cloud domain use in order The following fields are available: +- **AADDeviceId** Azure Active Directory device ID. - **AzureOSIDPresent** Represents the field used to identify an Azure machine. - **AzureVMType** Represents whether the instance is Azure VM PAAS, Azure VM IAAS or any other VMs. - **CDJType** Represents the type of cloud domain joined for the machine. @@ -1374,7 +1360,7 @@ The following fields are available: ### Census.Flighting -This event sends Windows Insider data from customers participating in improvement testing and feedback programs, to help keep Windows up-to-date. +This event sends Windows Insider data from customers participating in improvement testing and feedback programs, to help keep Windows up to date. The following fields are available: @@ -1389,7 +1375,7 @@ The following fields are available: ### Census.Hardware -This event sends data about the device, including hardware type, OEM brand, model line, model, telemetry level setting, and TPM support, to help keep Windows up-to-date. +This event sends data about the device, including hardware type, OEM brand, model line, model, telemetry level setting, and TPM support, to help keep Windows up to date. The following fields are available: @@ -1397,6 +1383,7 @@ The following fields are available: - **ChassisType** Represents the type of device chassis, such as desktop or low profile desktop. The possible values can range between 1 - 36. - **ComputerHardwareID** Identifies a device class that is represented by a hash of different SMBIOS fields. - **D3DMaxFeatureLevel** Supported Direct3D version. +- **DeviceColor** Indicates a color of the device. - **DeviceForm** Indicates the form as per the device classification. - **DeviceName** The device name that is set by the user. - **DigitizerSupport** Is a digitizer supported? @@ -1425,7 +1412,6 @@ The following fields are available: - **TelemetrySettingAuthority** Determines who set the telemetry level, such as GP, MDM, or the user. - **TPMVersion** The supported Trusted Platform Module (TPM) on the device. If no TPM is present, the value is 0. - **VoiceSupported** Does the device have a cellular radio capable of making voice calls? -- **DeviceColor** Indicates a color of the device. ### Census.Memory @@ -1470,7 +1456,7 @@ The following fields are available: - **ActivationChannel** Retrieves the retail license key or Volume license key for a machine. - **AssignedAccessStatus** Kiosk configuration mode. - **CompactOS** Indicates if the Compact OS feature from Win10 is enabled. -- **DeveloperUnlockStatus** Represents if a device has been developer unlocked by the user or Group Policy. +- **DeveloperUnlockStatus** Represents if a device has been developer unlocked by the user or Group Policy. - **DeviceTimeZone** The time zone that is set on the device. Example: Pacific Standard Time - **GenuineState** Retrieves the ID Value specifying the OS Genuine check. - **InstallationType** Retrieves the type of OS installation. (Clean, Upgrade, Reset, Refresh, Update). @@ -1505,38 +1491,42 @@ The following fields are available: ### Census.Processor -This event sends data about the processor (architecture, speed, number of cores, manufacturer, and model number), to help keep Windows up to date. +Provides information on several important data points about Processor settings. The following fields are available: - **KvaShadow** Microcode info of the processor. - **MMSettingOverride** Microcode setting of the processor. - **MMSettingOverrideMask** Microcode setting override of the processor. -- **ProcessorArchitecture** Processor architecture of the installed operating system. +- **PreviousUpdateRevision** Previous microcode revision. +- **ProcessorArchitecture** Retrieves the processor architecture of the installed operating system. - **ProcessorClockSpeed** Clock speed of the processor in MHz. - **ProcessorCores** Number of logical cores in the processor. - **ProcessorIdentifier** Processor Identifier of a manufacturer. - **ProcessorManufacturer** Name of the processor manufacturer. - **ProcessorModel** Name of the processor model. - **ProcessorPhysicalCores** Number of physical cores in the processor. -- **ProcessorUpdateRevision** Microcode revision. -- **ProcessorUpdateStatus** The status of the microcode update. +- **ProcessorUpdateRevision** Microcode revision +- **ProcessorUpdateStatus** Enum value that represents the processor microcode load status. - **SocketCount** Count of CPU sockets. - **SpeculationControl** If the system has enabled protections needed to validate the speculation control vulnerability. ### Census.Security -This event provides information on about security settings used to help keep Windows up-to-date and secure. +This event provides information on about security settings used to help keep Windows up to date and secure. The following fields are available: -- **AvailableSecurityProperties** This field helps to enumerate and report state on the relevant security properties for Device Guard +- **AvailableSecurityProperties** This field helps to enumerate and report state on the relevant security properties for Device Guard. - **CGRunning** Credential Guard isolates and hardens key system and user secrets against compromise, helping to minimize the impact and breadth of a Pass the Hash style attack in the event that malicious code is already running via a local or network based vector. This field tells if Credential Guard is running. -- **DGState** This field summarizes Device Guard state -- **HVCIRunning** Hypervisor Code Integrity (HVCI) enables Device Guard to help protect kernel mode processes and drivers from vulnerability exploits and zero days. HVCI uses the processor’s functionality to force all software running in kernel mode to safely allocate memory. This field tells if HVCI is running -- **RequiredSecurityProperties** This field describes the required security properties to enable virtualization-based security +- **DGState** This field summarizes the Device Guard state. +- **HVCIRunning** Hypervisor Code Integrity (HVCI) enables Device Guard to help protect kernel mode processes and drivers from vulnerability exploits and zero days. HVCI uses the processor’s functionality to force all software running in kernel mode to safely allocate memory. This field tells if HVCI is running. +- **IsSawGuest** Indicates whether the device is running as a Secure Admin Workstation Guest. +- **IsSawHost** Indicates whether the device is running as a Secure Admin Workstation Host. +- **RequiredSecurityProperties** Describes the required security properties to enable virtualization-based security. - **SecureBootCapable** Systems that support Secure Boot can have the feature turned off via BIOS. This field tells if the system is capable of running Secure Boot, regardless of the BIOS setting. +- **SModeState** The Windows S mode trail state. - **VBSState** Virtualization-based security (VBS) uses the hypervisor to help protect the kernel and other parts of the operating system. Credential Guard and Hypervisor Code Integrity (HVCI) both depend on VBS to isolate/protect secrets, and kernel-mode code integrity validation. VBS has a tri-state that can be Disabled, Enabled, or Running. @@ -1568,6 +1558,16 @@ The following fields are available: - **SystemVolumeTotalCapacity** Retrieves the size of the partition that the System volume is installed on in MB. +### Census.Userdefault + +This event sends data about the current user's default preferences for browser and several of the most popular extensions and protocols, to help keep Windows up to date. + +The following fields are available: + +- **DefaultApp** The current uer's default program selected for the following extension or protocol: .html, .htm, .jpg, .jpeg, .png, .mp3, .mp4, .mov, .pdf. +- **DefaultBrowserProgId** The ProgramId of the current user's default browser. + + ### Census.UserDisplay This event sends data about the logical/physical display size, resolution and number of internal/external displays, and VRAM on the system, to help keep Windows up to date. @@ -1602,16 +1602,6 @@ The following fields are available: - **SpeechInputLanguages** The Speech Input languages installed on the device. -### Census.Userdefault - -This event sends data about the current user's default preferences for browser and several of the most popular extensions and protocols, to help keep Windows up to date. - -The following fields are available: - -- **DefaultApp** The current uer's default program selected for the following extension or protocol: .html,.htm,.jpg,.jpeg,.png,.mp3,.mp4, .mov,.pdf -- **DefaultBrowserProgId** The ProgramId of the current user's default browser - - ### Census.VM This event sends data indicating whether virtualization is enabled on the device, and its various characteristics, to help keep Windows up to date. @@ -1650,11 +1640,11 @@ The following fields are available: - **OSWUAutoUpdateOptions** Retrieves the auto update settings on the device. - **UninstallActive** A flag that represents when a device has uninstalled a previous upgrade recently. - **UpdateServiceURLConfigured** Retrieves if the device is managed by Windows Server Update Services (WSUS). -- **WUDeferUpdatePeriod** Retrieves if deferral is set for Updates -- **WUDeferUpgradePeriod** Retrieves if deferral is set for Upgrades +- **WUDeferUpdatePeriod** Retrieves if deferral is set for Updates. +- **WUDeferUpgradePeriod** Retrieves if deferral is set for Upgrades. - **WUDODownloadMode** Retrieves whether DO is turned on and how to acquire/distribute updates Delivery Optimization (DO) allows users to deploy previously downloaded WU updates to other devices on the same network. - **WUMachineId** Retrieves the Windows Update (WU) Machine Identifier. -- **WUPauseState** Retrieves WU setting to determine if updates are paused +- **WUPauseState** Retrieves WU setting to determine if updates are paused. - **WUServer** Retrieves the HTTP(S) URL of the WSUS server that is used by Automatic Updates and API callers (by default). @@ -1666,102 +1656,279 @@ The following fields are available: - **XboxConsolePreferredLanguage** Retrieves the preferred language selected by the user on Xbox console. - **XboxConsoleSerialNumber** Retrieves the serial number of the Xbox console. -- **XboxLiveDeviceId** Retrieves the unique device id of the console. -- **XboxLiveSandboxId** Retrieves the developer sandbox id if the device is internal to MS. +- **XboxLiveDeviceId** Retrieves the unique device ID of the console. +- **XboxLiveSandboxId** Retrieves the developer sandbox ID if the device is internal to Microsoft. -## Deployment events +## Common data extensions -### DeploymentTelemetry.Deployment_End +### Common Data Extensions.app -Event to indicate that a Deployment 360 API has completed. +Describes the properties of the running application. This extension could be populated by a client app or a web app. The following fields are available: -- **ClientId** Client ID of user utilizing the D360 API -- **ErrorCode** Error code of action -- **FlightId** Flight being used -- **Mode** Phase in upgrade -- **RelatedCV** CV of any other related events -- **Result** End result of action +- **asId** An integer value that represents the app session. This value starts at 0 on the first app launch and increments after each subsequent app launch per boot session. +- **env** The environment from which the event was logged. +- **expId** Associates a flight, such as an OS flight, or an experiment, such as a web site UX experiment, with an event. +- **id** Represents a unique identifier of the client application currently loaded in the process producing the event; and is used to group events together and understand usage pattern, errors by application. +- **locale** The locale of the app. +- **name** The name of the app. +- **userId** The userID as known by the application. +- **ver** Represents the version number of the application. Used to understand errors by Version, Usage by Version across an app. + + +### Common Data Extensions.container + +Describes the properties of the container for events logged within a container. + +The following fields are available: + +- **epoch** An ID that's incremented for each SDK initialization. +- **localId** The device ID as known by the client. +- **osVer** The operating system version. +- **seq** An ID that's incremented for each event. +- **type** The container type. Examples: Process or VMHost + + +### Common Data Extensions.cs + +Describes properties related to the schema of the event. + +The following fields are available: + +- **sig** A common schema signature that identifies new and modified event schemas. + + +### Common Data Extensions.device + +Describes the device-related fields. + +The following fields are available: + +- **deviceClass** The device classification. For example, Desktop, Server, or Mobile. +- **localId** A locally-defined unique ID for the device. This is not the human-readable device name. Most likely equal to the value stored at HKLM\Software\Microsoft\SQMClient\MachineId +- **make** Device manufacturer. +- **model** Device model. + + +### Common Data Extensions.Envelope + +Represents an envelope that contains all of the common data extensions. + +The following fields are available: + +- **cV** Represents the Correlation Vector: A single field for tracking partial order of related telemetry events across component boundaries. +- **data** Represents the optional unique diagnostic data for a particular event schema. +- **ext_app** Describes the properties of the running application. This extension could be populated by either a client app or a web app. See [Common Data Extensions.app](#common-data-extensionsapp). +- **ext_container** Describes the properties of the container for events logged within a container. See [Common Data Extensions.container](#common-data-extensionscontainer). +- **ext_cs** Describes properties related to the schema of the event. See [Common Data Extensions.cs](#common-data-extensionscs). +- **ext_device** Describes the device-related fields. See [Common Data Extensions.device](#common-data-extensionsdevice). +- **ext_os** Describes the operating system properties that would be populated by the client. See [Common Data Extensions.os](#common-data-extensionsos). +- **ext_receipts** Describes the fields related to time as provided by the client for debugging purposes. See [Common Data Extensions.receipts](#common-data-extensionsreceipts). +- **ext_sdk** Describes the fields related to a platform library required for a specific SDK. See [Common Data Extensions.sdk](#common-data-extensionssdk). +- **ext_user** Describes the fields related to a user. See [Common Data Extensions.user](#common-data-extensionsuser). +- **ext_utc** Describes the fields that might be populated by a logging library on Windows. See [Common Data Extensions.utc](#common-data-extensionsutc). +- **ext_xbl** Describes the fields related to XBOX Live. See [Common Data Extensions.xbl](#common-data-extensionsxbl). +- **flags** Represents a collection of bits that describe how the event should be processed by the Connected User Experience and Telemetry component pipeline. The lowest-order byte is the event persistence. The next byte is the event latency. +- **iKey** Represents an ID for applications or other logical groupings of events. +- **name** Represents the uniquely qualified name for the event. +- **popSample** Represents the effective sample rate for this event at the time it was generated by a client. +- **time** Represents the event date time in Coordinated Universal Time (UTC) when the event was generated on the client. This should be in ISO 8601 format. +- **ver** Represents the major and minor version of the extension. + + +### Common Data Extensions.os + +Describes some properties of the operating system. + +The following fields are available: + +- **bootId** An integer value that represents the boot session. This value starts at 0 on first boot after OS install and increments after every reboot. +- **expId** Represents the experiment ID. The standard for associating a flight, such as an OS flight (pre-release build), or an experiment, such as a web site UX experiment, with an event is to record the flight / experiment IDs in Part A of the common schema. +- **locale** Represents the locale of the operating system. +- **name** Represents the operating system name. +- **ver** Represents the major and minor version of the extension. + + +### Common Data Extensions.receipts + +Represents various time information as provided by the client and helps for debugging purposes. + +The following fields are available: + +- **originalTime** The original event time. +- **uploadTime** The time the event was uploaded. + + +### Common Data Extensions.sdk + +Used by platform specific libraries to record fields that are required for a specific SDK. + +The following fields are available: + +- **epoch** An ID that is incremented for each SDK initialization. +- **installId** An ID that's created during the initialization of the SDK for the first time. +- **libVer** The SDK version. +- **seq** An ID that is incremented for each event. + + +### Common Data Extensions.user + +Describes the fields related to a user. + +The following fields are available: + +- **authId** This is an ID of the user associated with this event that is deduced from a token such as a Microsoft Account ticket or an XBOX token. +- **locale** The language and region. +- **localId** Represents a unique user identity that is created locally and added by the client. This is not the user's account ID. + + +### Common Data Extensions.utc + +Describes the properties that could be populated by a logging library on Windows. + +The following fields are available: + +- **aId** Represents the ETW ActivityId. Logged via TraceLogging or directly via ETW. +- **bSeq** Upload buffer sequence number in the format: buffer identifier:sequence number +- **cat** Represents a bitmask of the ETW Keywords associated with the event. +- **cpId** The composer ID, such as Reference, Desktop, Phone, Holographic, Hub, IoT Composer. +- **epoch** Represents the epoch and seqNum fields, which help track how many events were fired and how many events were uploaded, and enables identification of data lost during upload and de-duplication of events on the ingress server. +- **flags** Represents the bitmap that captures various Windows specific flags. +- **mon** Combined monitor and event sequence numbers in the format: monitor sequence : event sequence +- **op** Represents the ETW Op Code. +- **raId** Represents the ETW Related ActivityId. Logged via TraceLogging or directly via ETW. +- **seq** Represents the sequence field used to track absolute order of uploaded events. It is an incrementing identifier for each event added to the upload queue. The Sequence helps track how many events were fired and how many events were uploaded and enables identification of data lost during upload and de-duplication of events on the ingress server. +- **stId** Represents the Scenario Entry Point ID. This is a unique GUID for each event in a diagnostic scenario. This used to be Scenario Trigger ID. + + +### Common Data Extensions.xbl + +Describes the fields that are related to XBOX Live. + +The following fields are available: + +- **claims** Any additional claims whose short claim name hasn't been added to this structure. +- **did** XBOX device ID +- **dty** XBOX device type +- **dvr** The version of the operating system on the device. +- **eid** A unique ID that represents the developer entity. +- **exp** Expiration time +- **ip** The IP address of the client device. +- **nbf** Not before time +- **pid** A comma separated list of PUIDs listed as base10 numbers. +- **sbx** XBOX sandbox identifier +- **sid** The service instance ID. +- **sty** The service type. +- **tid** The XBOX Live title ID. +- **tvr** The XBOX Live title version. +- **uts** A bit field, with 2 bits being assigned to each user ID listed in xid. This field is omitted if all users are retail accounts. +- **xid** A list of base10-encoded XBOX User IDs. + + +## Common data fields + +### Ms.Device.DeviceInventoryChange + +Describes the installation state for all hardware and software components available on a particular device. + +The following fields are available: + +- **action** The change that was invoked on a device inventory object. +- **inventoryId** Device ID used for Compatibility testing +- **objectInstanceId** Object identity which is unique within the device scope. +- **objectType** Indicates the object type that the event applies to. +- **syncId** A string used to group StartSync, EndSync, Add, and Remove operations that belong together. This field is unique by Sync period and is used to disambiguate in situations where multiple agents perform overlapping inventories for the same object. + + +## Compatibility events + +### Microsoft.Windows.Compatibility.Apphelp.SdbFix + +Product instrumentation for helping debug/troubleshoot issues with inbox compatibility components. + +The following fields are available: + +- **AppName** Name of the application impacted by SDB. +- **FixID** SDB GUID. +- **Flags** List of flags applied. +- **ImageName** Name of file. + + +## Deployment extensions + +### DeploymentTelemetry.Deployment_End + +This event indicates that a Deployment 360 API has completed. + +The following fields are available: + +- **ClientId** Client ID of the user utilizing the D360 API. +- **ErrorCode** Error code of action. +- **FlightId** The specific ID of the Windows Insider build the device is getting. +- **Mode** Phase in upgrade. +- **RelatedCV** The correction vector (CV) of any other related events +- **Result** End result of the action. ### DeploymentTelemetry.Deployment_Initialize -Event to indicate that the Deployment 360 APIs have been initialized for use. +This event indicates that the Deployment 360 APIs have been initialized for use. The following fields are available: -- **ClientId** Client ID of user utilizing the D360 API -- **ErrorCode** Error code of action -- **FlightId** Flight being used -- **RelatedCV** CV of any other related events -- **Result** Phase Setup is in +- **ClientId** Client ID of user utilizing the D360 API. +- **ErrorCode** Error code of the action. +- **FlightId** The specific ID of the Windows Insider build the device is getting. +- **RelatedCV** The correlation vector of any other related events. +- **Result** End result of the action. ### DeploymentTelemetry.Deployment_SetupBoxLaunch -Event to indicate that the Deployment 360 APIs have launched Setup Box. +This event indicates that the Deployment 360 APIs have launched Setup Box. The following fields are available: -- **ClientId** Client ID of user utilizing the D360 API -- **FlightId** Flight being used -- **Quiet** Whether Setup will run in quiet mode or in full -- **RelatedCV** CV of any other related events -- **SetupMode** Phase Setup is in +- **ClientId** The client ID of the user utilizing the D360 API. +- **FlightId** The specific ID of the Windows Insider build the device is getting. +- **Quiet** Whether Setup will run in quiet mode or full mode. +- **RelatedCV** The correlation vector (CV) of any other related events. +- **SetupMode** The current setup phase. ### DeploymentTelemetry.Deployment_SetupBoxResult -Event to indicate that the Deployment 360 APIs have received a return from Setup Box. +This event indicates that the Deployment 360 APIs have received a return from Setup Box. The following fields are available: -- **ClientId** Client ID of user utilizing the D360 API -- **ErrorCode** Error code of action -- **FlightId** Flight being used -- **Quiet** Whether Setup will run in quiet mode or in full -- **RelatedCV** Correlation vector of any other related events -- **SetupMode** Phase that Setup is in +- **ClientId** Client ID of the user utilizing the D360 API. +- **ErrorCode** Error code of the action. +- **FlightId** The specific ID of the Windows Insider build the device is getting. +- **Quiet** Indicates whether Setup will run in quiet mode or full mode. +- **RelatedCV** The correlation vector (CV) of any other related events. +- **SetupMode** The current Setup phase. ### DeploymentTelemetry.Deployment_Start -Event to indicate that a Deployment 360 API has been called. +This event indicates that a Deployment 360 API has been called. The following fields are available: -- **ClientId** Client ID of user utilizing the D360 API -- **FlightId** Flight being used -- **Mode** Phase in upgrade -- **RelatedCV** CV of any other related events +- **ClientId** Client ID of the user utilizing the D360 API. +- **FlightId** The specific ID of the Windows Insider build the device is getting. +- **Mode** The current phase of the upgrade. +- **RelatedCV** The correlation vector (CV) of any other related events. ## Diagnostic data events -### TelClientSynthetic.AuthorizationInfo_RuntimeTransition - -Fired by UTC at state transitions to signal what data we are allowed to collect. - -The following fields are available: - -- **CanAddMsaToMsTelemetry** True if we can add MSA PUID and CID to telemetry, false otherwise. -- **CanCollectAnyTelemetry** True if we are allowed to collect partner telemetry, false otherwise. -- **CanCollectCoreTelemetry** True if we can collect CORE/Basic telemetry, false otherwise. -- **CanCollectHeartbeats** True if we can collect heartbeat telemetry, false otherwise. -- **CanCollectOsTelemetry** True if we can collect diagnostic data telemetry, false otherwise. -- **CanCollectWindowsAnalyticsEvents** True if we can collect Windows Analytics data, false otherwise. -- **CanPerformDiagnosticEscalations** True if we can perform diagnostic escalation collection, false otherwise. -- **CanPerformTraceEscalations** True if we can perform trace escalation collection, false otherwise. -- **CanReportScenarios** True if we can report scenario completions, false otherwise. -- **PreviousPermissions** Bitmask of previous telemetry state. -- **TransitionFromEverythingOff** True if we are transitioning from all telemetry being disabled, false otherwise. - - ### TelClientSynthetic.AuthorizationInfo_Startup -Fired by UTC at startup to signal what data we are allowed to collect. +This event sends data indicating that a device has undergone a change of telemetry opt-in level detected at UTC startup, to help keep Windows up to date. The telemetry opt-in level signals what data we are allowed to collect. The following fields are available: @@ -1780,18 +1947,18 @@ The following fields are available: ### TelClientSynthetic.HeartBeat_5 -Fired by UTC as a heartbeat signal. +This event sends data about the health and quality of the diagnostic data from the given device, to help keep Windows up to date. It also enables data analysts to determine how 'trusted' the data is from a given device. The following fields are available: - **AgentConnectionErrorsCount** Number of non-timeout errors associated with the host/agent channel. -- **CensusExitCode** Last exit code of Census task. +- **CensusExitCode** The last exit code of the Census task. - **CensusStartTime** Time of last Census run. - **CensusTaskEnabled** True if Census is enabled, false otherwise. - **CompressedBytesUploaded** Number of compressed bytes uploaded. - **ConsumerDroppedCount** Number of events dropped at consumer layer of telemetry client. - **CriticalDataDbDroppedCount** Number of critical data sampled events dropped at the database layer. -- **CriticalDataThrottleDroppedCount** Number of critical data sampled events dropped due to�throttling. +- **CriticalDataThrottleDroppedCount** The number of critical data sampled events that were dropped because of throttling. - **CriticalOverflowEntersCounter** Number of times critical overflow mode was entered in event DB. - **DbCriticalDroppedCount** Total number of dropped critical events in event DB. - **DbDroppedCount** Number of events dropped due to DB fullness. @@ -1802,6 +1969,9 @@ The following fields are available: - **EtwDroppedBufferCount** Number of buffers dropped in the UTC ETW session. - **EtwDroppedCount** Number of events dropped at ETW layer of telemetry client. - **EventsPersistedCount** Number of events that reached the PersistEvent stage. +- **EventStoreLifetimeResetCounter** Number of times event DB was reset for the lifetime of UTC. +- **EventStoreResetCounter** Number of times event DB was reset. +- **EventStoreResetSizeSum** Total size of event DB across all resets reports in this instance. - **EventSubStoreResetCounter** Number of times event DB was reset. - **EventSubStoreResetSizeSum** Total size of event DB across all resets reports in this instance. - **EventsUploaded** Number of events uploaded. @@ -1812,41 +1982,38 @@ The following fields are available: - **LastAgentConnectionError** Last non-timeout error encountered in the host/agent channel. - **LastEventSizeOffender** Event name of last event which exceeded max event size. - **LastInvalidHttpCode** Last invalid HTTP code received from Vortex. -- **MaxActiveAgentConnectionCount** Maximum number of active agents during this heartbeat timeframe. +- **MaxActiveAgentConnectionCount** The maximum number of active agents during this heartbeat timeframe. - **MaxInUseScenarioCounter** Soft maximum number of scenarios loaded by UTC. - **PreviousHeartBeatTime** Time of last heartbeat event (allows chaining of events). - **SettingsHttpAttempts** Number of attempts to contact OneSettings service. -- **SettingsHttpFailures** Number of failures from contacting OneSettings service. +- **SettingsHttpFailures** The number of failures from contacting the OneSettings service. - **ThrottledDroppedCount** Number of events dropped due to throttling of noisy providers. - **UploaderDroppedCount** Number of events dropped at the uploader layer of telemetry client. -- **VortexFailuresTimeout** Number of time out failures received from Vortex. +- **VortexFailuresTimeout** The number of timeout failures received from Vortex. - **VortexHttpAttempts** Number of attempts to contact Vortex. - **VortexHttpFailures4xx** Number of 400-499 error codes received from Vortex. - **VortexHttpFailures5xx** Number of 500-599 error codes received from Vortex. - **VortexHttpResponseFailures** Number of Vortex responses that are not 2XX or 400. - **VortexHttpResponsesWithDroppedEvents** Number of Vortex responses containing at least 1 dropped event. -- **EventStoreLifetimeResetCounter** Number of times event DB was reset for the lifetime of UTC. -- **EventStoreResetCounter** Number of times event DB was reset. -- **EventStoreResetSizeSum** Total size of event DB across all resets reports in this instance. ### TelClientSynthetic.HeartBeat_Aria_5 -Telemetry client ARIA heartbeat event. +This event is the telemetry client ARIA heartbeat. The following fields are available: - **CompressedBytesUploaded** Number of compressed bytes uploaded. - **CriticalDataDbDroppedCount** Number of critical data sampled events dropped at the database layer. -- **CriticalOverflowEntersCounter** Number of times critical overflow mode was entered in event DB. -- **DbCriticalDroppedCount** Total number of dropped critical events in event DB. -- **DbDroppedCount** Number of events dropped at the DB layer. -- **DbDroppedFailureCount** Number of events dropped due to DB failures. -- **DbDroppedFullCount** Number of events dropped due to DB fullness. +- **CriticalOverflowEntersCounter** Number of times critical overflow mode was entered in event database. +- **DbCriticalDroppedCount** Total number of dropped critical events in event database. +- **DbDroppedCount** Number of events dropped at the database layer. +- **DbDroppedFailureCount** Number of events dropped due to database failures. +- **DbDroppedFullCount** Number of events dropped due to database being full. - **EnteringCriticalOverflowDroppedCounter** Number of events dropped due to critical overflow mode being initiated. - **EventsPersistedCount** Number of events that reached the PersistEvent stage. -- **EventSubStoreResetCounter** Number of times event DB was reset. -- **EventSubStoreResetSizeSum** Total size of event DB across all resets reports in this instance. +- **EventSubStoreResetCounter** Number of times event database was reset. +- **EventSubStoreResetSizeSum** Total size of event database across all resets reports in this instance. - **EventsUploaded** Number of events uploaded. - **HeartBeatSequenceNumber** The sequence number of this heartbeat. - **InvalidHttpCodeCount** Number of invalid HTTP codes received from contacting Vortex. @@ -1854,7 +2021,7 @@ The following fields are available: - **LastInvalidHttpCode** Last invalid HTTP code received from Vortex. - **PreviousHeartBeatTime** The FILETIME of the previous heartbeat fire. - **SettingsHttpAttempts** Number of attempts to contact OneSettings service. -- **SettingsHttpFailures** Number of failures from contacting OneSettings service. +- **SettingsHttpFailures** Number of failures from contacting OneSettings service. - **UploaderDroppedCount** Number of events dropped at the uploader layer of telemetry client. - **VortexFailuresTimeout** Number of time out failures received from Vortex. - **VortexHttpAttempts** Number of attempts to contact Vortex. @@ -1864,21 +2031,11 @@ The following fields are available: - **VortexHttpResponsesWithDroppedEvents** Number of Vortex responses containing at least 1 dropped event. -### TelClientSynthetic.PrivacySettingsAfterCreatorsUpdate - -This event sends basic data on privacy settings before and after a feature update. This is used to ensure that customer privacy settings are correctly migrated across feature updates. - -The following fields are available: - -- **PostUpgradeSettings** The privacy settings after a feature update. -- **PreUpgradeSettings** The privacy settings before a feature update. - - ## Direct to update events ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorCheckApplicability -Event to indicate that the Coordinator CheckApplicability call succeeded. +This event indicates that the Coordinator CheckApplicability call succeeded. The following fields are available: @@ -1891,11 +2048,36 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorCheckApplicabilityGenericFailure -Event to indicate that we have received an unexpected error in the DTU Coordinators CheckApplicability call. +This event indicatse that we have received an unexpected error in the Direct to Update (DTU) Coordinators CheckApplicability call. The following fields are available: +- **CampaignID** ID of the campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. - **hResult** HRESULT of the failure. + + +### Microsoft.Windows.DirectToUpdate.DTUCoordinatorCleanupGenericFailure + +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Coordinator Cleanup call. + +The following fields are available: + +- **CampaignID** Campaign ID being run. +- **ClientID** Client ID being run. +- **CoordinatorVersion** Coordinator version of DTU. +- **CV** Correlation vector. +- **hResult** HRESULT of the failure. + + +### Microsoft.Windows.DirectToUpdate.DTUCoordinatorCleanupSuccess + +This event indicates that the Coordinator Cleanup call succeeded. + +The following fields are available: + - **CampaignID** Campaign ID being run. - **ClientID** Client ID being run. - **CoordinatorVersion** Coordinator version of DTU. @@ -1904,20 +2086,20 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorCommitGenericFailure -Commit call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Coordinator Commit call. The following fields are available: -- **hResult** HRESULT of the failure. - **CampaignID** Campaign ID being run. - **ClientID** Client ID being run. - **CoordinatorVersion** Coordinator version of DTU. - **CV** Correlation vector. +- **hResult** HRESULT of the failure. ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorCommitSuccess -Event to indicate that the Coordinator Commit call succeeded. +This event indicates that the Coordinator Commit call succeeded. The following fields are available: @@ -1929,7 +2111,7 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorDownloadGenericFailure -Event to indicate that we have received an unexpected error in the DTU Coordinator Download call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Coordinator Download call. The following fields are available: @@ -1942,7 +2124,7 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorDownloadIgnoredFailure -Event to indicate that we have received an error in the DTU Coordinator Download call that will be ignored. +This event indicates that we have received an error in the Direct to Update (DTU) Coordinator Download call that will be ignored. The following fields are available: @@ -1955,7 +2137,7 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorDownloadSuccess -Event to indicate that the Coordinator Download call succeeded. +This event indicates that the Coordinator Download call succeeded. The following fields are available: @@ -1967,7 +2149,7 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorHandleShutdownGenericFailure -Event to indicate that we have received an unexpected error in the DTU Coordinator HandleShutdown call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Coordinator HandleShutdown call. The following fields are available: @@ -1980,7 +2162,7 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorHandleShutdownSuccess -Event to indicate that the Coordinator HandleShutdown call succeeded. +This event indicates that the Coordinator HandleShutdown call succeeded. The following fields are available: @@ -1992,20 +2174,20 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorInitializeGenericFailure -Event to indicate that we have received an unexpected error in the DTU Coordinator Initialize call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Coordinator Initialize call. The following fields are available: -- **hResult** HRESULT of the failure. - **CampaignID** Campaign ID being run. - **ClientID** Client ID being run. - **CoordinatorVersion** Coordinator version of DTU. - **CV** Correlation vector. +- **hResult** HRESULT of the failure. ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorInitializeSuccess -Event to indicate that the Coordinator Initialize call succeeded. +This event indicates that the Coordinator Initialize call succeeded. The following fields are available: @@ -2017,7 +2199,7 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorInstallGenericFailure -Event to indicate that we have received an unexpected error in the DTU Coordinator Install call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Coordinator Install call. The following fields are available: @@ -2030,7 +2212,7 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorInstallIgnoredFailure -Event to indicate that we have received an error in the DTU Coordinator Install call that will be ignored. +This event indicates that we have received an error in the Direct to Update (DTU) Coordinator Install call that will be ignored. The following fields are available: @@ -2043,7 +2225,7 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorInstallSuccess -Event to indicate that the Coordinator Install call succeeded. +This event indicates that the Coordinator Install call succeeded. The following fields are available: @@ -2055,21 +2237,20 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorProgressCallBack -Event to indicate Coordinator's progress callback has been called. +This event indicates that the Coordinator's progress callback has been called. The following fields are available: -- **Current Deploy Phase's percentage completed** Trigger which fired UXLauncher. -- **DeployPhase** Current Deploy Phase. - **CampaignID** Campaign ID being run. - **ClientID** Client ID being run. - **CoordinatorVersion** Coordinator version of DTU. - **CV** Correlation vector. +- **DeployPhase** Current Deploy Phase. ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorSetCommitReadyGenericFailure -Event to indicate that we have received an unexpected error in the DTU Coordinator SetCommitReady call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Coordinator SetCommitReady call. The following fields are available: @@ -2082,19 +2263,19 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorSetCommitReadySuccess -Event to indicate that the Coordinator SetCommitReady call succeeded. +This event indicates that the Coordinator SetCommitReady call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run. -- **ClientID** Client ID being run. -- **CoordinatorVersion** Coordinator version of DTU. +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. - **CV** Correlation vector. ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorWaitForRebootUiGenericFailure -Event to indicate that we have received an unexpected error in the DTU Coordinator WaitForRebootUi call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Coordinator WaitForRebootUi call. The following fields are available: @@ -2107,99 +2288,99 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorWaitForRebootUiNotShown -Event to indicate that the Coordinator WaitForRebootUi call succeeded. +This event indicates that the Coordinator WaitForRebootUi call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **hResult** HRESULT of the failure +- **CampaignID** Campaign ID being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **hResult** HRESULT of the failure. ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorWaitForRebootUiSelection -Event to indicate the user selected an option on the Reboot UI. +This event indicates that the user selected an option on the Reboot UI. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **rebootUiSelection** Selection on the Reboot UI +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **rebootUiSelection** Selection on the Reboot UI. ### Microsoft.Windows.DirectToUpdate.DTUCoordinatorWaitForRebootUiSuccess -Event to indicate that the Coordinator WaitForRebootUi call succeeded. +This event indicates that the Coordinator WaitForRebootUi call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. ### Microsoft.Windows.DirectToUpdate.DTUHandlerCheckApplicabilityGenericFailure -Event to indicate that we have received an unexpected error in the DTU Handler CheckApplicability call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Handler CheckApplicability call. The following fields are available: -- **hResult** HRESULT of the failure - **CampaignID** Campaign ID being run - **ClientID** Client ID being run - **CoordinatorVersion** Coordinator version of DTU - **CV** Correlation vector - **CV_new** New correlation vector +- **hResult** HRESULT of the failure ### Microsoft.Windows.DirectToUpdate.DTUHandlerCheckApplicabilityInternalGenericFailure -Event to indicate that we have received an unexpected error in the DTU Handler CheckApplicabilityInternal call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Handler CheckApplicabilityInternal call. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **hResult** HRESULT of the failure +- **CampaignID** ID of the campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **hResult** HRESULT of the failure. ### Microsoft.Windows.DirectToUpdate.DTUHandlerCheckApplicabilityInternalSuccess -Event to indicate that the Handler CheckApplicabilityInternal call succeeded. +This event indicates that the Handler CheckApplicabilityInternal call succeeded. The following fields are available: -- **ApplicabilityResult** Result of CheckApplicability function -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector +- **ApplicabilityResult** The result of the applicability check. +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. ### Microsoft.Windows.DirectToUpdate.DTUHandlerCheckApplicabilitySuccess -Event to indicate that the Handler CheckApplicability call succeeded. +This event indicates that the Handler CheckApplicability call succeeded. The following fields are available: -- **ApplicabilityResult** Result of CheckApplicability function -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **CV_new** New correlation vector +- **ApplicabilityResult** The result code indicating whether the update is applicable. +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **CV_new** New correlation vector. ### Microsoft.Windows.DirectToUpdate.DTUHandlerCheckIfCoordinatorMinApplicableVersionGenericFailure -Event to indicate that we have received an unexpected error in the DTU Handler CheckIfCoordinatorMinApplicableVersion call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Handler CheckIfCoordinatorMinApplicableVersion call. The following fields are available: @@ -2212,47 +2393,47 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUHandlerCheckIfCoordinatorMinApplicableVersionSuccess -Event to indicate that the Handler CheckIfCoordinatorMinApplicableVersion call succeeded. +This event indicates that the Handler CheckIfCoordinatorMinApplicableVersion call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run -- **CheckIfCoordinatorMinApplicableVersionResult** Result of CheckIfCoordinatorMinApplicableVersion function -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector +- **CampaignID** ID of the update campaign being run. +- **CheckIfCoordinatorMinApplicableVersionResult** Result of CheckIfCoordinatorMinApplicableVersion function. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. ### Microsoft.Windows.DirectToUpdate.DTUHandlerCommitGenericFailure -Event to indicate that we have received an unexpected error in the DTU Handler Commit call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Handler Commit call. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **CV_new** New correlation vector -- **hResult** HRESULT of the failure +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **CV_new** New correlation vector. +- **hResult** HRESULT of the failure. ### Microsoft.Windows.DirectToUpdate.DTUHandlerCommitSuccess -Event to indicate that the Handler Commit call succeeded. +This event indicates that the Handler Commit call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **CV_new** New correlation vector +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **CV_new** New correlation vector. ### Microsoft.Windows.DirectToUpdate.DTUHandlerDownloadAndExtractCabAlreadyDownloaded -Event to indicate that the Handler Download and Extract cab returned a value indicating that the cab trying to be downloaded has already been downloaded. +This event indicates that the Handler Download and Extract cab returned a value indicating that the cab has already been downloaded. The following fields are available: @@ -2264,199 +2445,215 @@ The following fields are available: ### Microsoft.Windows.DirectToUpdate.DTUHandlerDownloadAndExtractCabFailure -Event to indicate that the Handler Download and Extract cab call failed. +This event indicates that the Handler Download and Extract cab call failed. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **DownloadAndExtractCabFunction_failureReason** Reason why the DownloadAndExtractCab function failed -- **hResult** HRESULT of the failure +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **DownloadAndExtractCabFunction_failureReason** Reason why the update download and extract process failed. +- **hResult** HRESULT of the failure. ### Microsoft.Windows.DirectToUpdate.DTUHandlerDownloadAndExtractCabSuccess -Event to indicate that the Handler Download and Extract cab call succeeded. +This event indicates that the Handler Download and Extract cab call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. ### Microsoft.Windows.DirectToUpdate.DTUHandlerDownloadGenericFailure -Event to indicate that we have received an unexpected error in the DTU Handler Download call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Handler Download call. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **hResult** HRESULT of the failure +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **hResult** HRESULT of the failure. ### Microsoft.Windows.DirectToUpdate.DTUHandlerDownloadSuccess -Event to indicate that the Handler Download call succeeded. +This event indicates that the Handler Download call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. ### Microsoft.Windows.DirectToUpdate.DTUHandlerInitializeGenericFailure -Event to indicate that we have received an unexpected error in the DTU Handler Initialize call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Handler Initialize call. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **DownloadAndExtractCabFunction_hResult** HRESULT of the DownloadAndExtractCab function -- **hResult** HRESULT of the failure +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **DownloadAndExtractCabFunction_hResult** HRESULT of the download and extract. +- **hResult** HRESULT of the failure. ### Microsoft.Windows.DirectToUpdate.DTUHandlerInitializeSuccess -Event to indicate that the Handler Initialize call succeeded. +This event indicates that the Handler Initialize call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **DownloadAndExtractCabFunction_hResult** HRESULT of the DownloadAndExtractCab function +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **DownloadAndExtractCabFunction_hResult** HRESULT of the download and extraction. ### Microsoft.Windows.DirectToUpdate.DTUHandlerInstallGenericFailure -Event to indicate that we have received an unexpected error in the DTU Handler Install call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Handler Install call. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector -- **hResult** HRESULT of the failure +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **hResult** HRESULT of the failure. ### Microsoft.Windows.DirectToUpdate.DTUHandlerInstallSuccess -Event to indicate that the Coordinator Install call succeeded. +This event indicates that the Coordinator Install call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector +- **CampaignID** ID of the update campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. ### Microsoft.Windows.DirectToUpdate.DTUHandlerSetCommitReadyGenericFailure -Event to indicate that we have received an unexpected error in the DTU Handler SetCommitReady call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Handler SetCommitReady call. The following fields are available: -- **hResult** HRESULT of the failure - **CampaignID** Campaign ID being run - **ClientID** Client ID being run - **CoordinatorVersion** Coordinator version of DTU - **CV** Correlation vector +- **hResult** HRESULT of the failure ### Microsoft.Windows.DirectToUpdate.DTUHandlerSetCommitReadySuccess -Event to indicate that the Handler SetCommitReady call succeeded. +This event indicates that the Handler SetCommitReady call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector +- **CampaignID** ID of the campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. ### Microsoft.Windows.DirectToUpdate.DTUHandlerWaitForRebootUiGenericFailure -Event to indicate that we have received an unexpected error in the DTU Handler WaitForRebootUi call. +This event indicates that we have received an unexpected error in the Direct to Update (DTU) Handler WaitForRebootUi call. The following fields are available: -- **hResult** HRESULT of the failure -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector +- **CampaignID** The ID of the campaigning being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. +- **hResult** The HRESULT of the failure. ### Microsoft.Windows.DirectToUpdate.DTUHandlerWaitForRebootUiSuccess -Event to indicate that the Handler WaitForRebootUi call succeeded. +This event indicates that the Handler WaitForRebootUi call succeeded. The following fields are available: -- **CampaignID** Campaign ID being run -- **ClientID** Client ID being run -- **CoordinatorVersion** Coordinator version of DTU -- **CV** Correlation vector +- **CampaignID** ID of the campaign being run. +- **ClientID** ID of the client receiving the update. +- **CoordinatorVersion** Coordinator version of Direct to Update. +- **CV** Correlation vector. ## Feature update events ### Microsoft.Windows.Upgrade.Uninstall.UninstallFailed -This event sends diagnostic data about failures when uninstalling a feature update, to help resolve any issues preventing customers from reverting to a known state +This event sends diagnostic data about failures when uninstalling a feature update, to help resolve any issues preventing customers from reverting to a known state. The following fields are available: -- **failureReason** Provides data about the uninstall initialization operation failure -- **hr** Provides the Win32 error code for the operation failure +- **failureReason** Provides data about the uninstall initialization operation failure. +- **hr** Provides the Win32 error code for the operation failure. ### Microsoft.Windows.Upgrade.Uninstall.UninstallFinalizedAndRebootTriggered -Indicates that the uninstall was properly configured and that a system reboot was initiated +This event indicates that the uninstall was properly configured and that a system reboot was initiated. ### Microsoft.Windows.Upgrade.Uninstall.UninstallGoBackButtonClicked -This event sends basic metadata about the starting point of uninstalling a feature update which helps us ensure customers can safely revert to a well-known state if the update caused any problems. +This event sends basic metadata about the starting point of uninstalling a feature update, which helps ensure customers can safely revert to a well-known state if the update caused any problems. + ## Inventory events ### Microsoft.Windows.Inventory.Core.AmiTelCacheChecksum -This event captures basic checksum data about the device inventory items stored in the cache for use in validating data completeness for Microsoft.Windows.Inventory.Core events. The fields in this event may change over time, but they will always represent a count of a given object. +This event captures basic checksum data about the device inventory items stored in the cache for use in validating data completeness for Microsoft.Windows.Inventory.Core events. The fields in this event may change over time, but they will always represent a count of a given object. The following fields are available: -- **DriverPackageExtended** A count of driverpackageextended objects in cache -- **FileSigningInfo** A count of file signing objects in cache -- **InventoryApplication** A count of application objects in cache -- **InventoryApplicationFile** A count of application file objects in cache -- **InventoryDeviceContainer** A count of device container objects in cache -- **InventoryDeviceInterface** A count of PNP device interface objects in cache -- **InventoryDeviceMediaClass** A count of device media objects in cache -- **InventoryDevicePnp** A count of devicepnp objects in cache +- **DeviceCensus** A count of devicecensus objects in cache. +- **DriverPackageExtended** A count of driverpackageextended objects in cache. +- **FileSigningInfo** A count of file signing objects in cache. +- **InventoryApplication** A count of application objects in cache. +- **InventoryApplicationAppV** A count of application AppV objects in cache. +- **InventoryApplicationDriver** A count of application driver objects in cache. +- **InventoryApplicationFile** A count of application file objects in cache. +- **InventoryApplicationFramework** A count of application framework objects in cache. +- **InventoryApplicationShortcut** A count of application shortcut objects in cache. +- **InventoryDeviceContainer** A count of device container objects in cache. +- **InventoryDeviceInterface** A count of Plug and Play device interface objects in cache. +- **InventoryDeviceMediaClass** A count of device media objects in cache. +- **InventoryDevicePnp** A count of device Plug and Play objects in cache. - **InventoryDeviceUsbHubClass** A count of device usb objects in cache -- **InventoryDriverBinary** A count of driver binary objects in cache -- **InventoryDriverPackage** A count of device objects in cache +- **InventoryDriverBinary** A count of driver binary objects in cache. +- **InventoryDriverPackage** A count of device objects in cache. +- **InventoryMiscellaneousOfficeAddIn** A count of office add-in objects in cache. +- **InventoryMiscellaneousOfficeAddInUsage** A count of office add-in usage objects in cache. +- **InventoryMiscellaneousOfficeIdentifiers** A count of office identifier objects in cache. +- **InventoryMiscellaneousOfficeIESettings** A count of office IE settings objects in cache. +- **InventoryMiscellaneousOfficeInsights** A count of office insights objects in cache. +- **InventoryMiscellaneousOfficeProducts** A count of office products objects in cache. +- **InventoryMiscellaneousOfficeSettings** A count of office settings objects in cache. +- **InventoryMiscellaneousOfficeVBA** A count of office VBA objects in cache. +- **InventoryMiscellaneousOfficeVBARuleViolations** A count of office VBA rule violations objects in cache. +- **InventoryMiscellaneousUUPInfo** A count of UUP info objects in cache. ### Microsoft.Windows.Inventory.Core.AmiTelCacheVersions @@ -2473,24 +2670,26 @@ The following fields are available: This event sends basic metadata about an application on the system to help keep Windows up to date. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **HiddenArp** Indicates whether a program hides itself from showing up in ARP. - **InstallDate** The date the application was installed (a best guess based on folder creation date heuristics). - **InstallDateArpLastModified** The date of the registry ARP key for a given application. Hints at install date but not always accurate. Passed as an array. Example: 4/11/2015 00:00:00 - **InstallDateFromLinkFile** The estimated date of install based on the links to the files. Passed as an array. -- **InstallDateMsi** The install date if the application was installed via MSI. Passed as an array. +- **InstallDateMsi** The install date if the application was installed via Microsoft Installer (MSI). Passed as an array. - **InventoryVersion** The version of the inventory file generating the events. - **Language** The language code of the program. - **MsiPackageCode** A GUID that describes the MSI Package. Multiple 'Products' (apps) can make up an MsiPackage. - **MsiProductCode** A GUID that describe the MSI Product. -- **Name** The name of the application +- **Name** The name of the application. - **OSVersionAtInstallTime** The four octets from the OS version at the time of the application's install. - **PackageFullName** The package full name for a Store application. - **ProgramInstanceId** A hash of the file IDs in an app. - **Publisher** The Publisher of the application. Location pulled from depends on the 'Source' field. - **RootDirPath** The path to the root directory where the program was installed. -- **Source** How the program was installed (ARP, MSI, Appx, etc...) +- **Source** How the program was installed (for example, ARP, MSI, Appx). - **StoreAppType** A sub-classification for the type of Microsoft Store app, such as UWP or Win8StoreApp. - **Type** One of ("Application", "Hotfix", "BOE", "Service", "Unknown"). Application indicates Win32 or Appx app, Hotfix indicates app updates (KBs), BOE indicates it's an app with no ARP or MSI entry, Service indicates that it is a service. Application and BOE are the ones most likely seen. - **Version** The version number of the program. @@ -2498,28 +2697,34 @@ The following fields are available: ### Microsoft.Windows.Inventory.Core.InventoryApplicationFrameworkAdd -This event provides the basic metadata about the frameworks an application may depend on +This event provides the basic metadata about the frameworks an application may depend on. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **FileId** A hash that uniquely identifies a file -- **Frameworks** The list of frameworks this file depends on -- **InventoryVersion** The version of the inventory file generating the events +- **FileId** A hash that uniquely identifies a file. +- **Frameworks** The list of frameworks this file depends on. +- **InventoryVersion** The version of the inventory file generating the events. ### Microsoft.Windows.Inventory.Core.InventoryApplicationFrameworkStartSync -This event indicates that a new set of InventoryApplicationFrameworkAdd events will be sent +This event indicates that a new set of InventoryApplicationFrameworkAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **InventoryVersion** The version of the inventory file generating the events +- **InventoryVersion** The version of the inventory file generating the events. ### Microsoft.Windows.Inventory.Core.InventoryApplicationRemove This event indicates that a new set of InventoryDevicePnpAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2529,6 +2734,8 @@ The following fields are available: This event indicates that a new set of InventoryApplicationAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2536,7 +2743,9 @@ The following fields are available: ### Microsoft.Windows.Inventory.Core.InventoryDeviceContainerAdd -This event sends basic metadata about a device container (such as a monitor or printer as opposed to a PNP device) to help keep Windows up-to-date. +This event sends basic metadata about a device container (such as a monitor or printer as opposed to a Plug and Play device) to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -2550,7 +2759,7 @@ The following fields are available: - **IsNetworked** Is this a networked device? - **IsPaired** Does the device container require pairing? - **Manufacturer** The manufacturer name for the device container. -- **ModelId** A model GUID. +- **ModelId** A unique model ID. - **ModelName** The model name. - **ModelNumber** The model number for the device container. - **PrimaryCategory** The primary category for the device container. @@ -2560,6 +2769,8 @@ The following fields are available: This event indicates that the InventoryDeviceContainer object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2569,6 +2780,8 @@ The following fields are available: This event indicates that a new set of InventoryDeviceContainerAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2578,6 +2791,8 @@ The following fields are available: This event retrieves information about what sensor interfaces are available on the device. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **Accelerometer3D** Indicates if an Accelerator3D sensor is found. @@ -2606,6 +2821,8 @@ The following fields are available: This event indicates that a new set of InventoryDeviceInterfaceAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2613,7 +2830,9 @@ The following fields are available: ### Microsoft.Windows.Inventory.Core.InventoryDeviceMediaClassAdd -This event sends additional metadata about a PNP device that is specific to a particular class of devices to help keep Windows up to date while reducing overall size of data payload. +This event sends additional metadata about a Plug and Play device that is specific to a particular class of devices to help keep Windows up to date while reducing overall size of data payload. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -2626,6 +2845,8 @@ The following fields are available: This event indicates that a new set of InventoryDeviceMediaClassSAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2633,7 +2854,9 @@ The following fields are available: ### Microsoft.Windows.Inventory.Core.InventoryDevicePnpAdd -This event represents the basic metadata about a PNP device and its associated driver +This event represents the basic metadata about a plug and play (PNP) device and its associated driver. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -2650,7 +2873,7 @@ The following fields are available: - **DriverVerDate** Name of the .sys image file (or wudfrd.sys if using user mode driver framework). - **DriverVerVersion** The immediate parent directory name in the Directory field of InventoryDriverPackage. - **Enumerator** The date of the driver loaded for the device. -- **HWID** The version of the driver loaded for the device. +- **HWID** The version of the driver loaded for the device. - **Inf** The bus that enumerated the device. - **InstallState** The device installation state. One of these values: https://msdn.microsoft.com/en-us/library/windows/hardware/ff543130.aspx - **InventoryVersion** List of hardware ids for the device. @@ -2672,6 +2895,8 @@ The following fields are available: This event indicates that the InventoryDevicePnpRemove object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2681,6 +2906,8 @@ The following fields are available: This event indicates that a new set of InventoryDevicePnpAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2688,27 +2915,33 @@ The following fields are available: ### Microsoft.Windows.Inventory.Core.InventoryDeviceUsbHubClassAdd -This event sends basic metadata about the USB hubs on the device +This event sends basic metadata about the USB hubs on the device. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **InventoryVersion** The version of the inventory file generating the events -- **TotalUserConnectablePorts** Total number of connectable USB ports -- **TotalUserConnectableTypeCPorts** Total number of connectable USB Type C ports +- **InventoryVersion** The version of the inventory file generating the events. +- **TotalUserConnectablePorts** Total number of connectable USB ports. +- **TotalUserConnectableTypeCPorts** Total number of connectable USB Type C ports. ### Microsoft.Windows.Inventory.Core.InventoryDeviceUsbHubClassStartSync -This event indicates that a new set of InventoryDeviceUsbHubClassAdd events will be sent +This event indicates that a new set of InventoryDeviceUsbHubClassAdd events will be sent. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **InventoryVersion** The version of the inventory file generating the events +- **InventoryVersion** The version of the inventory file generating the events. ### Microsoft.Windows.Inventory.Core.InventoryDriverBinaryAdd -This event provides the basic metadata about driver binaries running on the system +This event provides the basic metadata about driver binaries running on the system. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -2727,7 +2960,7 @@ The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. - **Product** The product name that is included in the driver file. - **ProductVersion** The product version that is included in the driver file. -- **Service** The device service name +- **Service** The name of the service that is installed for the device. - **WdfVersion** The Windows Driver Framework version. @@ -2735,6 +2968,8 @@ The following fields are available: This event indicates that the InventoryDriverBinary object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2744,6 +2979,8 @@ The following fields are available: This event indicates that a new set of InventoryDriverBinaryAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2751,7 +2988,9 @@ The following fields are available: ### Microsoft.Windows.Inventory.Core.InventoryDriverPackageAdd -This event sends basic metadata about drive packages installed on the system to help keep Windows up-to-date. +This event sends basic metadata about drive packages installed on the system to help keep Windows up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: @@ -2771,6 +3010,8 @@ The following fields are available: This event indicates that the InventoryDriverPackageRemove object is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2780,6 +3021,8 @@ The following fields are available: This event indicates that a new set of InventoryDriverPackageAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **InventoryVersion** The version of the inventory file generating the events. @@ -2789,22 +3032,32 @@ The following fields are available: Provides data on the installed Office Add-ins +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: +- **AddinCLSID** The CLSID for the Office addin - **AddInCLSID** CLSID key for the office addin - **AddInId** Office addin ID +- **AddinType** The type of the Office addin. - **BinFileTimestamp** Timestamp of the Office addin - **BinFileVersion** Version of the Office addin - **Description** Office addin description - **FileId** FileId of the Office addin +- **FileSize** File size of the Office addin - **FriendlyName** Friendly name for office addin - **FullPath** Unexpanded path to the office addin +- **InventoryVersion** The version of the inventory binary generating the events. - **LoadBehavior** Uint32 that describes the load behavior - **LoadTime** Load time for the office addin - **OfficeApplication** The office application for this addin - **OfficeArchitecture** Architecture of the addin - **OfficeVersion** The office version for this addin - **OutlookCrashingAddin** Boolean that indicates if crashes have been found for this addin +- **ProductCompany** The name of the company associated with the Office addin +- **ProductName** The product name associated with the Office addin +- **ProductVersion** The version associated with the Office addin +- **ProgramId** The unique program identifier of the Office addin - **Provider** Name of the provider for this addin @@ -2812,20 +3065,59 @@ The following fields are available: Indicates that this particular data object represented by the objectInstanceId is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeAddInStartSync This event indicates that a new sync is being generated for this object type. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory binary generating the events. + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIdentifiersAdd + +Provides data on the Office identifiers + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory binary generating the events. +- **OAudienceData** Sub-identifier for Microsoft Office release management, identifying the pilot group for a device +- **OAudienceId** Microsoft Office identifier for Microsoft Office release management, identifying the pilot group for a device +- **OMID** Identifier for the Office SQM Machine +- **OPlatform** Whether the installed Microsoft Office product is 32-bit or 64-bit +- **OTenantId** Unique GUID representing the Microsoft O365 Tenant +- **OVersion** Installed version of Microsoft Office. For example, 16.0.8602.1000 +- **OWowMID** Legacy Microsoft Office telemetry identifier (SQM Machine ID) for WoW systems (32-bit Microsoft Office on 64-bit Windows) + + +### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIdentifiersStartSync + +Diagnostic event to indicate a new sync is being generated for this object type. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory binary generating the events. ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIESettingsAdd -This event includes the Office-related Internet Explorer features +Office-related Internet Explorer features + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: +- **InventoryVersion** The version of the inventory binary generating the events. - **OIeFeatureAddon** Flag indicating which Microsoft Office products have this setting enabled. The FEATURE_ADDON_MANAGEMENT feature lets applications hosting the WebBrowser Control to respect add-on management selections made using the Add-on Manager feature of Internet Explorer. Add-ons disabled by the user or by administrative group policy will also be disabled in applications that enable this feature. - **OIeMachineLockdown** Flag indicating which Microsoft Office products have this setting enabled. When the FEATURE_LOCALMACHINE_LOCKDOWN feature is enabled, Internet Explorer applies security restrictions on content loaded from the user's local machine, which helps prevent malicious behavior involving local files. - **OIeMimeHandling** Flag indicating which Microsoft Office products have this setting enabled. When the FEATURE_MIME_HANDLING feature control is enabled, Internet Explorer handles MIME types more securely. Only applies to Windows Internet Explorer 6 for Windows XP Service Pack 2 (SP2) @@ -2847,62 +3139,55 @@ The following fields are available: Diagnostic event to indicate a new sync is being generated for this object type. - - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIdentifiersAdd - -This event provides data on the Office identifiers +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **OAudienceData** Sub-identifier for Microsoft Office release management, identifying the pilot group for a device -- **OAudienceId** Microsoft Office identifier for Microsoft Office release management, identifying the pilot group for a device -- **OMID** Identifier for the Office SQM Machine -- **OPlatform** Whether the installed Microsoft Office product is 32-bit or 64-bit -- **OTenantId** Unique GUID representing the Microsoft O365 Tenant -- **OVersion** Installed version of Microsoft Office. For example, 16.0.8602.1000 -- **OWowMID** Legacy Microsoft Office telemetry identifier (SQM Machine ID) for WoW systems (32-bit Microsoft Office on 64-bit Windows) - - -### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeIdentifiersStartSync - -Diagnostic event to indicate a new sync is being generated for this object type. - +- **InventoryVersion** The version of the inventory binary generating the events. ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeInsightsAdd This event provides insight data on the installed Office products +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **OfficeApplication** The name of the Office application. - **OfficeArchitecture** The bitness of the Office application. - **OfficeVersion** The version of the Office application. -- **Value** The insights collected about this entity. +- **Value** The insights collected about this entity. ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeInsightsRemove Indicates that this particular data object represented by the objectInstanceId is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeInsightsStartSync This diagnostic event indicates that a new sync is being generated for this object type. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeProductsAdd -This event list all installed Office products +Describes Office Products installed + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: +- **InventoryVersion** The version of the inventory binary generating the events. - **OC2rApps** A GUID the describes the Office Click-To-Run apps -- **OC2rSkus** Comma-delimited list (CSV) of Office Click-To-Run products installed on the device. For example, Office 2016 ProPlus -- **OMsiApps** Comma-delimited list (CSV) of Office MSI products installed on the device. For example, Microsoft Word +- **OC2rSkus** Comma-delimited list (CSV) of Office Click-To-Run products installed on the device. For example, Office 2016 ProPlus +- **OMsiApps** Comma-delimited list (CSV) of Office MSI products installed on the device. For example, Microsoft Word - **OProductCodes** A GUID that describes the Office MSI products @@ -2910,16 +3195,24 @@ The following fields are available: Diagnostic event to indicate a new sync is being generated for this object type. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory binary generating the events. ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeSettingsAdd This event describes various Office settings +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **BrowserFlags** Browser flags for Office-related products - **ExchangeProviderFlags** Provider policies for Office Exchange +- **InventoryVersion** The version of the inventory binary generating the events. - **SharedComputerLicensing** Office shared computer licensing policies @@ -2927,12 +3220,19 @@ The following fields are available: Diagnostic event to indicate a new sync is being generated for this object type. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory binary generating the events. ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBAAdd This event provides a summary rollup count of conditions encountered while performing a local scan of Office files, analyzing for known VBA programmability compatibility issues between legacy office version and ProPlus, and between 32 and 64-bit versions +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **Design** Count of files with design issues found @@ -2962,12 +3262,16 @@ The following fields are available: Indicates that this particular data object represented by the objectInstanceId is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBARuleViolationsAdd This event provides data on Microsoft Office VBA rule violations, including a rollup count per violation type, giving an indication of remediation requirements for an organization. The event identifier is a unique GUID, associated with the validation rule +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **Count** Count of total Microsoft Office VBA rule violations @@ -2977,24 +3281,35 @@ The following fields are available: Indicates that this particular data object represented by the objectInstanceId is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBARuleViolationsStartSync This event indicates that a new sync is being generated for this object type. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousOfficeVBAStartSync Diagnostic event to indicate a new sync is being generated for this object type. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + +The following fields are available: + +- **InventoryVersion** The version of the inventory binary generating the events. ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousUUPInfoAdd Provides data on Unified Update Platform (UUP) products and what version they are at. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + The following fields are available: - **Identifier** UUP identifier @@ -3008,12 +3323,16 @@ The following fields are available: Indicates that this particular data object represented by the objectInstanceId is no longer present. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + ### Microsoft.Windows.Inventory.General.InventoryMiscellaneousUUPInfoStartSync Diagnostic event to indicate a new sync is being generated for this object type. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + ### Microsoft.Windows.Inventory.Indicators.Checksum @@ -3028,402 +3347,97 @@ The following fields are available: ### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicatorAdd -These events represent the basic metadata about the OS indicators installed on the system which are used for keeping the device up-to-date. +These events represent the basic metadata about the OS indicators installed on the system which are used for keeping the device up to date. + +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). The following fields are available: -- **IndicatorValue** The indicator value +- **IndicatorValue** The indicator value. ### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicatorRemove This event is a counterpart to InventoryMiscellaneousUexIndicatorAdd that indicates that the item has been removed. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). + ### Microsoft.Windows.Inventory.Indicators.InventoryMiscellaneousUexIndicatorStartSync This event indicates that a new set of InventoryMiscellaneousUexIndicatorAdd events will be sent. +This event includes fields from [Ms.Device.DeviceInventoryChange](#msdevicedeviceinventorychange). -## Microsoft Store events -### Microsoft.Windows.StoreAgent.Telemetry.AbortedInstallation +## Kernel events -This event is sent when an installation or update is canceled by a user or the system and is used to help keep Windows Apps up to date and secure. +### IO + +This event indicates the number of bytes read from or read by the OS and written to or written by the OS upon system startup. The following fields are available: -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. -- **AttemptNumber** Number of retry attempts before it was canceled. -- **BundleId** The Item Bundle ID. -- **CategoryId** The Item Category ID. -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** The result code of the last action performed before this operation. -- **IsBundle** Is this a bundle? -- **IsInteractive** Was this requested by a user? -- **IsMandatory** Was this a mandatory update? -- **IsRemediation** Was this a remediation install? -- **IsRestore** Is this automatically restoring a previously acquired product? -- **IsUpdate** Flag indicating if this is an update. -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** The product family name of the product being installed. -- **ProductId** The identity of the package or packages being installed. -- **SystemAttemptNumber** The total number of automatic attempts at installation before it was canceled. -- **UserAttemptNumber** The total number of user attempts at installation before it was canceled. -- **WUContentId** The Windows Update content ID +- **BytesRead** The total number of bytes read from or read by the OS upon system startup. +- **BytesWritten** The total number of bytes written to or written by the OS upon system startup. -### Microsoft.Windows.StoreAgent.Telemetry.BeginGetInstalledContentIds +### Microsoft.Windows.Kernel.BootEnvironment.OsLaunch -This event is sent when an inventory of the apps installed is started to determine whether updates for those apps are available. It's used to help keep Windows up-to-date and secure. - - - -### Microsoft.Windows.StoreAgent.Telemetry.BeginUpdateMetadataPrepare - -This event is sent when the Store Agent cache is refreshed with any available package updates. It's used to help keep Windows up-to-date and secure. - - - -### Microsoft.Windows.StoreAgent.Telemetry.CancelInstallation - -This event is sent when an app update or installation is canceled while in interactive mode. This can be canceled by the user or the system. It's used to help keep Windows up-to-date and secure. +OS information collected during Boot, used to evaluate the success of the upgrade process. The following fields are available: -- **AggregatedPackageFullNames** The names of all package or packages to be downloaded and installed. -- **AttemptNumber** Total number of installation attempts. -- **BundleId** The identity of the Windows Insider build that is associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **IsBundle** Is this a bundle? -- **IsInteractive** Was this requested by a user? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this an automatic restore of a previously acquired product? -- **IsUpdate** Is this a product update? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** The name of all packages to be downloaded and installed. -- **PreviousHResult** The previous HResult code. -- **PreviousInstallState** Previous installation state before it was canceled. -- **ProductId** The name of the package or packages requested for installation. -- **RelatedCV** Correlation Vector of a previous performed action on this product. -- **SystemAttemptNumber** Total number of automatic attempts to install before it was canceled. -- **UserAttemptNumber** Total number of user attempts to install before it was canceled. -- **WUContentId** The Windows Update content ID +- **BootApplicationId** This field tells us what the OS Loader Application Identifier is. +- **BootAttemptCount** The number of consecutive times the boot manager has attempted to boot into this operating system. +- **BootSequence** The current Boot ID, used to correlate events related to a particular boot session. +- **BootStatusPolicy** Identifies the applicable Boot Status Policy. +- **BootType** Identifies the type of boot (e.g.: "Cold", "Hiber", "Resume"). +- **EventTimestamp** Seconds elapsed since an arbitrary time point. This can be used to identify the time difference in successive boot attempts being made. +- **FirmwareResetReasonEmbeddedController** Reason for system reset provided by firmware. +- **FirmwareResetReasonEmbeddedControllerAdditional** Additional information on system reset reason provided by firmware if needed. +- **FirmwareResetReasonPch** Reason for system reset provided by firmware. +- **FirmwareResetReasonPchAdditional** Additional information on system reset reason provided by firmware if needed. +- **FirmwareResetReasonSupplied** Flag indicating that a reason for system reset was provided by firmware. +- **IO** Amount of data written to and read from the disk by the OS Loader during boot. See [IO](#io). +- **LastBootSucceeded** Flag indicating whether the last boot was successful. +- **LastShutdownSucceeded** Flag indicating whether the last shutdown was successful. +- **MaxAbove4GbFreeRange** This field describes the largest memory range available above 4Gb. +- **MaxBelow4GbFreeRange** This field describes the largest memory range available below 4Gb. +- **MeasuredLaunchPrepared** This field tells us if the OS launch was initiated using Measured/Secure Boot over DRTM (Dynamic Root of Trust for Measurement). +- **MenuPolicy** Type of advanced options menu that should be shown to the user (Legacy, Standard, etc.). +- **RecoveryEnabled** Indicates whether recovery is enabled. +- **SecureLaunchPrepared** This field indicates if DRTM was prepared during boot. +- **UserInputTime** The amount of time the loader application spent waiting for user input. -### Microsoft.Windows.StoreAgent.Telemetry.CompleteInstallOperationRequest +### Microsoft.Windows.Kernel.Power.OSStateChange -This event is sent after the app installations or updates. It's used to help keep Windows up-to-date and secure +This event indicates an OS state change. The following fields are available: -- **CatalogId** The Store Product ID of the app being installed. -- **HResult** HResult code of the action being performed. -- **IsBundle** Is this a bundle? -- **PackageFamilyName** The name of the package being installed. -- **ProductId** The Store Product ID of the product being installed. -- **SkuId** Specific edition of the item being installed. - - -### Microsoft.Windows.StoreAgent.Telemetry.EndAcquireLicense - -This event is sent after the license is acquired when a product is being installed. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AggregatedPackageFullNames** Includes a set of package full names for each app that is part of an atomic set. -- **AttemptNumber** The total number of attempts to acquire this product. -- **BundleId** The bundle ID -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** HResult code to show the result of the operation (success/failure). -- **IsBundle** Is this a bundle? -- **IsInteractive** Did the user initiate the installation? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this happening after a device restore? -- **IsUpdate** Is this an update? -- **ParentBundleId** The parent bundle ID (if it's part of a bundle). -- **PFN** Product Family Name of the product being installed. -- **ProductId** The Store Product ID for the product being installed. -- **SystemAttemptNumber** The number of attempts by the system to acquire this product. -- **UserAttemptNumber** The number of attempts by the user to acquire this product -- **WUContentId** The Windows Update content ID - - -### Microsoft.Windows.StoreAgent.Telemetry.EndDownload - -This event happens during the app update or installation when content is being downloaded at the end of the process to report success or failure. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. -- **AttemptNumber** Number of retry attempts before it was canceled. -- **BundleId** The identity of the Windows Insider build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **DownloadSize** The total size of the download. -- **ExtendedHResult** Any extended HResult error codes. -- **HResult** The result code of the last action performed. -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this initiated by the user? -- **IsMandatory** Is this a mandatory installation? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this a restore of a previously acquired product? -- **IsUpdate** Is this an update? -- **ParentBundleId** The parent bundle ID (if it's part of a bundle). -- **PFN** The Product Family Name of the app being download. -- **ProductId** The Store Product ID for the product being installed. -- **SystemAttemptNumber** The number of attempts by the system to download. -- **UserAttemptNumber** The number of attempts by the user to download. -- **WUContentId** The Windows Update content ID. - - -### Microsoft.Windows.StoreAgent.Telemetry.EndFrameworkUpdate - -This event happens when an app update requires an updated Framework package and the process starts to download it. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **HResult** The result code of the last action performed before this operation. - - -### Microsoft.Windows.StoreAgent.Telemetry.EndGetInstalledContentIds - -This event is sent after sending the inventory of the products installed to determine whether updates for those products are available. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **HResult** The result code of the last action performed before this operation. - - -### Microsoft.Windows.StoreAgent.Telemetry.EndInstall - -This event is sent after a product has been installed. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. -- **AttemptNumber** The number of retry attempts before it was canceled. -- **BundleId** The identity of the build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **ExtendedHResult** The extended HResult error code. -- **HResult** The result code of the last action performed. -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this an interactive installation? -- **IsMandatory** Is this a mandatory installation? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this automatically restoring a previously acquired product? -- **IsUpdate** Is this an update? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** Product Family Name of the product being installed. -- **ProductId** The Store Product ID for the product being installed. -- **SystemAttemptNumber** The total number of system attempts. -- **UserAttemptNumber** The total number of user attempts. -- **WUContentId** The Windows Update content ID - - -### Microsoft.Windows.StoreAgent.Telemetry.EndScanForUpdates - -This event is sent after a scan for product updates to determine if there are packages to install. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** The result code of the last action performed. -- **IsApplicability** Is this request to only check if there are any applicable packages to install? -- **IsInteractive** Is this user requested? -- **IsOnline** Is the request doing an online check? - - -### Microsoft.Windows.StoreAgent.Telemetry.EndSearchUpdatePackages - -This event is sent after searching for update packages to install. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. -- **AttemptNumber** The total number of retry attempts before it was canceled. -- **BundleId** The identity of the build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** The result code of the last action performed. -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this user requested? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this restoring previously acquired content? -- **IsUpdate** Is this an update? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** The name of the package or packages requested for install. -- **ProductId** The Store Product ID for the product being installed. -- **SystemAttemptNumber** The total number of system attempts. -- **UserAttemptNumber** The total number of user attempts. -- **WUContentId** The Windows Update content ID - - -### Microsoft.Windows.StoreAgent.Telemetry.EndStageUserData - -This event is sent between download and installation to see if there is app data that needs to be restored from the cloud. It's used to keep Windows up-to-date and secure. - -The following fields are available: - -- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. -- **AttemptNumber** The total number of retry attempts before it was canceled. -- **BundleId** The identity of the build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** The result code of the last action performed. -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this user requested? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this restoring previously acquired content? -- **IsUpdate** Is this an update? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** The name of the package or packages requested for install. -- **ProductId** The Store Product ID for the product being installed. -- **SystemAttemptNumber** The total number of system attempts. -- **UserAttemptNumber** The total number of system attempts. -- **WUContentId** The Windows Update content ID - - -### Microsoft.Windows.StoreAgent.Telemetry.EndUpdateMetadataPrepare - -This event happens after a scan for available app updates. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **HResult** The result code of the last action performed. - - -### Microsoft.Windows.StoreAgent.Telemetry.FulfillmentComplete - -The FulfillmentComplete event is fired at the end of an app install or update. We use this to track the very end of the install/update process. StoreAgent events are needed to help keep Windows pre-installed 1st party apps up to date and secure, such as the mail and calendar apps. App update failure can be unique across devices and without this data from every device we will not be able to track the success/failure and fix any future vulnerabilities related to these built in Windows Apps. - -The following fields are available: - -- **CatalogId** The CatalogId is the name of the product catalog from which this app was chosen. -- **FailedRetry** Was the installation or update retry successful? -- **HResult** The HResult code of the operation. -- **PFN** The Package Family Name of the app that is being installed or updated. -- **ProductId** The product ID of the app that is being updated or installed. - - -### Microsoft.Windows.StoreAgent.Telemetry.FulfillmentInitiate - -The FulfillmentInitiate event is fired at the start of an app install or update. We use this to track the very beginning of the install/update process. StoreAgent events are needed to help keep Windows pre-installed 1st party apps up to date and secure, such as the mail and calendar apps. App update failure can be unique across devices and without this data from every device we will not be able to track the success/failure and fix any future vulnerabilities related to these built in Windows Apps. - -The following fields are available: - -- **PFN** The Package Family Name of the app that is being installed or updated. -- **ProductId** The product ID of the app that is being updated or installed. -- **CatalogId** The CatalogId is the name of the product catalog from which this app was chosen. - - -### Microsoft.Windows.StoreAgent.Telemetry.InstallOperationRequest - -This event happens at the beginning of the install process when an app update or new app is installed. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **BundleId** The identity of the build associated with this product. -- **CatalogId** If this product is from a private catalog, the Store Product ID for the product being installed. -- **ProductId** The Store Product ID for the product being installed. -- **SkuId** Specific edition ID being installed. -- **VolumePath** The disk path of the installation. - - -### Microsoft.Windows.StoreAgent.Telemetry.PauseInstallation - -This event is sent when a product install or update is paused either by a user or the system. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. -- **AttemptNumber** The total number of retry attempts before it was canceled. -- **BundleId** The identity of the build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this user requested? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this restoring previously acquired content? -- **IsUpdate** Is this an update? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** The Product Full Name. -- **PreviousHResult** The result code of the last action performed before this operation. -- **PreviousInstallState** Previous state before the installation or update was paused. -- **ProductId** The Store Product ID for the product being installed. -- **RelatedCV** Correlation Vector of a previous performed action on this product. -- **SystemAttemptNumber** The total number of system attempts. -- **UserAttemptNumber** The total number of user attempts. -- **WUContentId** The Windows Update content ID - - -### Microsoft.Windows.StoreAgent.Telemetry.ResumeInstallation - -This event happens when a product install or update is resumed either by a user or the system. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. -- **AttemptNumber** The number of retry attempts before it was canceled. -- **BundleId** The identity of the build associated with this product. -- **CategoryId** The identity of the package or packages being installed. -- **ClientAppId** The identity of the app that initiated this operation. -- **HResult** The result code of the last action performed before this operation. -- **IsBundle** Is this a bundle? -- **IsInteractive** Is this user requested? -- **IsMandatory** Is this a mandatory update? -- **IsRemediation** Is this repairing a previous installation? -- **IsRestore** Is this restoring previously acquired content? -- **IsUpdate** Is this an update? -- **IsUserRetry** Did the user initiate the retry? -- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). -- **PFN** The name of the package or packages requested for install. -- **PreviousHResult** The previous HResult error code. -- **PreviousInstallState** Previous state before the installation was paused. -- **ProductId** The Store Product ID for the product being installed. -- **RelatedCV** Correlation Vector for the original install before it was resumed. -- **SystemAttemptNumber** The total number of system attempts. -- **UserAttemptNumber** The total number of user attempts. -- **WUContentId** The Windows Update content ID - - -### Microsoft.Windows.StoreAgent.Telemetry.ResumeOperationRequest - -This event happens when a product install or update is resumed by a user and on installation retries. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **ProductId** The Store Product ID for the product being installed. - - -### Microsoft.Windows.StoreAgent.Telemetry.SearchForUpdateOperationRequest - -This event is sent when searching for update packages to install. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **CatalogId** The Store Product ID for the product being installed. -- **ProductId** The Store Product ID for the product being installed. -- **SkuId** Specfic edition of the app being updated. - - -### Microsoft.Windows.StoreAgent.Telemetry.UpdateAppOperationRequest - -This event happens an app for a user needs to be updated. It's used to help keep Windows up-to-date and secure. - -The following fields are available: - -- **PFamN** The name of the product that is requested for update. +- **AcPowerOnline** If "TRUE," the device is using AC power. If "FALSE," the device is using battery power. +- **ActualTransitions** The number of transitions between operating system states since the last system boot +- **BatteryCapacity** Maximum battery capacity in mWh +- **BatteryCharge** Current battery charge as a percentage of total capacity +- **BatteryDischarging** Flag indicating whether the battery is discharging or charging +- **BootId** Total boot count since the operating system was installed +- **BootTimeUTC** Date and time of a particular boot event (identified by BootId) +- **EnergyChangeV2** A snapshot value in mWh reflecting a change in power usage +- **EnergyChangeV2Flags** Flags for disambiguating EnergyChangeV2 context +- **EventSequence** Indicates the sequence order for this event instance, relative to previous instances of OSStateChange events that have occurred since boot +- **LastStateTransition** ID of the last operating system state transition +- **LastStateTransitionSub** ID of the last operating system sub-state transition +- **StateDurationMS** Number of milliseconds spent in the last operating system state +- **StateTransition** ID of the operating system state the system is transitioning to +- **StateTransitionSub** ID of the operating system sub-state the system is transitioning to +- **TotalDurationMS** Total time (in milliseconds) spent in all states since the last boot +- **TotalUptimeMS** Total time (in milliseconds) the device was in Up or Running states since the last boot +- **TransitionsToOn** Number of transitions to the Powered On state since the last boot +- **UptimeDeltaMS** Total time (in milliseconds) added to Uptime since the last event ## Privacy consent logging events @@ -3446,13 +3460,29 @@ Event tells us effectiveness of new privacy experience. The following fields are available: -- **isAdmin** Whether the current user is an administrator or not +- **isAdmin** whether the person who is logging in is an admin - **isLaunching** Whether or not the privacy consent experience will be launched -- **isSilentElevation** Whether the current user has enabled silent elevation -- **privacyConsentState** The current state of the privacy consent experience +- **isSilentElevation** whether the user has most restrictive UAC controls +- **privacyConsentState** whether the user has completed privacy experience - **userRegionCode** The current user's region setting +## Sediment events + +### Microsoft.Windows.Sediment.OSRSS.UrlState + +This event indicates the state the Operating System Remediation System Service (OSRSS) is in while attempting a download from the URL. + +The following fields are available: + +- **Id** A number identifying the URL. +- **ServiceVersionMajor** Version information for the component. +- **ServiceVersionMinor** Version information for the component. +- **StateData** State-specific data, such as the attempt number for the download. +- **StateNumber** A number identifying the current state of the URL (for example, found, downloading, extracted). +- **Time** System timestamp when the event was started. + + ## Setup events ### SetupPlatformTel.SetupPlatformTelEvent @@ -3477,7 +3507,7 @@ The following fields are available: - **accountType** The type of account that was deleted. Example: AD, AAD, or Local - **deleteState** Whether the attempted deletion of the user account was successful. - **userSid** The security identifier of the account. -- **wilActivity** Windows Error Reporting data collected when there is a failure in deleting a user account with the Transient Account Manager. +- **wilActivity** Windows Error Reporting data collected when there is a failure in deleting a user account with the Transient Account Manager. See [wilActivity](#wilactivity). ### Microsoft.Windows.SharedPC.AccountManager.SinglePolicyEvaluation @@ -3486,9 +3516,59 @@ Activity for run of the Transient Account Manager that determines if any user ac The following fields are available: -- **totalAccountCount** The number of accounts on a device after running the Transient Account Manager policies. -- **wilActivity** Windows Error Reporting data collected when there is a failure in evaluating accounts to be deleted with the Transient Account Manager. - **evaluationTrigger** When was the Transient Account Manager policies ran? Example: At log off or during maintenance hours +- **totalAccountCount** The number of accounts on a device after running the Transient Account Manager policies. +- **wilActivity** Windows Error Reporting data collected when there is a failure in evaluating accounts to be deleted with the Transient Account Manager. See [wilActivity](#wilactivity). + + +### wilActivity + +This event provides a Windows Internal Library context used for Product and Service diagnostics. + +The following fields are available: + +- **callContext** The function where the failure occurred. +- **currentContextId** The ID of the current call context where the failure occurred. +- **currentContextMessage** The message of the current call context where the failure occurred. +- **currentContextName** The name of the current call context where the failure occurred. +- **failureCount** The number of failures for this failure ID. +- **failureId** The ID of the failure that occurred. +- **failureType** The type of the failure that occurred. +- **fileName** The file name where the failure occurred. +- **function** The function where the failure occurred. +- **hresult** The HResult of the overall activity. +- **lineNumber** The line number where the failure occurred. +- **message** The message of the failure that occurred. +- **module** The module where the failure occurred. +- **originatingContextId** The ID of the originating call context that resulted in the failure. +- **originatingContextMessage** The message of the originating call context that resulted in the failure. +- **originatingContextName** The name of the originating call context that resulted in the failure. +- **threadId** The ID of the thread on which the activity is executing. + + +### wilResult + +This event provides a Windows Internal Library context used for Product and Service diagnostics. + +The following fields are available: + +- **callContext** The call context stack where failure occurred. +- **currentContextId** The ID of the current call context where the failure occurred. +- **currentContextMessage** The message of the current call context where the failure occurred. +- **currentContextName** The name of the current call context where the failure occurred. +- **failureCount** The number of failures for this failure ID. +- **failureId** The ID of the failure that occurred. +- **failureType** The type of the failure that occurred. +- **fileName** The file name where the failure occurred. +- **function** The function where the failure occurred. +- **hresult** The HResult of the overall activity. +- **lineNumber** The line number where the failure occurred. +- **message** The message of the failure that occurred. +- **module** The module where the failure occurred. +- **originatingContextId** The ID of the originating call context that resulted in the failure. +- **originatingContextMessage** The message of the originating call context that resulted in the failure. +- **originatingContextName** The name of the originating call context that resulted in the failure. +- **threadId** The ID of the thread on which the activity is executing. ## SIH events @@ -3546,37 +3626,6 @@ The following fields are available: - **ActivityMatchingId** Contains a unique ID identifying a single CheckForUpdates session from initialization to completion. - **AllowCachedResults** Indicates if the scan allowed using cached results. -- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. -- **CurrentMobileOperator** The mobile operator the device is currently connected to. -- **DriverSyncPassPerformed** Were drivers scanned this time? -- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. -- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. -- **FeatureUpdatePause** Indicates whether feature OS updates are paused on the device. -- **FlightBranch** The branch that a device is on if participating in flighting (pre-release builds). -- **FlightRing** The ring (speed of getting builds) that a device is on if participating in flighting (pre-release builds). -- **HomeMobileOperator** The mobile operator that the device was originally intended to work with. -- **IPVersion** Indicates whether the download took place over IPv4 or IPv6 -- **IsWUfBDualScanEnabled** Indicates if Windows Update for Business dual scan is enabled on the device. -- **IsWUfBEnabled** Indicates if Windows Update for Business is enabled on the device. -- **MetadataIntegrityMode** The mode of the update transport metadata integrity check. 0-Unknown, 1-Ignoe, 2-Audit, 3-Enforce -- **NumberOfApplicationsCategoryScanEvaluated** The number of categories (apps) for which an app update scan checked -- **NumberOfLoop** The number of round trips the scan required -- **NumberOfNewUpdatesFromServiceSync** The number of updates which were seen for the first time in this scan -- **NumberOfUpdatesEvaluated** The total number of updates which were evaluated as a part of the scan -- **NumFailedMetadataSignatures** The number of metadata signatures checks which failed for new metadata synced down. -- **Online** Indicates if this was an online scan. -- **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting (pre-release builds) being introduced. -- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. -- **QualityUpdatePause** Indicates whether quality OS updates are paused on the device. -- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one -- **ScanDurationInSeconds** The number of seconds a scan took -- **ScanEnqueueTime** The number of seconds it took to initialize a scan -- **ServiceGuid** An ID which represents which service the software distribution client is checking for content (Windows Update, Windows Store, etc.). -- **ServiceUrl** The environment URL a device is configured to scan with -- **ShippingMobileOperator** The mobile operator that a device shipped on. -- **StatusCode** Indicates the result of a CheckForUpdates event (success, cancellation, failure code HResult). -- **SyncType** Describes the type of scan the event was -- **TotalNumMetadataSignatures** The total number of metadata signatures checks done for new metadata that was synced down. - **ApplicableUpdateInfo** Metadata for the updates which were detected as applicable - **BiosFamily** The family of the BIOS (Basic Input Output System). - **BiosName** The name of the device BIOS. @@ -3585,40 +3634,71 @@ The following fields are available: - **BIOSVendor** The vendor of the BIOS. - **BiosVersion** The version of the BIOS. - **BranchReadinessLevel** The servicing branch configured on the device. +- **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. +- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. +- **CapabilityDetectoidGuid** The GUID for a hardware applicability detectoid that could not be evaluated. +- **CDNCountryCode** Two letter country abbreviation for the Content Distribution Network (CDN) location. +- **CDNId** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. - **ClientVersion** The version number of the software distribution client. +- **Context** Gives context on where the error has occurred. Example: AutoEnable, GetSLSData, AddService, Misc, or Unknown +- **CurrentMobileOperator** The mobile operator the device is currently connected to. - **DeferralPolicySources** Sources for any update deferral policies defined (GPO = 0x10, MDM = 0x100, Flight = 0x1000, UX = 0x10000). - **DeferredUpdates** Update IDs which are currently being deferred until a later time - **DeviceModel** What is the device model. +- **DriverError** The error code hit during a driver scan. This is 0 if no error was encountered. - **DriverExclusionPolicy** Indicates if the policy for not including drivers with Windows Update is enabled. +- **DriverSyncPassPerformed** Were drivers scanned this time? - **EventInstanceID** A globally unique identifier for event instance. +- **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **ExtendedMetadataCabUrl** Hostname that is used to download an update. +- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. +- **FailedUpdateGuids** The GUIDs for the updates that failed to be evaluated during the scan. +- **FailedUpdatesCount** The number of updates that failed to be evaluated during the scan. - **FeatureUpdateDeferral** The deferral period configured for feature OS updates on the device (in days). +- **FeatureUpdatePause** Indicates whether feature OS updates are paused on the device. - **FeatureUpdatePausePeriod** The pause duration configured for feature OS updates on the device (in days). +- **FlightBranch** The branch that a device is on if participating in flighting (pre-release builds). +- **FlightRing** The ring (speed of getting builds) that a device is on if participating in flighting (pre-release builds). +- **HomeMobileOperator** The mobile operator that the device was originally intended to work with. - **IntentPFNs** Intended application-set metadata for atomic update scenarios. +- **IPVersion** Indicates whether the download took place over IPv4 or IPv6 +- **IsWUfBDualScanEnabled** Indicates if Windows Update for Business dual scan is enabled on the device. +- **IsWUfBEnabled** Indicates if Windows Update for Business is enabled on the device. +- **IsWUfBFederatedScanDisabled** Indicates if Windows Update for Business federated scan is disabled on the device. +- **MetadataIntegrityMode** The mode of the update transport metadata integrity check. 0-Unknown, 1-Ignoe, 2-Audit, 3-Enforce +- **MSIError** The last error that was encountered during a scan for updates. +- **NetworkConnectivityDetected** Indicates the type of network connectivity that was detected. 0 - IPv4, 1 - IPv6 - **NumberOfApplicableUpdates** The number of updates which were ultimately deemed applicable to the system after the detection process is complete +- **NumberOfApplicationsCategoryScanEvaluated** The number of categories (apps) for which an app update scan checked +- **NumberOfLoop** The number of round trips the scan required +- **NumberOfNewUpdatesFromServiceSync** The number of updates which were seen for the first time in this scan +- **NumberOfUpdatesEvaluated** The total number of updates which were evaluated as a part of the scan +- **NumFailedMetadataSignatures** The number of metadata signatures checks which failed for new metadata synced down. +- **Online** Indicates if this was an online scan. - **PausedUpdates** A list of UpdateIds which that currently being paused. - **PauseFeatureUpdatesEndTime** If feature OS updates are paused on the device, this is the date and time for the end of the pause time window. - **PauseFeatureUpdatesStartTime** If feature OS updates are paused on the device, this is the date and time for the beginning of the pause time window. - **PauseQualityUpdatesEndTime** If quality OS updates are paused on the device, this is the date and time for the end of the pause time window. - **PauseQualityUpdatesStartTime** If quality OS updates are paused on the device, this is the date and time for the beginning of the pause time window. +- **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting (pre-release builds) being introduced. +- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. - **QualityUpdateDeferral** The deferral period configured for quality OS updates on the device (in days). +- **QualityUpdatePause** Indicates whether quality OS updates are paused on the device. - **QualityUpdatePausePeriod** The pause duration configured for quality OS updates on the device (in days). +- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one +- **ScanDurationInSeconds** The number of seconds a scan took +- **ScanEnqueueTime** The number of seconds it took to initialize a scan +- **ServiceGuid** An ID which represents which service the software distribution client is checking for content (Windows Update, Windows Store, etc.). +- **ServiceUrl** The environment URL a device is configured to scan with +- **ShippingMobileOperator** The mobile operator that a device shipped on. +- **StatusCode** Indicates the result of a CheckForUpdates event (success, cancellation, failure code HResult). +- **SyncType** Describes the type of scan the event was - **SystemBIOSMajorRelease** Major version of the BIOS. - **SystemBIOSMinorRelease** Minor version of the BIOS. +- **TargetMetadataVersion** For self-initiated healing, this is the target version of the SIH engine to download (if needed). If not, the value is null. +- **TotalNumMetadataSignatures** The total number of metadata signatures checks done for new metadata that was synced down. - **WebServiceRetryMethods** Web service method requests that needed to be retried to complete operation. - **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. -- **CachedEngineVersion** For self-initiated healing, the version of the SIH engine that is cached on the device. If the SIH engine does not exist, the value is null. -- **TargetMetadataVersion** For self-initiated healing, this is the target version of the SIH engine to download (if needed). If not, the value is null. -- **IsWUfBFederatedScanDisabled** Indicates if Windows Update for Business federated scan is disabled on the device. -- **CapabilityDetectoidGuid** The GUID for a hardware applicability detectoid that could not be evaluated. -- **CDNCountryCode** Two letter country abbreviation for the CDN's location. -- **CDNId** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. -- **DriverError** The error code hit during a driver scan. This is 0 if no error was encountered. -- **ExtendedMetadataCabUrl** Hostname that is used to download an update. -- **FailedUpdateGuids** The GUIDs for the updates that failed to be evaluated during the scan. -- **FailedUpdatesCount** The number of updates that failed to be evaluated during the scan. -- **MSIError** The last error that was encountered during a scan for updates. -- **NetworkConnectivityDetected** Indicates the type of network connectivity that was detected. 0 - IPv4, 1 - IPv6 -- **Context** Gives context on where the error has occurred. Example: AutoEnable, GetSLSData, AddService, Misc, or Unknown ### SoftwareUpdateClientTelemetry.Commit @@ -3633,31 +3713,31 @@ The following fields are available: - **BiosSKUNumber** Device SKU as defined in the system BIOS - **BIOSVendor** Vendor of the system BIOS - **BiosVersion** Version of the system BIOS -- **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. -- **BundleRevisionNumber** Identifies the revision number of the content bundle -- **CallerApplicationName** Name provided by the caller who initiated API calls into the software distribution client +- **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. +- **BundleRevisionNumber** Identifies the revision number of the content bundle +- **CallerApplicationName** Name provided by the caller who initiated API calls into the software distribution client - **ClientVersion** Version number of the software distribution client -- **DeviceModel** Device model as defined in the system bios +- **DeviceModel** Device model as defined in the system bios - **EventInstanceID** A globally unique identifier for event instance - **EventScenario** Indicates the purpose of the event - whether because scan started, succeded, failed, etc. - **EventType** Possible values are "Child", "Bundle", "Relase" or "Driver". -- **FlightId** The specific id of the flight the device is getting -- **HandlerType** Indicates the kind of content (app, driver, windows patch, etc.) +- **FlightId** The specific id of the flight the device is getting +- **HandlerType** Indicates the kind of content (app, driver, windows patch, etc.) - **RevisionNumber** Identifies the revision number of this specific piece of content - **ServiceGuid** Identifier for the service to which the software distribution client is connecting (Windows Update, Windows Store, etc) -- **SystemBIOSMajorRelease** Major release version of the system bios -- **SystemBIOSMinorRelease** Minor release version of the system bios -- **UpdateId** Identifier associated with the specific piece of content -- **WUDeviceID** Unique device id controlled by the software distribution client +- **SystemBIOSMajorRelease** Major release version of the system bios +- **SystemBIOSMinorRelease** Minor release version of the system bios +- **UpdateId** Identifier associated with the specific piece of content +- **WUDeviceID** Unique device id controlled by the software distribution client ### SoftwareUpdateClientTelemetry.Download -Download process event for target update on Windows Update client (see eventscenario field for specifics, e.g.: started/failed/succeeded) +Download process event for target update on Windows Update client. See EventScenario field for specifics (started/failed/succeeded). The following fields are available: -- **ActiveDownloadTime** How long the download took, in seconds, excluding time where the update wasn't actively being downloaded. +- **ActiveDownloadTime** Number of seconds the update was actively being downloaded. - **AppXBlockHashValidationFailureCount** A count of the number of blocks that have failed validation after being downloaded. - **AppXDownloadScope** Indicates the scope of the download for application content. For streaming install scenarios, AllContent - non-streaming download, RequiredOnly - streaming download requested content required for launch, AutomaticOnly - streaming download requested automatic streams for the app, and Unknown - for events sent before download scope is determined by the Windows Update client. - **BiosFamily** The family of the BIOS (Basic Input Output System). @@ -3666,19 +3746,20 @@ The following fields are available: - **BiosSKUNumber** The sku number of the device BIOS. - **BIOSVendor** The vendor of the BIOS. - **BiosVersion** The version of the BIOS. -- **BundleBytesDownloaded** How many bytes were downloaded for the specific content bundle. +- **BundleBytesDownloaded** Number of bytes downloaded for the specific content bundle. - **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. -- **BundleRepeatFailFlag** Indicates whether this particular update bundle had previously failed to download. +- **BundleRepeatFailFlag** Indicates whether this particular update bundle previously failed to download. - **BundleRevisionNumber** Identifies the revision number of the content bundle. -- **BytesDownloaded** How many bytes were downloaded for an individual piece of content (not the entire bundle). +- **BytesDownloaded** Number of bytes that were downloaded for an individual piece of content (not the entire bundle). - **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. - **CbsDownloadMethod** Indicates whether the download was a full-file download or a partial/delta download. -- **CDNCountryCode** Two letter country abbreviation for the CDN's location. +- **CDNCountryCode** Two letter country abbreviation for the Content Distribution Network (CDN) location. - **CDNId** ID which defines which CDN the software distribution client downloaded the content from. - **ClientVersion** The version number of the software distribution client. - **CurrentMobileOperator** The mobile operator the device is currently connected to. - **DeviceModel** What is the device model. - **DownloadPriority** Indicates whether a download happened at background, normal, or foreground priority. +- **DownloadScenarioId** A unique ID for a given download used to tie together WU and DO events. - **EventInstanceID** A globally unique identifier for event instance. - **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started downloading content, or whether it was cancelled, succeeded, or failed. - **EventType** Possible values are Child, Bundle, or Driver. @@ -3686,7 +3767,7 @@ The following fields are available: - **FeatureUpdatePause** Indicates whether feature OS updates are paused on the device. - **FlightBranch** The branch that a device is on if participating in flighting (pre-release builds). - **FlightBuildNumber** If this download was for a flight (pre-release build), this indicates the build number of that flight. -- **FlightId** The specific id of the flight (pre-release build) the device is getting. +- **FlightId** The specific ID of the flight (pre-release build) the device is getting. - **FlightRing** The ring (speed of getting builds) that a device is on if participating in flighting (pre-release builds). - **HandlerType** Indicates what kind of content is being downloaded (app, driver, windows patch, etc.). - **HardwareId** If this download was for a driver targeted to a particular device model, this ID indicates the model of the device. @@ -3703,10 +3784,10 @@ The following fields are available: - **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. - **QualityUpdatePause** Indicates whether quality OS updates are paused on the device. - **RegulationReason** The reason that the update is regulated -- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one +- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one. - **RepeatFailFlag** Indicates whether this specific piece of content had previously failed to download. - **RevisionNumber** Identifies the revision number of this specific piece of content. -- **ServiceGuid** An ID which represents which service the software distribution client is installing content for (Windows Update, Windows Store, etc.). +- **ServiceGuid** An ID that represents which service the software distribution client is installing content for (Windows Update, Windows Store, etc.). - **Setup360Phase** If the download is for an operating system upgrade, this datapoint indicates which phase of the upgrade is underway. - **ShippingMobileOperator** The mobile operator that a device shipped on. - **StatusCode** Indicates the result of a Download event (success, cancellation, failure code HResult). @@ -3722,7 +3803,6 @@ The following fields are available: - **UsedDO** Whether the download used the delivery optimization service. - **UsedSystemVolume** Indicates whether the content was downloaded to the device's main system storage drive, or an alternate storage drive. - **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. -- **DownloadScenarioId** A unique ID for a given download used to tie together WU and DO events. ### SoftwareUpdateClientTelemetry.DownloadCheckpoint @@ -3755,7 +3835,7 @@ The following fields are available: - **BytesTotal** Total bytes to transfer for this content - **BytesTransferred** Total bytes transferred for this content at the time of heartbeat -- **CallerApplicationName** Name provided by the caller who initiated API calls into the software distribution client +- **CallerApplicationName** Name provided by the caller who initiated API calls into the software distribution client - **ClientVersion** The version number of the software distribution client - **ConnectionStatus** Indicates the connectivity state of the device at the time of heartbeat - **CurrentError** Last (transient) error encountered by the active download @@ -3770,11 +3850,11 @@ The following fields are available: - **RelatedCV** The previous correlation vector that was used by the client, before swapping with a new one - **ResumeCount** Number of times this active download has resumed from a suspended state - **RevisionNumber** Identifies the revision number of this specific piece of content -- **ServiceGuid** Identifier for the service to which the software distribution client is connecting (Windows Update, Microsoft Store, etc) +- **ServiceGuid** Identifier for the service to which the software distribution client is connecting (Windows Update, Microsoft Store, etc) - **SuspendCount** Number of times this active download has entered a suspended state - **SuspendReason** Last reason for why this active download entered a suspended state -- **UpdateId** Identifier associated with the specific piece of content -- **WUDeviceID** Unique device id controlled by the software distribution client +- **UpdateId** Identifier associated with the specific piece of content +- **WUDeviceID** Unique device id controlled by the software distribution client ### SoftwareUpdateClientTelemetry.Install @@ -3790,43 +3870,43 @@ The following fields are available: - **BIOSVendor** The vendor of the BIOS. - **BiosVersion** The version of the BIOS. - **BundleId** Identifier associated with the specific content bundle; should not be all zeros if the bundleID was found. -- **BundleRepeatFailFlag** Has this particular update bundle previously failed to install? +- **BundleRepeatFailFlag** Indicates whether this particular update bundle previously failed to install. - **BundleRevisionNumber** Identifies the revision number of the content bundle. - **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. - **ClientVersion** The version number of the software distribution client. - **CSIErrorType** The stage of CBS installation where it failed. -- **CurrentMobileOperator** Mobile operator that device is currently connected to. -- **DeviceModel** What is the device model. +- **CurrentMobileOperator** The mobile operator to which the device is currently connected. +- **DeviceModel** The device model. - **DriverPingBack** Contains information about the previous driver and system state. - **EventInstanceID** A globally unique identifier for event instance. - **EventScenario** Indicates the purpose of sending this event - whether because the software distribution just started installing content, or whether it was cancelled, succeeded, or failed. - **EventType** Possible values are Child, Bundle, or Driver. - **ExtendedErrorCode** The extended error code. -- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode wasn't specific enough. -- **FeatureUpdatePause** Are feature OS updates paused on the device? +- **ExtendedStatusCode** Secondary error code for certain scenarios where StatusCode is not specific enough. +- **FeatureUpdatePause** Indicates whether feature OS updates are paused on the device. - **FlightBranch** The branch that a device is on if participating in the Windows Insider Program. - **FlightBuildNumber** If this installation was for a Windows Insider build, this is the build number of that build. - **FlightId** The specific ID of the Windows Insider build the device is getting. - **FlightRing** The ring that a device is on if participating in the Windows Insider Program. -- **HandlerType** Indicates what kind of content is being installed. Example: app, driver, Windows update +- **HandlerType** Indicates what kind of content is being installed (for example, app, driver, Windows update). - **HardwareId** If this install was for a driver targeted to a particular device model, this ID indicates the model of the device. - **HomeMobileOperator** The mobile operator that the device was originally intended to work with. - **IntentPFNs** Intended application-set metadata for atomic update scenarios. -- **IsDependentSet** Is the driver part of a larger System Hardware/Firmware update? -- **IsFinalOutcomeEvent** Does this event signal the end of the update/upgrade process? -- **IsFirmware** Is this update a firmware update? -- **IsSuccessFailurePostReboot** Did it succeed and then fail after a restart? -- **IsWUfBDualScanEnabled** Is Windows Update for Business dual scan enabled on the device? -- **IsWUfBEnabled** Is Windows Update for Business enabled on the device? -- **MergedUpdate** Was the OS update and a BSP update merged for installation? +- **IsDependentSet** Indicates whether the driver is part of a larger System Hardware/Firmware update. +- **IsFinalOutcomeEvent** Indicates whether this event signals the end of the update/upgrade process. +- **IsFirmware** Indicates whether this update is a firmware update. +- **IsSuccessFailurePostReboot** Indicates whether the update succeeded and then failed after a restart. +- **IsWUfBDualScanEnabled** Indicates whether Windows Update for Business dual scan is enabled on the device. +- **IsWUfBEnabled** Indicates whether Windows Update for Business is enabled on the device. +- **MergedUpdate** Indicates whether the OS update and a BSP update merged for installation. - **MsiAction** The stage of MSI installation where it failed. - **MsiProductCode** The unique identifier of the MSI installer. - **PackageFullName** The package name of the content being installed. - **PhonePreviewEnabled** Indicates whether a phone was getting preview build, prior to flighting being introduced. -- **ProcessName** The process name of the caller who initiated API calls, in the event where CallerApplicationName was not provided. -- **QualityUpdatePause** Are quality OS updates paused on the device? +- **ProcessName** The process name of the caller who initiated API calls, in the event that CallerApplicationName was not provided. +- **QualityUpdatePause** Indicates whether quality OS updates are paused on the device. - **RelatedCV** The previous Correlation Vector that was used before swapping with a new one -- **RepeatFailFlag** Indicates whether this specific piece of content had previously failed to install. +- **RepeatFailFlag** Indicates whether this specific piece of content previously failed to install. - **RevisionNumber** The revision number of this specific piece of content. - **ServiceGuid** An ID which represents which service the software distribution client is installing content for (Windows Update, Windows Store, etc.). - **Setup360Phase** If the install is for an operating system upgrade, indicates which phase of the upgrade is underway. @@ -3836,8 +3916,8 @@ The following fields are available: - **SystemBIOSMinorRelease** Minor version of the BIOS. - **TargetGroupId** For drivers targeted to a specific device model, this ID indicates the distribution group of devices receiving that driver. - **TargetingVersion** For drivers targeted to a specific device model, this is the version number of the drivers being distributed to the device. -- **TransactionCode** The ID which represents a given MSI installation -- **UpdateId** Unique update ID +- **TransactionCode** The ID that represents a given MSI installation. +- **UpdateId** Unique update ID. - **UpdateImportance** Indicates whether a piece of content was marked as Important, Recommended, or Optional. - **UsedSystemVolume** Indicates whether the content was downloaded and then installed from the device's main system storage drive, or an alternate storage drive. - **WUDeviceID** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. @@ -3849,13 +3929,13 @@ This event sends data about an AppX app that has been updated from the Microsoft The following fields are available: -- **ApplicableUpdateInfo** Metadata for the updates which were detected as applicable -- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client +- **ApplicableUpdateInfo** Metadata for the updates which were detected as applicable. +- **CallerApplicationName** The name provided by the caller who initiated API calls into the software distribution client. - **IntentPFNs** Intended application-set metadata for atomic update scenarios. -- **NumberOfApplicableUpdates** The number of updates which were ultimately deemed applicable to the system after the detection process is complete -- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one -- **ServiceGuid** An ID which represents which service the software distribution client is connecting to (Windows Update, Windows Store, etc.) -- **WUDeviceID** The unique device ID controlled by the software distribution client +- **NumberOfApplicableUpdates** The number of updates ultimately deemed applicable to the system after the detection process is complete. +- **RelatedCV** The previous Correlation Vector that was used before swapping with a new one. +- **ServiceGuid** An ID that represents which service the software distribution client is connecting to (Windows Update, Windows Store, etc.). +- **WUDeviceID** The unique device ID controlled by the software distribution client. ### SoftwareUpdateClientTelemetry.UpdateMetadataIntegrity @@ -3864,145 +3944,150 @@ Ensures Windows Updates are secure and complete. Event helps to identify whether The following fields are available: +- **CallerApplicationName** Name of application making the Windows Update request. Used to identify context of request. - **EndpointUrl** URL of the endpoint where client obtains update metadata. Used to identify test vs staging vs production environments. - **EventScenario** Indicates the purpose of the event - whether because scan started, succeded, failed, etc. -- **ExtendedStatusCode** Secondary status code for certain scenarios where StatusCode was not specific enough. -- **LeafCertId** Integral id from the FragmentSigning data for certificate which failed. -- **MetadataIntegrityMode** Mode of update transport metadata integrity check. 0-Unknown, 1-Ignoe, 2-Audit, 3-Enforce +- **ExtendedStatusCode** Secondary status code for certain scenarios where StatusCode was not specific enough. +- **LeafCertId** Integral id from the FragmentSigning data for certificate which failed. +- **ListOfSHA256OfIntermediateCerData** A semicolon delimited list of base64 encoding of hashes for the Base64CerData in the FragmentSigning data of an intermediate certificate. +- **MetadataIntegrityMode** Mode of update transport metadata integrity check. 0-Unknown, 1-Ignoe, 2-Audit, 3-Enforce - **MetadataSignature** Base64 string of the signature associated with the update metadata (specified by revision id) +- **RawMode** Raw unparsed mode string from the SLS response. May be null if not applicable. +- **RawValidityWindowInDays** The raw unparsed validity window string in days of the timestamp token. This field is null if not applicable. - **RevisionId** Identifies the revision of this specific piece of content - **RevisionNumber** Identifies the revision number of this specific piece of content - **ServiceGuid** Identifier for the service to which the software distribution client is connecting (Windows Update, Windows Store, etc) -- **SHA256OfLeafCertPublicKey** Base64 encoding of hash of the Base64CertData in the FragmentSigning data of leaf certificate. +- **SHA256OfLeafCerData** A base64 encoding of the hash for the Base64CerData in the FragmentSigning data of the leaf certificate. +- **SHA256OfLeafCertPublicKey** Base64 encoding of hash of the Base64CertData in the FragmentSigning data of leaf certificate. - **SHA256OfTimestampToken** Base64 string of hash of the timestamp token blob - **SignatureAlgorithm** Hash algorithm for the metadata signature - **SLSPrograms** A test program a machine may be opted in. Examples include "Canary" and "Insider Fast". - **StatusCode** Result code of the event (success, cancellation, failure code HResult) -- **TimestampTokenId** Created time encoded in the timestamp blob. This will be zeroed if the token is itself malformed and decoding failed. -- **UpdateId** Identifier associated with the specific piece of content -- **RawMode** Raw unparsed mode string from the SLS response. May be null if not applicable. -- **TimestampTokenCertThumbprint** The thumbprint of the encoded timestamp token. +- **TimestampTokenCertThumbprint** The thumbprint of the encoded timestamp token. +- **TimestampTokenId** Created time encoded in the timestamp blob. This will be zeroed if the token is itself malformed and decoding failed. +- **UpdateId** Identifier associated with the specific piece of content - **ValidityWindowInDays** The validity window that's in effect when verifying the timestamp. -- **CallerApplicationName** Name of application making the Windows Update request. Used to identify context of request. -- **ListOfSHA256OfIntermediateCerData** A semicolon delimited list of base64 encoding of hashes for the Base64CerData in the FragmentSigning data of an intermediate certificate. -- **RawValidityWindowInDays** The raw unparsed validity window string in days of the timestamp token. This field is null if not applicable. -- **SHA256OfLeafCerData** A base64 encoding of the hash for the Base64CerData in the FragmentSigning data of the leaf certificate. ## Update events ### Update360Telemetry.UpdateAgentCommit -This event collects information regarding the commit phase of the new UUP (Unified Update Platform) update scenario, which is leveraged by both Mobile and Desktop. - -The following fields are available: - -- **ErrorCode** The error code returned for the current install phase. -- **FlightId** Unique ID for each flight. -- **ObjectId** Unique value for each Update Agent mode. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **Result** Outcome of the install phase of the update. -- **ScenarioId** Indicates the update scenario. -- **SessionId** Unique value for each update attempt. -- **UpdateId** Unique ID for each update. - - -### Update360Telemetry.UpdateAgentDownloadRequest - - The UpdateAgent_DownloadRequest event sends data for the download request phase of updating Windows via the new UUP (Unified Update Platform) scenario. Applicable to PC and Mobile. - -The following fields are available: - -- **DeletedCorruptFiles** Boolean indicating whether corrupt payload was deleted. -- **ErrorCode** The error code returned for the current download request phase. -- **FlightId** Unique ID for each flight. -- **ObjectId** Unique value for each Update Agent mode (same concept as InstanceId for Setup360) -- **PackageCountOptional** Number of optional packages requested. -- **PackageCountRequired** Number of required packages requested. -- **PackageCountTotal** Total number of packages needed. -- **PackageCountTotalCanonical** Total number of canonical packages. -- **PackageCountTotalDiff** Total number of diff packages. -- **PackageCountTotalExpress** Total number of express packages. -- **PackageSizeCanonical** Size of canonical packages in bytes. -- **PackageSizeDiff** Size of diff packages in bytes. -- **PackageSizeExpress** Size of express packages in bytes. -- **RangeRequestState** Indicates the range request type used. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **Result** Outcome of the download request phase of update. -- **ScenarioId** Indicates the update scenario. -- **SessionId** Unique value for each attempt (same value for initialize, download, install commit phases) -- **UpdateId** Unique ID for each update. -- **PackageExpressType** Type of express package. - - -### Update360Telemetry.UpdateAgentExpand - - This event collects information regarding the expansion phase of the new UUP (Unified Update Platform) update scenario; which is leveraged by both Mobile and Desktop. - -The following fields are available: - -- **ElapsedTickCount** Time taken for expand phase. -- **EndFreeSpace** Free space after expand phase. -- **EndSandboxSize** Sandbox size after expand phase. -- **ErrorCode** The error code returned for the current install phase. -- **FlightId** Unique ID for each flight. -- **ObjectId** Unique value for each Update Agent mode. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **ScenarioId** Indicates the update scenario. -- **SessionId** Unique value for each update attempt. -- **StartFreeSpace** Free space before expand phase. -- **StartSandboxSize** Sandbox size after expand phase. -- **UpdateId** Unique ID for each update. - - -### Update360Telemetry.UpdateAgentFellBackToCanonical - -This event collects information when express could not be used and we fall back to canonical during the new UUP (Unified Update Platform) update scenario, which is leveraged by both Mobile and Desktop. - -The following fields are available: - -- **FlightId** Unique ID for each flight. -- **ObjectId** Unique value for each Update Agent mode. -- **PackageCount** Number of packages that feel back to canonical. -- **PackageList** PackageIds which fell back to canonical. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **ScenarioId** Indicates the update scenario. -- **SessionId** Unique value for each update attempt. -- **UpdateId** Unique ID for each update. - - -### Update360Telemetry.UpdateAgentInitialize - - The UpdateAgentInitialize event sends data for the initialize phase of updating Windows via the new UUP (Unified Update Platform) scenario. Applicable to both PCs and Mobile. - -The following fields are available: - -- **ErrorCode** The error code returned for the current install phase. -- **FlightId** Unique ID for each flight. -- **FlightMetadata** Contains the FlightId and the build being flighted. -- **ObjectId** Unique value for each Update Agent mode. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **Result** Outcome of the install phase of the update. -- **ScenarioId** Indicates the update scenario. -- **SessionData** String containing instructions to update agent for processing FODs and DUICs (Null for other scenarios). -- **SessionId** Unique value for each update attempt. -- **UpdateId** Unique ID for each update. - - -### Update360Telemetry.UpdateAgentInstall - -The UpdateAgentInstall event sends data for the install phase of updating Windows. +This event collects information regarding the commit phase of the new Unified Update Platform (UUP) update scenario, which is leveraged by both Mobile and Desktop. The following fields are available: - **ErrorCode** The error code returned for the current install phase. -- **FlightId** Unique value for each Update Agent mode (same concept as InstanceId for Setup360). -- **ObjectId** Correlation vector value generated from the latest USO scan. -- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **FlightId** Unique ID for each flight. +- **ObjectId** Unique value for each Update Agent mode. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **Result** Outcome of the install phase of the update. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. +- **UpdateId** Unique ID for each update. + + +### Update360Telemetry.UpdateAgentDownloadRequest + +This event sends data for the download request phase of updating Windows via the new Unified Update Platform (UUP) scenario. Applicable to PC and Mobile. + +The following fields are available: + +- **DeletedCorruptFiles** Boolean indicating whether corrupt payload was deleted. +- **DownloadRequests** Number of times a download was retried. +- **ErrorCode** The error code returned for the current download request phase. +- **ExtensionName** Indicates whether the payload is related to Operating System content or a plugin. +- **FlightId** Unique ID for each flight. +- **InternalFailureResult** Indicates a non-fatal error from a plugin. +- **ObjectId** Unique value for each Update Agent mode (same concept as InstanceId for Setup360). +- **PackageCountOptional** Number of optional packages requested. +- **PackageCountRequired** Number of required packages requested. +- **PackageCountTotal** Total number of packages needed. +- **PackageCountTotalCanonical** Total number of canonical packages. +- **PackageCountTotalDiff** Total number of diff packages. +- **PackageCountTotalExpress** Total number of express packages. +- **PackageExpressType** Type of express package. +- **PackageSizeCanonical** Size of canonical packages in bytes. +- **PackageSizeDiff** Size of diff packages in bytes. +- **PackageSizeExpress** Size of express packages in bytes. +- **RangeRequestState** Indicates the range request type used. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **Result** Outcome of the download request phase of update. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each attempt (same value for initialize, download, install commit phases). +- **UpdateId** Unique ID for each update. + + +### Update360Telemetry.UpdateAgentExpand + +This event collects information regarding the expansion phase of the new Unified Update Platform (UUP) update scenario, which is leveraged by both Mobile and Desktop. + +The following fields are available: + +- **ElapsedTickCount** Time taken for expand phase. +- **EndFreeSpace** Free space after expand phase. +- **EndSandboxSize** Sandbox size after expand phase. +- **ErrorCode** The error code returned for the current install phase. +- **FlightId** Unique ID for each flight. +- **ObjectId** Unique value for each Update Agent mode. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. +- **StartFreeSpace** Free space before expand phase. +- **StartSandboxSize** Sandbox size after expand phase. +- **UpdateId** Unique ID for each update. + + +### Update360Telemetry.UpdateAgentFellBackToCanonical + +This event collects information when express could not be used and we fall back to canonical during the new Unified Update Platform (UUP) update scenario, which is leveraged by both Mobile and Desktop. + +The following fields are available: + +- **FlightId** Unique ID for each flight. +- **ObjectId** Unique value for each Update Agent mode. +- **PackageCount** Number of packages that feel back to canonical. +- **PackageList** PackageIds which fell back to canonical. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. +- **UpdateId** Unique ID for each update. + + +### Update360Telemetry.UpdateAgentInitialize + +This event sends data for the initialize phase of updating Windows via the new Unified Update Platform (UUP) scenario, which is applicable to both PCs and Mobile. + +The following fields are available: + +- **ErrorCode** The error code returned for the current install phase. +- **FlightId** Unique ID for each flight. +- **FlightMetadata** Contains the FlightId and the build being flighted. +- **ObjectId** Unique value for each Update Agent mode. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **Result** Outcome of the install phase of the update. +- **ScenarioId** Indicates the update scenario. +- **SessionData** String containing instructions to update agent for processing FODs and DUICs (Null for other scenarios). +- **SessionId** Unique value for each update attempt. +- **UpdateId** Unique ID for each update. + + +### Update360Telemetry.UpdateAgentInstall + +This event sends data for the install phase of updating Windows. + +The following fields are available: + +- **ErrorCode** The error code returned for the current install phase. +- **ExtensionName** Indicates whether the payload is related to Operating System content or a plugin. +- **FlightId** Unique value for each Update Agent mode (same concept as InstanceId for Setup360). +- **InternalFailureResult** Indicates a non-fatal error from a plugin. +- **ObjectId** Correlation vector value generated from the latest USO scan. +- **RelatedCV** Correlation vector value generated from the latest USO scan. - **Result** The result for the current install phase. -- **ScenarioId** Indicates the update scenario. -- **SessionId** Unique value for each update attempt. -- **UpdateId** Unique ID for each update. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. +- **UpdateId** Unique ID for each update. ### Update360Telemetry.UpdateAgentMerge @@ -4011,85 +4096,85 @@ The UpdateAgentMerge event sends data on the merge phase when updating Windows. The following fields are available: -- **ErrorCode** The error code returned for the current merge phase. +- **ErrorCode** The error code returned for the current merge phase. - **FlightId** Unique ID for each flight. -- **ObjectId** Unique value for each Update Agent mode. -- **RelatedCV** Related correlation vector value. -- **Result** Outcome of the merge phase of the update. -- **ScenarioId** Indicates the update scenario. -- **SessionId** Unique value for each attempt. -- **UpdateId** Unique ID for each update. +- **ObjectId** Unique value for each Update Agent mode. +- **RelatedCV** Related correlation vector value. +- **Result** Outcome of the merge phase of the update. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each attempt. +- **UpdateId** Unique ID for each update. ### Update360Telemetry.UpdateAgentModeStart -The UpdateAgentModeStart event sends data for the start of each mode during the process of updating Windows via the new UUP (Unified Update Platform) scenario. Applicable to both PCs and Mobile. +This event sends data for the start of each mode during the process of updating Windows via the new Unified Update Platform (UUP) scenario. Applicable to both PCs and Mobile. The following fields are available: -- **FlightId** Unique ID for each flight. -- **Mode** Indicates the mode that has started. +- **FlightId** Unique ID for each flight. +- **Mode** Indicates the mode that has started. - **ObjectId** Unique value for each Update Agent mode. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **ScenarioId** Indicates the update scenario. -- **SessionId** Unique value for each update attempt. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. - **UpdateId** Unique ID for each update. - **Version** Version of update ### Update360Telemetry.UpdateAgentPostRebootResult -This event collects information for both Mobile and Desktop regarding the post reboot phase of the new UUP (Unified Update Platform) update scenario +This event collects information for both Mobile and Desktop regarding the post reboot phase of the new Unified Update Platform (UUP) update scenario. The following fields are available: -- **ErrorCode** The error code returned for the current post reboot phase -- **FlightId** The unique identifier for each flight -- **ObjectId** Unique value for each Update Agent mode -- **PostRebootResult** Indicates the Hresult -- **RelatedCV** Correlation vector value generated from the latest USO scan -- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate +- **ErrorCode** The error code returned for the current post reboot phase. +- **FlightId** The specific ID of the Windows Insider build the device is getting. +- **ObjectId** Unique value for each Update Agent mode. +- **PostRebootResult** Indicates the Hresult. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **ScenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate. - **SessionId** Unique value for each update attempt. -- **UpdateId** Unique ID for each update +- **UpdateId** Unique ID for each update. ### Update360Telemetry.UpdateAgentSetupBoxLaunch -The UpdateAgent_SetupBoxLaunch event sends data for the launching of the setup box when updating Windows via the new UUP (Unified Update Plaform) scenario. This event is only applicable to PCs. +The UpdateAgent_SetupBoxLaunch event sends data for the launching of the setup box when updating Windows via the new Unified Update Platform (UUP) scenario. This event is only applicable to PCs. The following fields are available: -- **FlightId** Unique ID for each flight. -- **FreeSpace** Free space on OS partition. -- **InstallCount** Number of install attempts using the same sandbox. -- **ObjectId** Unique value for each Update Agent mode. -- **Quiet** Indicates whether setup is running in quiet mode. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **SandboxSize** Size of the sandbox. -- **ScenarioId** Indicates the update scenario. -- **SessionId** Unique value for each update attempt. -- **SetupMode** Mode of setup to be launched. -- **UpdateId** Unique ID for each Update. -- **UserSession** Indicates whether install was invoked by user actions. - **ContainsExpressPackage** Indicates whether the download package is express. +- **FlightId** Unique ID for each flight. +- **FreeSpace** Free space on OS partition. +- **InstallCount** Number of install attempts using the same sandbox. +- **ObjectId** Unique value for each Update Agent mode. +- **Quiet** Indicates whether setup is running in quiet mode. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **SandboxSize** Size of the sandbox. +- **ScenarioId** Indicates the update scenario. +- **SessionId** Unique value for each update attempt. +- **SetupMode** Mode of setup to be launched. +- **UpdateId** Unique ID for each update. +- **UserSession** Indicates whether install was invoked by user actions. ## Update notification events ### Microsoft.Windows.UpdateNotificationPipeline.JavascriptJavascriptCriticalGenericMessage -Event to indicate that Javascript is reporting a schema and a set of values for critical telemetry. +This event indicates that Javascript is reporting a schema and a set of values for critical telemetry. The following fields are available: -- **CampaignConfigVersion** Config version of current campaign -- **CampaignID** Currently running campaign on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version of the current campaign on UNP -- **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client side counter which indicates ordering of events sent by this user -- **key1** UI interaction data +- **CampaignConfigVersion** Configuration version of the current campaign. +- **CampaignID** ID of the currently running campaign. +- **ConfigCatalogVersion** Current catalog version of the update notification. +- **ContentVersion** Content version of the current update notification campaign. +- **CV** Correlation vector. +- **DetectorVersion** Most recently run detector version for the current campaign. +- **GlobalEventCounter** Client side counter that indicates the ordering of events sent by this user. +- **key1** Interaction data for the UI - **key10** UI interaction data - **key11** UI interaction data - **key12** UI interaction data @@ -4098,18 +4183,9 @@ The following fields are available: - **key15** UI interaction data - **key16** UI interaction data - **key17** UI interaction data -- **key2** UI interaction data -- **key3** UI interaction data -- **key4** UI interaction data -- **key5** UI interaction data -- **key6** UI interaction data -- **key7** Interaction data for the UI -- **key8** Interaction data for the UI -- **key9** UI interaction data -- **PackageVersion** Current package version of UNP -- **schema** UI interaction type - **key18** UI interaction data - **key19** UI interaction data +- **key2** Interaction data for the UI - **key20** UI interaction data - **key21** Interaction data for the UI - **key22** UI interaction data @@ -4118,120 +4194,156 @@ The following fields are available: - **key25** UI interaction data - **key26** UI interaction data - **key27** UI interaction data -- **key28** Interaction data for the UI +- **key28** UI interaction data - **key29** UI interaction data +- **key3** Interaction data for the UI - **key30** UI interaction data +- **key4** Interaction data for the UI +- **key5** UI interaction data +- **key6** UI interaction data +- **key7** Interaction data for the UI +- **key8** Interaction data for the UI +- **key9** UI interaction data +- **PackageVersion** Current package version of the update notification. +- **schema** UI interaction type. ### Microsoft.Windows.UpdateNotificationPipeline.UNPCampaignHeartbeat -This event is sent at the start of each campaign, to be used as a heartbeat +This event is sent at the start of each campaign, to be used as a heartbeat. The following fields are available: -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Currently campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP -- **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user -- **PackageVersion** Current UNP package version +- **CampaignConfigVersion** Configuration version for the current campaign. +- **CampaignID** Current campaign that is running on Update Notification Pipeline. +- **ConfigCatalogVersion** Current catalog version of Update Notification Pipeline. +- **ContentVersion** Content version for the current campaign on Update Notification Pipeline. +- **CV** Correlation vector. +- **DetectorVersion** Most recently run detector version for the current campaign on Update Notification Pipeline. +- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user. +- **PackageVersion** Current package version for Update Notification Pipeline. ### Microsoft.Windows.UpdateNotificationPipeline.UNPCampaignManagerCleaningCampaign -This event indicates that the Campaign Manager is cleaning up the campaign content +This event indicates that the Campaign Manager is cleaning up the campaign content. The following fields are available: -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Current campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP +- **CampaignConfigVersion** Configuration version for the current campaign. +- **CampaignID** The current campaign that is running on Update Notification Pipeline (UNP). +- **ConfigCatalogVersion** The current catalog version of the Update Notification Pipeline (UNP). +- **ContentVersion** Content version for the current campaign on UNP. - **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user -- **PackageVersion** Current UNP package version - - -### Microsoft.Windows.UpdateNotificationPipeline.UNPCampaignManagerHeartbeat - -This event is sent at the start of the CampaignManager event and is intended to be used as a heartbeat - -The following fields are available: - -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Currently campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP -- **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user -- **PackageVersion** Current UNP package version +- **DetectorVersion** Most recently run detector version for the current campaign on UNP. +- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user. +- **PackageVersion** Current UNP package version. ### Microsoft.Windows.UpdateNotificationPipeline.UnpCampaignManagerGetIsCamppaignCompleteFailed -This event is sent when a campaign completion status query fails +This event is sent when a campaign completion status query fails. The following fields are available: -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Current campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP -- **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user -- **hresult** HRESULT of the failure -- **PackageVersion** Current UNP package version +- **CampaignConfigVersion** Configuration version for the current campaign. +- **CampaignID** Current campaign that is running on Update Notification Pipeline (UNP). +- **ConfigCatalogVersion** Current catalog version of UNP. +- **ContentVersion** Content version for the current campaign on UNP. +- **CV** Correlation vector. +- **DetectorVersion** Most recently run detector version for the current campaign on UNP. +- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user. +- **hresult** HRESULT of the failure. +- **PackageVersion** Current UNP package version. + + +### Microsoft.Windows.UpdateNotificationPipeline.UNPCampaignManagerHeartbeat + +This event is sent at the start of the CampaignManager event and is intended to be used as a heartbeat. + +The following fields are available: + +- **CampaignConfigVersion** Configuration version for the current campaign. +- **CampaignID** Currently campaign that is running on Update Notification Pipeline (UNP). +- **ConfigCatalogVersion** Current catalog version of UNP. +- **ContentVersion** Content version for the current campaign on UNP. +- **CV** Correlation vector. +- **DetectorVersion** Most recently run detector version for the current campaign on UNP. +- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user. +- **PackageVersion** Current UNP package version. ### Microsoft.Windows.UpdateNotificationPipeline.UnpCampaignManagerRunCampaignFailed -This event is sent when the Campaign Manager encounters an unexpected error while running the campaign +This event is sent when the Campaign Manager encounters an unexpected error while running the campaign. The following fields are available: -- **CampaignConfigVersion** Configuration version for the current campaign -- **CampaignID** Currently campaign that's running on UNP -- **ConfigCatalogVersion** Current catalog version of UNP -- **ContentVersion** Content version for the current campaign on UNP -- **CV** Correlation vector -- **DetectorVersion** Most recently run detector version for the current campaign on UNP -- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user -- **hresult** HRESULT of the failure -- **PackageVersion** Current UNP package version +- **CampaignConfigVersion** Configuration version for the current campaign. +- **CampaignID** Currently campaign that's running on Update Notification Pipeline (UNP). +- **ConfigCatalogVersion** Current catalog version of UNP. +- **ContentVersion** Content version for the current campaign on UNP. +- **CV** Correlation vector. +- **DetectorVersion** Most recently run detector version for the current campaign on UNP. +- **GlobalEventCounter** Client-side counter that indicates the event ordering sent by the user. +- **hresult** HRESULT of the failure. +- **PackageVersion** Current UNP package version. ## Upgrade events +### FacilitatorTelemetry.DCATDownload + +This event indicates whether devices received additional or critical supplemental content during an OS Upgrade, to help keep Windows up-to-date and secure. + +The following fields are available: + +- **DownloadSize** Download size of payload. +- **ElapsedTime** Time taken to download payload. +- **MediaFallbackUsed** Used to determine if we used Media CompDBs to figure out package requirements for the upgrade. +- **ResultCode** Result returned by the Facilitator DCAT call. +- **Scenario** Dynamic Update scenario (Image DU, or Setup DU). +- **Type** Type of package that was downloaded. + + +### FacilitatorTelemetry.InitializeDU + +This event determines whether devices received additional or critical supplemental content during an OS upgrade. + +The following fields are available: + +- **DCATUrl** The Delivery Catalog (DCAT) URL we send the request to. +- **DownloadRequestAttributes** The attributes we send to DCAT. +- **ResultCode** The result returned from the initialization of Facilitator with the URL/attributes. +- **Scenario** Dynamic Update scenario (Image DU, or Setup DU). +- **Version** Version of Facilitator. + + ### Setup360Telemetry.Downlevel -This event sends data indicating that the device has invoked the downlevel phase of the upgrade. It's used to help keep Windows up-to-date and secure. +This event sends data indicating that the device has started the downlevel phase of the upgrade, to help keep Windows up-to-date and secure. The following fields are available: - **ClientId** If using Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, the default value is Media360, but it can be overwritten by the caller to a unique value. +- **FlightData** Unique value that identifies the flight. - **HostOSBuildNumber** The build number of the downlevel OS. - **HostOsSkuName** The operating system edition which is running Setup360 instance (downlevel OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe. - **ReportId** In the Windows Update scenario, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback -- **Setup360Result** The result of Setup360. It's an HRESULT error code that can be used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT +- **Setup360Extended** More detailed information about phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360 (for example, Predownload, Install, Finalize, Rollback). +- **Setup360Result** The result of Setup360 (HRESULT used to diagnose errors). +- **Setup360Scenario** The Setup360 flow type (for example, Boot, Media, Update, MCT). - **SetupVersionBuildNumber** The build number of Setup360 (build number of the target OS). -- **State** Exit state of given Setup360 run. Example: succeeded, failed, blocked, cancelled -- **TestId** A string that uniquely identifies a group of events. +- **State** Exit state of given Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** An ID that uniquely identifies a group of events. - **WuId** This is the Windows Update Client ID. In the Windows Update scenario, this is the same as the clientId. -- **FlightData** Unique value that identifies the flight. ### Setup360Telemetry.Finalize -This event sends data indicating that the device has invoked the finalize phase of the upgrade, to help keep Windows up-to-date. +This event sends data indicating that the device has started the phase of finalizing the upgrade, to help keep Windows up-to-date and secure. The following fields are available: @@ -4241,45 +4353,46 @@ The following fields are available: - **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe - **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** More detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **TestId** A string to uniquely identify a group of events. +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** ID that uniquely identifies a group of events. - **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. ### Setup360Telemetry.OsUninstall -The event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, the Setup360Telemetry.OSUninstall indicates the outcome of an OS uninstall. +This event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, it indicates the outcome of an OS uninstall. The following fields are available: - **ClientId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **FlightData** Unique value that identifies the flight. - **HostOSBuildNumber** The build number of the previous OS. - **HostOsSkuName** The OS edition which is running the Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe. - **ReportId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** Detailed information about the phase or action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. - **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** Exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled -- **TestId** A string to uniquely identify a group of events. +- **State** Exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** ID that uniquely identifies a group of events. - **WuId** Windows Update client ID. -- **FlightData** Unique value that identifies the flight. ### Setup360Telemetry.PostRebootInstall -This event sends data indicating that the device has invoked the postrebootinstall phase of the upgrade, to help keep Windows up-to-date. +This event sends data indicating that the device has invoked the post reboot install phase of the upgrade, to help keep Windows up-to-date. The following fields are available: - **ClientId** With Windows Update, this is the Windows Update client ID that is passed to Setup. In Media setup, the default value is Media360, but can be overwritten by the caller to a unique value. +- **FlightData** Unique value that identifies the flight. - **HostOSBuildNumber** The build number of the previous OS. - **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe. @@ -4292,7 +4405,6 @@ The following fields are available: - **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled - **TestId** A string to uniquely identify a group of events. - **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as ClientId. -- **FlightData** Unique value that identifies the flight. ### Setup360Telemetry.PreDownloadQuiet @@ -4305,82 +4417,82 @@ The following fields are available: - **FlightData** Unique value that identifies the flight. - **HostOSBuildNumber** The build number of the previous OS. - **HostOsSkuName** The OS edition which is running Setup360 instance (previous operating system). -- **InstanceId** A unique GUID that identifies each instance of setuphost.exe +- **InstanceId** A unique GUID that identifies each instance of setuphost.exe. - **ReportId** Using Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, canceled -- **TestId** A string to uniquely identify a group of events. +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, canceled. +- **TestId** ID that uniquely identifies a group of events. - **WuId** This is the Windows Update Client ID. Using Windows Update, this is the same as the clientId. ### Setup360Telemetry.PreDownloadUX -This event sends data regarding OS Updates and Upgrades from Windows 7.X, Windows 8.X, Windows 10 and RS. Specifically the Setup360Telemetry.PredownloadUX indicates the outcome of the PredownloadUX portion of the update process +This event sends data regarding OS Updates and Upgrades from Windows 7.X, Windows 8.X, Windows 10 and RS, to help keep Windows up-to-date and secure. Specifically, it indicates the outcome of the PredownloadUX portion of the update process. The following fields are available: - **ClientId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **FlightData** In the WU scenario, this will be the WU client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. - **HostOSBuildNumber** The build number of the previous operating system. - **HostOsSkuName** The OS edition which is running the Setup360 instance (previous operating system). - **InstanceId** Unique GUID that identifies each instance of setuphost.exe. - **ReportId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type. Examplle: Boot, Media, Update, MCT +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of the target OS). -- **State** The exit state of the Setup360 run. Example: succeeded, failed, blocked, cancelled -- **TestId** A string to uniquely identify a group of events. +- **State** The exit state of the Setup360 run. Example: succeeded, failed, blocked, cancelled. +- **TestId** ID that uniquely identifies a group of events. - **WuId** Windows Update client ID. -- **FlightData** In the WU scenario, this will be the WU client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. ### Setup360Telemetry.PreInstallQuiet -This event sends data indicating that the device has invoked the preinstall quiet phase of the upgrade, to help keep Windows up to date. +This event sends data indicating that the device has invoked the preinstall quiet phase of the upgrade, to help keep Windows up-to-date. The following fields are available: - **ClientId** With Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **FlightData** Unique value that identifies the flight. - **HostOSBuildNumber** The build number of the previous OS. - **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe - **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback etc. +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. -- **Setup360Scenario** Setup360 flow type (Boot, Media, Update, MCT) +- **Setup360Scenario** Setup360 flow type (Boot, Media, Update, MCT). - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. - **TestId** A string to uniquely identify a group of events. - **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. -- **FlightData** Unique value that identifies the flight. ### Setup360Telemetry.PreInstallUX -This event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10. Specifically, the Setup360Telemetry.PreinstallUX indicates the outcome of the PreinstallUX portion of the update process. +This event sends data regarding OS updates and upgrades from Windows 7, Windows 8, and Windows 10, to help keep Windows up-to-date. Specifically, it indicates the outcome of the PreinstallUX portion of the update process. The following fields are available: - **ClientId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **FlightData** Unique value that identifies the flight. - **HostOSBuildNumber** The build number of the previous OS. - **HostOsSkuName** The OS edition which is running the Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe. - **ReportId** For Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. - **Setup360Result** The result of Setup360. This is an HRESULT error code that is used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type, Example: Boot, Media, Update, MCT +- **Setup360Scenario** The Setup360 flow type, Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. - **TestId** A string to uniquely identify a group of events. - **WuId** Windows Update client ID. -- **FlightData** Unique value that identifies the flight. ### Setup360Telemetry.Setup360 @@ -4389,13 +4501,29 @@ This event sends data about OS deployment scenarios, to help keep Windows up-to- The following fields are available: +- **ClientId** Retrieves the upgrade ID. In the Windows Update scenario, this will be the Windows Update client ID. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. - **FieldName** Retrieves the data point. - **FlightData** Specifies a unique identifier for each group of Windows Insider builds. - **InstanceId** Retrieves a unique identifier for each instance of a setup session. - **ReportId** Retrieves the report ID. - **ScenarioId** Retrieves the deployment scenario. - **Value** Retrieves the value associated with the corresponding FieldName. -- **ClientId** Retrieves the upgrade ID: Upgrades via Windows Update - specifies the WU clientID. All other deployment - static string. + + +### Setup360Telemetry.Setup360DynamicUpdate + +This event helps determine whether the device received supplemental content during an operating system upgrade, to help keep Windows up-to-date. + +The following fields are available: + +- **FlightData** Specifies a unique identifier for each group of Windows Insider builds. +- **InstanceId** Retrieves a unique identifier for each instance of a setup session. +- **Operation** Facilitator’s last known operation (scan, download, etc.). +- **ReportId** ID for tying together events stream side. +- **ResultCode** Result returned by setup for the entire operation. +- **Scenario** Dynamic Update scenario (Image DU, or Setup DU). +- **TargetBranch** Branch of the target OS. +- **TargetBuild** Build of the target OS. ### Setup360Telemetry.UnexpectedEvent @@ -4405,19 +4533,19 @@ This event sends data indicating that the device has invoked the unexpected even The following fields are available: - **ClientId** With Windows Update, this will be the Windows Update client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **FlightData** Unique value that identifies the flight. - **HostOSBuildNumber** The build number of the previous OS. - **HostOsSkuName** The OS edition which is running Setup360 instance (previous OS). - **InstanceId** A unique GUID that identifies each instance of setuphost.exe - **ReportId** With Windows Update, this is the updateID that is passed to Setup. In media setup, this is the GUID for the install.wim. -- **Setup360Extended** Extension of result - more granular information about phase/action when the potential failure happened -- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback -- **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used to diagnose errors. -- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT +- **Setup360Extended** Detailed information about the phase/action when the potential failure occurred. +- **Setup360Mode** The phase of Setup360. Example: Predownload, Install, Finalize, Rollback. +- **Setup360Result** The result of Setup360. This is an HRESULT error code that can be used used to diagnose errors. +- **Setup360Scenario** The Setup360 flow type. Example: Boot, Media, Update, MCT. - **SetupVersionBuildNumber** The build number of Setup360 (build number of target OS). -- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled +- **State** The exit state of a Setup360 run. Example: succeeded, failed, blocked, cancelled. - **TestId** A string to uniquely identify a group of events. - **WuId** This is the Windows Update Client ID. With Windows Update, this is the same as the clientId. -- **FlightData** Unique value that identifies the flight. ## Windows as a Service diagnostic events @@ -4428,116 +4556,505 @@ Result of the WaaSMedic operation. The following fields are available: -- **detectionSummary** Result of each applicable detection that was ran. +- **detectionSummary** Result of each applicable detection that was run. - **featureAssessmentImpact** WaaS Assessment impact for feature updates. - **hrEngineResult** Error code from the engine operation. +- **insufficientSessions** Device not eligible for diagnostics. - **isManaged** Device is managed for updates. - **isWUConnected** Device is connected to Windows Update. - **noMoreActions** No more applicable diagnostics. -- **qualityAssessmentImpact** WaaS Assessment impact for quality updates. -- **remediationSummary** Result of each applicable resolution that was ran. -- **usingBackupFeatureAssessment** Relying on backup feature assessment. +- **qualityAssessmentImpact** WaaS Assessment impact for quality updates. +- **remediationSummary** Result of each operation performed on a device to fix an invalid state or configuration that's preventing the device from getting updates. For example, if Windows Update service is turned off, the fix is to turn the it back on. +- **usingBackupFeatureAssessment** Relying on backup feature assessment. - **usingBackupQualityAssessment** Relying on backup quality assessment. -- **versionString** Version of the WaaSMedic engine. - **usingCachedFeatureAssessment** WaaS Medic run did not get OS build age from the network on the previous run. - **usingCachedQualityAssessment** WaaS Medic run did not get OS revision age from the network on the previous run. -- **insufficientSessions** Device not eligible for diagnostics. +- **versionString** Version of the WaaSMedic engine. -## Windows Error Reporting events - ## Windows Error Reporting MTT events ### Microsoft.Windows.WER.MTT.Denominator -This event provides a denominator to calculate MTTF (mean-time-to-failure) for crashes and other errors to help keep Windows up to date. +This event provides a denominator to calculate MTTF (mean-time-to-failure) for crashes and other errors, to help keep Windows up to date. The following fields are available: -- **Value** Standard UTC emitted DP value structure +- **Value** Standard UTC emitted DP value structure See [Microsoft.Windows.WER.MTT.Value](#microsoftwindowswermttvalue). + + +### Microsoft.Windows.WER.MTT.Value + +This event is used for differential privacy. + +The following fields are available: + +- **Algorithm** Privacy protecting algorithm used for randomization. +- **DPRange** Maximum mean value range. +- **DPValue** Randomized bit value (0 or 1) that can be reconstituted over a large population to estimate mean. +- **Epsilon** Constant used in algorithm for randomization. +- **HistType** Histogram type. +- **PertProb** Constant used in algorithm for randomization. + + +## Windows Store events + +### Microsoft.Windows.StoreAgent.Telemetry.AbortedInstallation + +This event is sent when an installation or update is canceled by a user or the system and is used to help keep Windows Apps up to date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** Number of retry attempts before it was canceled. +- **BundleId** The Item Bundle ID. +- **CategoryId** The Item Category ID. +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed before this operation. +- **IsBundle** Is this a bundle? +- **IsInteractive** Was this requested by a user? +- **IsMandatory** Was this a mandatory update? +- **IsRemediation** Was this a remediation install? +- **IsRestore** Is this automatically restoring a previously acquired product? +- **IsUpdate** Flag indicating if this is an update. +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The product family name of the product being installed. +- **ProductId** The identity of the package or packages being installed. +- **SystemAttemptNumber** The total number of automatic attempts at installation before it was canceled. +- **UserAttemptNumber** The total number of user attempts at installation before it was canceled. +- **WUContentId** Licensing identity of this package. + + +### Microsoft.Windows.StoreAgent.Telemetry.BeginGetInstalledContentIds + +This event is sent when an inventory of the apps installed is started to determine whether updates for those apps are available. It's used to help keep Windows up-to-date and secure. + + + +### Microsoft.Windows.StoreAgent.Telemetry.BeginUpdateMetadataPrepare + +This event is sent when the Store Agent cache is refreshed with any available package updates. It's used to help keep Windows up-to-date and secure. + + + +### Microsoft.Windows.StoreAgent.Telemetry.CancelInstallation + +This event is sent when an app update or installation is canceled while in interactive mode. This can be canceled by the user or the system. It's used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The names of all package or packages to be downloaded and installed. +- **AttemptNumber** Total number of installation attempts. +- **BundleId** The identity of the Windows Insider build that is associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **IsBundle** Is this a bundle? +- **IsInteractive** Was this requested by a user? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this an automatic restore of a previously acquired product? +- **IsUpdate** Is this a product update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of all packages to be downloaded and installed. +- **PreviousHResult** The previous HResult code. +- **PreviousInstallState** Previous installation state before it was canceled. +- **ProductId** The name of the package or packages requested for installation. +- **RelatedCV** Correlation Vector of a previous performed action on this product. +- **SystemAttemptNumber** Total number of automatic attempts to install before it was canceled. +- **UserAttemptNumber** Total number of user attempts to install before it was canceled. +- **WUContentId** The Windows Update content ID. + + +### Microsoft.Windows.StoreAgent.Telemetry.CompleteInstallOperationRequest + +This event is sent at the end of app installations or updates to help keep Windows up-to-date and secure. + +The following fields are available: + +- **CatalogId** The Store Product ID of the app being installed. +- **HResult** HResult code of the action being performed. +- **IsBundle** Is this a bundle? +- **PackageFamilyName** The name of the package being installed. +- **ProductId** The Store Product ID of the product being installed. +- **SkuId** Specific edition of the item being installed. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndAcquireLicense + +This event is sent after the license is acquired when a product is being installed. It's used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** Includes a set of package full names for each app that is part of an atomic set. +- **AttemptNumber** The total number of attempts to acquire this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** HResult code to show the result of the operation (success/failure). +- **IsBundle** Is this a bundle? +- **IsInteractive** Did the user initiate the installation? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this happening after a device restore? +- **IsUpdate** Is this an update? +- **PFN** Product Family Name of the product being installed. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The number of attempts by the system to acquire this product. +- **UserAttemptNumber** The number of attempts by the user to acquire this product +- **WUContentId** The Windows Update content ID. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndDownload + +This event is sent after an app is downloaded to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. +- **AttemptNumber** Number of retry attempts before it was canceled. +- **BundleId** The identity of the Windows Insider build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **DownloadSize** The total size of the download. +- **ExtendedHResult** Any extended HResult error codes. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this initiated by the user? +- **IsMandatory** Is this a mandatory installation? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this a restore of a previously acquired product? +- **IsUpdate** Is this an update? +- **ParentBundleId** The parent bundle ID (if it's part of a bundle). +- **PFN** The Product Family Name of the app being download. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The number of attempts by the system to download. +- **UserAttemptNumber** The number of attempts by the user to download. +- **WUContentId** The Windows Update content ID. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndFrameworkUpdate + +This event is sent when an app update requires an updated Framework package and the process starts to download it. It is used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **HResult** The result code of the last action performed before this operation. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndGetInstalledContentIds + +This event is sent after sending the inventory of the products installed to determine whether updates for those products are available. It's used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **HResult** The result code of the last action performed before this operation. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndInstall + +This event is sent after a product has been installed to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** The number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **ExtendedHResult** The extended HResult error code. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this an interactive installation? +- **IsMandatory** Is this a mandatory installation? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this automatically restoring a previously acquired product? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** Product Family Name of the product being installed. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The total number of system attempts. +- **UserAttemptNumber** The total number of user attempts. +- **WUContentId** The Windows Update content ID. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndScanForUpdates + +This event is sent after a scan for product updates to determine if there are packages to install. It's used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed. +- **IsApplicability** Is this request to only check if there are any applicable packages to install? +- **IsInteractive** Is this user requested? +- **IsOnline** Is the request doing an online check? + + +### Microsoft.Windows.StoreAgent.Telemetry.EndSearchUpdatePackages + +This event is sent after searching for update packages to install. It is used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** The total number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this user requested? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of the package or packages requested for install. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The total number of system attempts. +- **UserAttemptNumber** The total number of user attempts. +- **WUContentId** The Windows Update content ID. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndStageUserData + +This event is sent after restoring user data (if any) that needs to be restored following a product install. It is used to keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The name of all packages to be downloaded and installed. +- **AttemptNumber** The total number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this user requested? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of the package or packages requested for install. +- **ProductId** The Store Product ID for the product being installed. +- **SystemAttemptNumber** The total number of system attempts. +- **UserAttemptNumber** The total number of system attempts. +- **WUContentId** The Windows Update content ID. + + +### Microsoft.Windows.StoreAgent.Telemetry.EndUpdateMetadataPrepare + +This event happens after a scan for available app updates. It's used to help keep Windows up-to-date and secure. + +The following fields are available: + +- **HResult** The result code of the last action performed. + + +### Microsoft.Windows.StoreAgent.Telemetry.FulfillmentComplete + +This event is sent at the end of an app install or update to help keep Windows up-to-date and secure. + +The following fields are available: + +- **CatalogId** The name of the product catalog from which this app was chosen. +- **FailedRetry** Indicates whether the installation or update retry was successful. +- **HResult** The HResult code of the operation. +- **PFN** The Package Family Name of the app that is being installed or updated. +- **ProductId** The product ID of the app that is being updated or installed. + + +### Microsoft.Windows.StoreAgent.Telemetry.FulfillmentInitiate + +This event is sent at the beginning of an app install or update to help keep Windows up-to-date and secure. + +The following fields are available: + +- **CatalogId** The name of the product catalog from which this app was chosen. +- **PFN** The Package Family Name of the app that is being installed or updated. +- **ProductId** The product ID of the app that is being updated or installed. + + +### Microsoft.Windows.StoreAgent.Telemetry.InstallOperationRequest + +This event is sent when a product install or update is initiated, to help keep Windows up-to-date and secure. + +The following fields are available: + +- **BundleId** The identity of the build associated with this product. +- **CatalogId** If this product is from a private catalog, the Store Product ID for the product being installed. +- **ProductId** The Store Product ID for the product being installed. +- **SkuId** Specific edition ID being installed. +- **VolumePath** The disk path of the installation. + + +### Microsoft.Windows.StoreAgent.Telemetry.PauseInstallation + +This event is sent when a product install or update is paused (either by a user or the system), to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** The total number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this user requested? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The Product Full Name. +- **PreviousHResult** The result code of the last action performed before this operation. +- **PreviousInstallState** Previous state before the installation or update was paused. +- **ProductId** The Store Product ID for the product being installed. +- **RelatedCV** Correlation Vector of a previous performed action on this product. +- **SystemAttemptNumber** The total number of system attempts. +- **UserAttemptNumber** The total number of user attempts. +- **WUContentId** The Windows Update content ID. + + +### Microsoft.Windows.StoreAgent.Telemetry.ResumeInstallation + +This event is sent when a product install or update is resumed (either by a user or the system), to help keep Windows up-to-date and secure. + +The following fields are available: + +- **AggregatedPackageFullNames** The names of all packages to be downloaded and installed. +- **AttemptNumber** The number of retry attempts before it was canceled. +- **BundleId** The identity of the build associated with this product. +- **CategoryId** The identity of the package or packages being installed. +- **ClientAppId** The identity of the app that initiated this operation. +- **HResult** The result code of the last action performed before this operation. +- **IsBundle** Is this a bundle? +- **IsInteractive** Is this user requested? +- **IsMandatory** Is this a mandatory update? +- **IsRemediation** Is this repairing a previous installation? +- **IsRestore** Is this restoring previously acquired content? +- **IsUpdate** Is this an update? +- **IsUserRetry** Did the user initiate the retry? +- **ParentBundleId** The product ID of the parent (if this product is part of a bundle). +- **PFN** The name of the package or packages requested for install. +- **PreviousHResult** The previous HResult error code. +- **PreviousInstallState** Previous state before the installation was paused. +- **ProductId** The Store Product ID for the product being installed. +- **RelatedCV** Correlation Vector for the original install before it was resumed. +- **SystemAttemptNumber** The total number of system attempts. +- **UserAttemptNumber** The total number of user attempts. +- **WUContentId** The Windows Update content ID. + + +### Microsoft.Windows.StoreAgent.Telemetry.ResumeOperationRequest + +This event is sent when a product install or update is resumed by a user or on installation retries, to help keep Windows up-to-date and secure. + +The following fields are available: + +- **ProductId** The Store Product ID for the product being installed. + + +### Microsoft.Windows.StoreAgent.Telemetry.SearchForUpdateOperationRequest + +This event is sent when searching for update packages to install, to help keep Windows up-to-date and secure. + +The following fields are available: + +- **CatalogId** The Store Catalog ID for the product being installed. +- **ProductId** The Store Product ID for the product being installed. +- **SkuId** Specfic edition of the app being updated. + + +### Microsoft.Windows.StoreAgent.Telemetry.UpdateAppOperationRequest + +This event occurs when an update is requested for an app, to help keep Windows up-to-date and secure. + +The following fields are available: + +- **PFamN** The name of the app that is requested for update. ## Windows Update CSP events ### Microsoft.Windows.UpdateCsp.ExecuteRollBackFeatureFailed -The Execute Rollback Feature Failed event sends basic telemetry on the failure of the Feature Rollback. This functionality supports our feature by providing IT Admins the ability to see the operation failed, allowing them to do further triage of the device. +This event sends basic telemetry on the failure of the Feature Rollback. The following fields are available: -- **current** Result of currency check -- **dismOperationSucceeded** Dism uninstall operation status -- **hResult** Failure Error code -- **oSVersion** Build number of the machine -- **paused** Machine's pause status -- **rebootRequestSucceeded** Reboot CSP call success status -- **wUfBConnected** Result of WUfB connection check +- **current** Result of currency check. +- **dismOperationSucceeded** Dism uninstall operation status. +- **hResult** Failure error code. +- **oSVersion** Build number of the device. +- **paused** Indicates whether the device is paused. +- **rebootRequestSucceeded** Reboot Configuration Service Provider (CSP) call success status. +- **wUfBConnected** Result of WUfB connection check. ### Microsoft.Windows.UpdateCsp.ExecuteRollBackFeatureNotApplicable -The Execute Rollback Feature Not Applicable event sends basic telemetry on the applicability of the Feature Rollback, to support the functionality of Feature Rollback. This event provides critical information for the feature because it will alert IT Admins that devices they are attempting to rollback Features updates are not applicable. +This event sends basic telemetry on whether Feature Rollback (rolling back features updates) is applicable to a device. The following fields are available: -- **current** Result of currency check -- **dismOperationSucceeded** Dism uninstall operation status -- **oSVersion** Build number of the machine -- **paused** Machine's pause status -- **rebootRequestSucceeded** Reboot CSP call success status -- **wUfBConnected** Result of WUfB connection check +- **current** Result of currency check. +- **dismOperationSucceeded** Dism uninstall operation status. +- **oSVersion** Build number of the device. +- **paused** Indicates whether the device is paused. +- **rebootRequestSucceeded** Reboot Configuration Service Provider (CSP) call success status. +- **wUfBConnected** Result of WUfB connection check. ### Microsoft.Windows.UpdateCsp.ExecuteRollBackFeatureStarted -The Execute Rollback Feature Started event sends basic information on the start process to provide information that the Feature Rollback has started. +This event sends basic information indicating that Feature Rollback has started. ### Microsoft.Windows.UpdateCsp.ExecuteRollBackFeatureSucceeded -The Execute Rollback Feature Succeed event sends basic telemetry on the success of the Rollback of the Feature updates. This functionality supports our feature by providing insights to IT Admins of the success of the Feature rollback. +This event sends basic telemetry on the success of the rollback of feature updates. ### Microsoft.Windows.UpdateCsp.ExecuteRollBackQualityFailed -The Execute Rollback Quality Failed event sends basic telemetry on the failure of the rollback of the Quality/LCU builds. This functionality supports our feature by providing IT Admins the ability to see the operation failed allowing them to do further triage of the device. +This event sends basic telemetry on the failure of the rollback of the Quality/LCU builds. The following fields are available: -- **current** Result of currency check -- **dismOperationSucceeded** Dism uninstall operation status -- **hResult** Failure Error code -- **oSVersion** Build number of the machine -- **paused** Machine's pause status -- **rebootRequestSucceeded** Reboot CSP call success status -- **wUfBConnected** Result of WUfB connection check +- **current** Result of currency check. +- **dismOperationSucceeded** Dism uninstall operation status. +- **hResult** Failure error code. +- **oSVersion** Build number of the device. +- **paused** Indicates whether the device is paused. +- **rebootRequestSucceeded** Reboot Configuration Service Provider (CSP) call success status. +- **wUfBConnected** Result of Windows Update for Business connection check. ### Microsoft.Windows.UpdateCsp.ExecuteRollBackQualityNotApplicable -The Execute Rollback Quality Not Applicable event sends basic telemetry on the applicability of the Quality Rollback, to support the functionality of Quality Rollback. This event provides critical information for feature because it will alert IT Admins that devices they are attempting to rollback Quality updates are not applicable. +This event informs you whether a rollback of Quality updates is applicable to the devices that you are attempting to rollback. The following fields are available: -- **current** Result of currency check -- **dismOperationSucceeded** Dism uninstall operation status -- **oSVersion** Build number of the machine -- **paused** Machine's pause status -- **rebootRequestSucceeded** Reboot CSP call success status -- **wUfBConnected** Result of WUfB connection check +- **current** Result of currency check. +- **dismOperationSucceeded** Dism uninstall operation status. +- **oSVersion** Build number of the device. +- **paused** Indicates whether the device is paused. +- **rebootRequestSucceeded** Reboot Configuration Service Provider (CSP) call success status. +- **wUfBConnected** Result of WUfB connection check. ### Microsoft.Windows.UpdateCsp.ExecuteRollBackQualityStarted -The Execute Rollback Quality Started event sends basic information on the start process to provide information that the Quality Rollback has started. +This event indicates that the Quality Rollback process has started. ### Microsoft.Windows.UpdateCsp.ExecuteRollBackQualitySucceeded -The Execute Rollback Quality Succeed event sends basic telemetry on the success of the rollback of the Quality/LCU builds. This functionality supports our feature by providing insights to IT Admins of the success of the Quality rollback. +This event sends basic telemetry on the success of the rollback of the Quality/LCU builds. @@ -4549,37 +5066,37 @@ This event sends data describing the start of a new download to enable Delivery The following fields are available: -- **background** If the download is happening in the background -- **bytesRequested** Number of bytes requested for download. -- **cdnUrl** Url of the source CDN -- **costFlags** Network cost flags -- **deviceProfile** Identifies the usage or form factor (Desktop, Xbox, VM, etc) -- **diceRoll** Random number used for determining if a client will use peering -- **doClientVersion** Version of the Delivery Optimization client -- **doErrorCode** Delivery Optimization error code returned -- **downloadMode** DownloadMode used (CdnOnly = 0, Lan = 1, Group = 2, Internet = 3, Simple = 99, Bypass = 100) -- **downloadModeSrc** Source of the DownloadMode setting (KvsProvider: 0, GeoProvider: 1, GeoVerProvider: 2, CpProvider: 3, DiscoveryProvider: 4, RegistryProvider: 5, GroupPolicyProvider: 6, MdmProvider: 7, SettingsProvider: 8, InvalidProviderType: 9) -- **errorCode** Error code returned -- **experimentId** Used to correlate client/services calls that are part of the same test during A/B testing -- **fileID** ID of the File being downloaded -- **filePath** Path to where the downloaded file will be written -- **fileSize** Total filesize of the file that was downloaded -- **fileSizeCaller** Value for total file size provided by our caller -- **groupID** ID for the group -- **isVpn** If the machine is connected to a Virtual Private Network -- **jobID** Identifier for the Windows Update Job -- **peerID** ID for this Delivery Optimization client -- **predefinedCallerName** Name of the API caller -- **sessionID** ID for the file download session -- **setConfigs** ID of the update being downloaded -- **updateID** ID for the file download session -- **usedMemoryStream** If the download is using memory streaming in App downloads -- **callerName** Name of the API Caller -- **minDiskSizeGB** The minimum disk size policy set for the device to allow Peering with Delivery Optimization -- **minDiskSizePolicyEnforced** If there is an enforced mininum disk size requirement for peering -- **minFileSizePolicy** The minimum file size policy set for the device to allow Peering with Delivery Optimization -- **scenarioID** ID for the Scenario -- **isEncrypted** Whether the download is encrypted +- **background** Indicates whether the download is happening in the background. +- **bytesRequested** Number of bytes requested for the download. +- **callerName** Name of the API caller. +- **cdnUrl** The URL of the source CDN +- **costFlags** A set of flags representing network cost. +- **deviceProfile** Identifies the usage or form factor (such as Desktop, Xbox, or VM). +- **diceRoll** Random number used for determining if a client will use peering. +- **doClientVersion** The version of the Delivery Optimization client. +- **doErrorCode** The Delivery Optimization error code that was returned. +- **downloadMode** The download mode used for this file download session (CdnOnly = 0, Lan = 1, Group = 2, Internet = 3, Simple = 99, Bypass = 100). +- **downloadModeSrc** Source of the DownloadMode setting (KvsProvider = 0, GeoProvider = 1, GeoVerProvider = 2, CpProvider = 3, DiscoveryProvider = 4, RegistryProvider = 5, GroupPolicyProvider = 6, MdmProvider = 7, SettingsProvider = 8, InvalidProviderType = 9). +- **errorCode** The error code that was returned. +- **experimentId** ID used to correlate client/services calls that are part of the same test during A/B testing. +- **fileID** The ID of the file being downloaded. +- **filePath** The path to where the downloaded file will be written. +- **fileSize** Total file size of the file that was downloaded. +- **fileSizeCaller** Value for total file size provided by our caller. +- **groupID** ID for the group. +- **isEncrypted** Indicates whether the download is encrypted. +- **isVpn** Indicates whether the device is connected to a Virtual Private Network. +- **jobID** The ID of the Windows Update job. +- **minDiskSizeGB** The minimum disk size (in GB) policy set for the device to allow peering with delivery optimization. +- **minDiskSizePolicyEnforced** Indicates whether there is an enforced minimum disk size requirement for peering. +- **minFileSizePolicy** The minimum content file size policy to allow the download using peering with delivery optimization. +- **peerID** The ID for this delivery optimization client. +- **predefinedCallerName** Name of the API caller. +- **scenarioID** The ID of the scenario. +- **sessionID** The ID for the file download session. +- **setConfigs** A JSON representation of the configurations that have been set, and their sources. +- **updateID** The ID of the update being downloaded. +- **usedMemoryStream** Indicates whether the download used memory streaming. ## Windows Update events @@ -4591,328 +5108,328 @@ This event collects information regarding the state of devices and drivers on th The following fields are available: - **activated** Whether the entire device manifest update is considered activated and in use. -- **analysisErrorCount** How many driver packages that could not be analyzed because errors were hit during the analysis. -- **flightId** Unique ID for each flight. -- **missingDriverCount** How many driver packages that were delivered by the device manifest that are missing from the system. -- **missingUpdateCount** How many updates that were part of the device manifest that are missing from the system. -- **objectId** Unique value for each diagnostics session. -- **publishedCount** How many drivers packages that were delivered by the device manifest that are published and available to be used on devices. -- **relatedCV** Correlation vector value generated from the latest USO scan. -- **scenarioId** Indicates the update scenario. -- **sessionId** Unique value for each update session. -- **summary** A summary string that contains some basic information about driver packages that are part of the device manifest and any devices on the system that those driver packages match on. +- **analysisErrorCount** How many driver packages could not be analyzed because errors were hit during the analysis. +- **flightId** Unique ID for each flight. +- **missingDriverCount** How many driver packages that were delivered by the device manifest are missing from the system. +- **missingUpdateCount** How many updates that were part of the device manifest are missing from the system. +- **objectId** Unique value for each diagnostics session. +- **publishedCount** How many drivers packages that were delivered by the device manifest are published and available to be used on devices. +- **relatedCV** Correlation vector value generated from the latest USO scan. +- **scenarioId** Indicates the update scenario. +- **sessionId** Unique value for each update session. +- **summary** A summary string that contains some basic information about driver packages that are part of the device manifest and any devices on the system that those driver packages match. - **summaryAppendError** A Boolean indicating if there was an error appending more information to the summary string. -- **truncatedDeviceCount** How many devices are missing from the summary string due to there not being enough room in the string. -- **truncatedDriverCount** How many driver packages are missing from the summary string due to there not being enough room in the string. +- **truncatedDeviceCount** How many devices are missing from the summary string because there is not enough room in the string. +- **truncatedDriverCount** How many driver packages are missing from the summary string because there is not enough room in the string. - **unpublishedCount** How many drivers packages that were delivered by the device manifest that are still unpublished and unavailable to be used on devices. -- **updateId** Unique ID for each Update. +- **updateId** Unique ID for each update. ### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentCommit -This event collects information regarding the final commit phase of the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages +This event collects information regarding the final commit phase of the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages. The following fields are available: -- **errorCode** The error code returned for the current session initialization -- **flightId** The unique identifier for each flight -- **objectId** The unique GUID for each diagnostics session -- **relatedCV** A correlation vector value, generated from the latest USO scan -- **result** Outcome of the initialization of the session -- **scenarioId** Identifies the Update scenario -- **sessionId** The unique value for each update session -- **updateId** The unique identifier for each Update +- **errorCode** The error code returned for the current session initialization. +- **flightId** The unique identifier for each flight. +- **objectId** The unique GUID for each diagnostics session. +- **relatedCV** A correlation vector value generated from the latest USO scan. +- **result** Outcome of the initialization of the session. +- **scenarioId** Identifies the Update scenario. +- **sessionId** The unique value for each update session. +- **updateId** The unique identifier for each Update. ### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentDownloadRequest -This event collects information regarding the download request phase of the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages +This event collects information regarding the download request phase of the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages. The following fields are available: -- **deletedCorruptFiles** Indicates if UpdateAgent found any corrupt payload files and whether the payload was deleted -- **errorCode** The error code returned for the current session initialization -- **flightId** The unique identifier for each flight -- **objectId** Unique value for each Update Agent mode -- **packageCountOptional** Number of optional packages requested -- **packageCountRequired** Number of required packages requested -- **packageCountTotal** Total number of packages needed -- **packageCountTotalCanonical** Total number of canonical packages -- **packageCountTotalDiff** Total number of diff packages -- **packageCountTotalExpress** Total number of express packages -- **packageSizeCanonical** Size of canonical packages in bytes -- **packageSizeDiff** Size of diff packages in bytes -- **packageSizeExpress** Size of express packages in bytes -- **rangeRequestState** Represents the state of the download range request -- **relatedCV** Correlation vector value generated from the latest USO scan -- **result** Result of the download request phase of update -- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **sessionId** Unique value for each Update Agent mode attempt -- **updateId** Unique ID for each update +- **deletedCorruptFiles** Indicates if UpdateAgent found any corrupt payload files and whether the payload was deleted. +- **errorCode** The error code returned for the current session initialization. +- **flightId** The unique identifier for each flight. +- **objectId** Unique value for each Update Agent mode. +- **packageCountOptional** Number of optional packages requested. +- **packageCountRequired** Number of required packages requested. +- **packageCountTotal** Total number of packages needed. +- **packageCountTotalCanonical** Total number of canonical packages. +- **packageCountTotalDiff** Total number of diff packages. +- **packageCountTotalExpress** Total number of express packages. +- **packageSizeCanonical** Size of canonical packages in bytes. +- **packageSizeDiff** Size of diff packages in bytes. +- **packageSizeExpress** Size of express packages in bytes. +- **rangeRequestState** Represents the state of the download range request. +- **relatedCV** Correlation vector value generated from the latest USO scan. +- **result** Result of the download request phase of update. +- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate. +- **sessionId** Unique value for each Update Agent mode attempt. +- **updateId** Unique ID for each update. ### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentInitialize -This event sends data for initializing a new update session for the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages +This event sends data for initializing a new update session for the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages. The following fields are available: -- **errorCode** The error code returned for the current initialize phase -- **flightId** The unique identifier for each flight -- **flightMetadata** Contains the FlightId and the build being flighted -- **objectId** Unique value for each Update Agent mode -- **relatedCV** Correlation vector value generated from the latest USO scan -- **result** Result of the initialize phase of update. 0 = Succeeded, 1 = Failed, 2 = Cancelled, 3 = Blocked, 4 = BlockCancelled -- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **sessionData** Contains instructions to update agent for processing FODs and DUICs (Null for other scenarios) -- **sessionId** Unique value for each Update Agent mode attempt -- **updateId** Unique ID for each update +- **errorCode** The error code returned for the current session initialization. +- **flightId** The unique identifier for each flight. +- **flightMetadata** Contains the FlightId and the build being flighted. +- **objectId** Unique value for each Update Agent mode. +- **relatedCV** Correlation vector value generated from the latest USO scan. +- **result** Result of the initialize phase of the update. 0 = Succeeded, 1 = Failed, 2 = Cancelled, 3 = Blocked, 4 = BlockCancelled. +- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate. +- **sessionData** Contains instructions to update agent for processing FODs and DUICs (Null for other scenarios). +- **sessionId** Unique value for each Update Agent mode attempt. +- **updateId** Unique ID for each update. ### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentInstall -This event collects information regarding the install phase of the new device manifest UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages +This event collects information regarding the install phase of the new device manifest UUP (Unified Update Platform) update scenario which is used to install a device manifest describing a set of driver packages. The following fields are available: -- **errorCode** The error code returned for the current install phase -- **flightId** The unique identifier for each flight -- **objectId** Unique value for each Update Agent mode -- **relatedCV** Correlation vector value generated from the latest scan -- **result** Result of the install phase of update. 0 = Succeeded 1 = Failed, 2 = Cancelled, 3 = Blocked, 4 = BlockCancelled -- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **sessionId** Unique value for each Update Agent mode attempt -- **updateId** Unique ID for each update +- **errorCode** The error code returned for the current install phase. +- **flightId** Unique ID for each flight. +- **objectId** Unique value for each diagnostics session. +- **relatedCV** Correlation vector value generated from the latest USO scan. +- **result** Outcome of the install phase of the update. +- **scenarioId** Indicates the update scenario. +- **sessionId** Unique value for each update session. +- **updateId** Unique ID for each Update. ### Microsoft.Windows.Update.DeviceUpdateAgent.UpdateAgentModeStart -This event sends data for the start of each mode during the process of updating device manifest assets via the UUP (Unified Update Platform) update scenario, which is used to install a device manifest describing a set of driver packages. +This event sends data for the start of each mode during the process of updating device manifest assets via the UUP (Unified Update Platform) update scenario which is used to install a device manifest describing a set of driver packages. The following fields are available: -- **flightId** The unique identifier for each flight -- **mode** Indicates that the Update Agent mode that has started. 1 = Initialize, 2 = DownloadRequest, 3 = Install, 4 = Commit -- **objectId** Unique value for each Update Agent mode -- **relatedCV** Correlation vector value generated from the latest scan -- **scenarioId** The scenario ID. Example: MobileUpdate, DesktopLanguagePack, DesktopFeatureOnDemand, or DesktopDriverUpdate -- **sessionId** Unique value for each Update Agent mode attempt -- **updateId** Unique ID for each update +- **flightId** Unique ID for each flight. +- **mode** The mode that is starting. +- **objectId** Unique value for each diagnostics session. +- **relatedCV** Correlation vector value generated from the latest USO scan. +- **scenarioId** Indicates the update scenario. +- **sessionId** Unique value for each update session. +- **updateId** Unique ID for each Update. ### Microsoft.Windows.Update.NotificationUx.DialogNotificationToBeDisplayed -Dialog notification about to be displayed to user. +This event indicates that a notification dialog box is about to be displayed to user. The following fields are available: -- **AcceptAutoModeLimit** Maximum number of days for a device to automatically enter Auto Reboot mode -- **AutoToAutoFailedLimit** Maximum number of days for Auto Reboot mode to fail before RebootFailed dialog will be shown -- **DeviceLocalTime** Time of dialog shown on local device -- **EngagedModeLimit** Number of days to switch between DTE dialogs -- **EnterAutoModeLimit** Maximum number of days for a device to enter Auto Reboot mode -- **ETag** OneSettings versioning value -- **IsForcedEnabled** Is Forced Reboot mode enabled for this device? -- **IsUltimateForcedEnabled** Is Ultimate Forced Reboot mode enabled for this device? -- **NotificationUxState** Which dialog is shown (ENUM)? -- **NotificationUxStateString** Which dialog is shown (string mapping)? -- **RebootUxState** Engaged/Auto/Forced/UltimateForced -- **RebootUxStateString** Engaged/Auto/Forced/UltimateForced -- **RebootVersion** Version of DTE -- **SkipToAutoModeLimit** The minimum length of time to pass in reboot pending before a machine can be put into auto mode -- **UpdateId** The ID of the update that is pending reboot to finish installation -- **UpdateRevision** The revision of the update that is pending reboot to finish installation -- **UtcTime** The Coordinated Universal Time when the dialog notification will be displayed. -- **DaysSinceRebootRequired** Number of days since reboot was required. +- **AcceptAutoModeLimit** The maximum number of days for a device to automatically enter Auto Reboot mode. +- **AutoToAutoFailedLimit** The maximum number of days for Auto Reboot mode to fail before the RebootFailed dialog box is shown. +- **DaysSinceRebootRequired** Number of days since restart was required. +- **DeviceLocalTime** The local time on the device sending the event. +- **EngagedModeLimit** The number of days to switch between DTE dialog boxes. +- **EnterAutoModeLimit** The maximum number of days for a device to enter Auto Reboot mode. +- **ETag** OneSettings versioning value. +- **IsForcedEnabled** Indicates whether Forced Reboot mode is enabled for this device. +- **IsUltimateForcedEnabled** Indicates whether Ultimate Forced Reboot mode is enabled for this device. +- **NotificationUxState** Indicates which dialog box is shown. +- **NotificationUxStateString** Indicates which dialog box is shown. +- **RebootUxState** Indicates the state of the restart (Engaged, Auto, Forced, or UltimateForced). +- **RebootUxStateString** Indicates the state of the restart (Engaged, Auto, Forced, or UltimateForced). +- **RebootVersion** Version of DTE. +- **SkipToAutoModeLimit** The minimum length of time to pass in restart pending before a device can be put into auto mode. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UtcTime** The time the dialog box notification will be displayed, in Coordinated Universal Time. ### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootAcceptAutoDialog -Enhanced Engaged reboot accept auto dialog was displayed. +This event indicates that the Enhanced Engaged restart "accept automatically" dialog box was displayed. The following fields are available: -- **DeviceLocalTime** Local time of the device sending the event -- **ETag** OneSettings ETag -- **ExitCode** Dialog exit code - user response -- **RebootVersion** Reboot flow version -- **UpdateId** Id of pending update -- **UpdateRevision** Revision number of the pending update -- **UserResponseString** User response to the reboot dialog -- **UtcTime** The Coordinated Universal Time that dialog was displayed +- **DeviceLocalTime** The local time on the device sending the event. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that user chose on this dialog box. +- **UtcTime** The time that the dialog box was displayed, in Coordinated Universal Time. ### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootFirstReminderDialog -Enhanced Engaged reboot first reminder dialog was displayed. +This event indicates that the Enhanced Engaged restart "first reminder" dialog box was displayed. The following fields are available: -- **DeviceLocalTime** Time of dialog shown on local device -- **ETag** OneSettings versioning value -- **ExitCode** Indicates how users exited the dialog -- **RebootVersion** Version of DTE -- **UpdateId** The id of the update that is pending reboot to finish installation -- **UpdateRevision** The revision of the update that is pending reboot to finish installation -- **UserResponseString** The option that user chose on this dialog -- **UtcTime** The Coordinated Universal Time that dialog was displayed +- **DeviceLocalTime** The local time on the device sending the event. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that user chose in this dialog box. +- **UtcTime** The time that the dialog box was displayed, in Coordinated Universal Time. ### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootForcedPrecursorDialog -Enhanced Engaged reboot forced precursor dialog was displayed. +This event indicates that the Enhanced Engaged restart "forced precursor" dialog box was displayed. The following fields are available: -- **DeviceLocalTime** Time of dialog shown on local device -- **ETag** OneSettings versioning value -- **ExitCode** Indicates how users exited the dialog -- **RebootVersion** Version of DTE -- **UpdateId** The id of the update that is pending reboot to finish installation -- **UpdateRevision** The revision of the update that is pending reboot to finish installation -- **UserResponseString** The option that user chose on this dialog -- **UtcTime** The Coordinated Universal Time that dialog was displayed +- **DeviceLocalTime** The local time on the device sending the event. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that the user chose in this dialog box. +- **UtcTime** The time the dialog box was displayed, in Coordinated Universal Time. ### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootForcedWarningDialog -Enhanced Engaged forced warning dialog was displayed. +This event indicates that the Enhanced Engaged "forced warning" dialog box was displayed. The following fields are available: -- **DeviceLocalTime** Time of dialog shown on local device -- **ETag** OneSettings versioning value -- **ExitCode** Indicates how users exited the dialog -- **RebootVersion** Version of DTE -- **UpdateId** The id of the update that is pending reboot to finish installation -- **UpdateRevision** The revision of the update that is pending reboot to finish installation -- **UserResponseString** The option that user chose on this dialog -- **UtcTime** The Coordinated Universal Time that dialog was displayed +- **DeviceLocalTime** The local time on the device sending the event. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that the user chose in this dialog box. +- **UtcTime** The time that the dialog box was displayed, in Coordinated Universal Time. ### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootRebootFailedDialog -Enhanced Engaged reboot reboot failed dialog was displayed. +This event indicates that the Enhanced Engaged restart "restart failed" dialog box was displayed. The following fields are available: -- **DeviceLocalTime** Dialog exit code - user response -- **ETag** OneSettings versioning value -- **ExitCode** Indicates how users exited the dialog -- **RebootVersion** Version of DTE -- **UpdateId** The ID of the update that is pending reboot to finish installation -- **UpdateRevision** The revision of the update that is pending reboot to finish installation -- **UserResponseString** The option that user chose on this dialog -- **UtcTime** The Coordinated Universal Time that dialog was displayed +- **DeviceLocalTime** The local time of the device sending the event. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that the user chose in this dialog box. +- **UtcTime** The time that the dialog box was displayed, in Coordinated Universal Time. ### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootRebootImminentDialog -Enhanced Engaged reboot reboot imminent dialog was displayed. +This event indicates that the Enhanced Engaged restart "restart imminent" dialog box was displayed.. The following fields are available: -- **DeviceLocalTime** Time of dialog shown on local device -- **ETag** OneSettings versioning value -- **ExitCode** Indicates how users exited the dialog -- **RebootVersion** Version of DTE -- **UpdateId** The ID of the update that is pending reboot to finish installation -- **UpdateRevision** The revision of the update that is pending reboot to finish installation -- **UserResponseString** The option that user chose on this dialog -- **UtcTime** The Coordinated Universal Time that dialog was displayed +- **DeviceLocalTime** Time the dialog box was shown on the local device. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that user chose in this dialog box. +- **UtcTime** The time that dialog box was displayed, in Coordinated Universal Time. ### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootSecondReminderDialog -Enhanced Engaged reboot second reminder dialog was displayed. +This event indicates that the second reminder dialog box was displayed for Enhanced Engaged restart. The following fields are available: -- **DeviceLocalTime** Time of dialog shown on local device -- **ETag** OneSettings versioning value -- **ExitCode** Indicates how users exited the dialog -- **RebootVersion** Version of DTE -- **UpdateId** The ID of the update that is pending reboot to finish installation -- **UpdateRevision** The revision of the update that is pending reboot to finish installation -- **UserResponseString** The option that user chose on this dialog -- **UtcTime** The Coordinated Universal Time that dialog was displayed +- **DeviceLocalTime** The time the dialog box was shown on the local device. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that the user chose in this dialog box. +- **UtcTime** The time that the dialog box was displayed, in Coordinated Universal Time. ### Microsoft.Windows.Update.NotificationUx.EnhancedEngagedRebootThirdReminderDialog -Enhanced Engaged reboot third reminder dialog was displayed. +This event indicates that the third reminder dialog box for Enhanced Engaged restart was displayed. The following fields are available: -- **DeviceLocalTime** Time of dialog shown on local device -- **ETag** OneSettings versioning value -- **ExitCode** Indicates how users exited the dialog -- **RebootVersion** Version of DTE -- **UpdateId** The ID of the update that is pending reboot to finish installation -- **UpdateRevision** The revision of the update that is pending reboot to finish installation -- **UserResponseString** The option that user chose on this dialog -- **UtcTime** The Coordinated Universal Time that dialog was displayed +- **DeviceLocalTime** The time the dialog box was shown on the local device. +- **ETag** OneSettings versioning value. +- **ExitCode** Indicates how users exited the dialog box. +- **RebootVersion** Version of DTE. +- **UpdateId** The ID of the update that is pending restart to finish installation. +- **UpdateRevision** The revision of the update that is pending restart to finish installation. +- **UserResponseString** The option that the user chose in this dialog box. +- **UtcTime** The time that the dialog box was displayed, in Coordinated Universal Time. ### Microsoft.Windows.Update.NotificationUx.RebootScheduled -Indicates when a reboot is scheduled by the system or a user for a security, quality, or feature update +Indicates when a reboot is scheduled by the system or a user for a security, quality, or feature update. The following fields are available: -- **activeHoursApplicable** True, If Active Hours applicable on this device. False, otherwise -- **rebootArgument** Argument for the reboot task. It also represents specific reboot related action -- **rebootOutsideOfActiveHours** True, if a reboot is scheduled outside of active hours. False, otherwise -- **rebootScheduledByUser** True, if a reboot is scheduled by user. False, if a reboot is scheduled automatically -- **rebootState** The state of the reboot -- **revisionNumber** Revision number of the update that is getting installed with this reboot -- **scheduledRebootTime** Time of the scheduled reboot -- **scheduledRebootTimeInUTC** Time of the scheduled reboot in Coordinated Universal Time -- **updateId** ID of the update that is getting installed with this reboot -- **wuDeviceid** Unique device ID used by Windows Update -- **IsEnhancedEngagedReboot** Whether this is an Enhanced Engaged reboot +- **activeHoursApplicable** Indicates whether an Active Hours policy is present on the device. +- **IsEnhancedEngagedReboot** Indicates whether this is an Enhanced Engaged reboot. +- **rebootArgument** Argument for the reboot task. It also represents specific reboot related action. +- **rebootOutsideOfActiveHours** Indicates whether a restart is scheduled outside of active hours. +- **rebootScheduledByUser** Indicates whether the restart was scheduled by user (if not, it was scheduled automatically). +- **rebootState** The current state of the restart. +- **revisionNumber** Revision number of the update that is getting installed with this restart. +- **scheduledRebootTime** Time of the scheduled restart. +- **scheduledRebootTimeInUTC** Time of the scheduled restart in Coordinated Universal Time. +- **updateId** ID of the update that is getting installed with this restart. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.ActivityRestrictedByActiveHoursPolicy -A policy is present that may restrict update activity to outside of active hours. +This event indicates a policy is present that may restrict update activity to outside of active hours. The following fields are available: -- **activeHoursEnd** The end of the active hours window -- **activeHoursStart** The start of the active hours window -- **wuDeviceid** Device ID +- **activeHoursEnd** The end of the active hours window. +- **activeHoursStart** The start of the active hours window. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.BlockedByActiveHours -Update activity blocked due to active hours being currently active. +This event indicates that update activity was blocked because it is within the active hours window. The following fields are available: -- **blockReason** The current state of the update process -- **updatePhase** The current state of the update process -- **wuDeviceid** Device ID -- **activeHoursEnd** The end of the active hours window -- **activeHoursStart** The start of the active hours window +- **activeHoursEnd** The end of the active hours window. +- **activeHoursStart** The start of the active hours window. +- **blockReason** Reason for stopping the update activity. +- **updatePhase** The current state of the update process. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.BlockedByBatteryLevel -Update activity blocked due to low battery level. +This event indicates that Windows Update activity was blocked due to low battery level. The following fields are available: -- **batteryLevel** The current battery charge capacitity -- **batteryLevelThreshold** The battery capacity threshold to stop update activity -- **blockReason** The current state of the update process -- **updatePhase** The current state of the update process -- **wuDeviceid** Device ID +- **batteryLevel** The current battery charge capacity. +- **batteryLevelThreshold** The battery capacity threshold to stop update activity. +- **blockReason** Reason for stopping Windows Update activity. +- **updatePhase** The current state of the update process. +- **wuDeviceid** Device ID. ### Microsoft.Windows.Update.Orchestrator.CommitFailed -This events tracks when a device needs to restart after an update but did not. +This event indicates that a device was unable to restart after an update. The following fields are available: @@ -4920,89 +5437,60 @@ The following fields are available: - **wuDeviceid** The Windows Update device GUID. -### Microsoft.Windows.Update.Orchestrator.DTUCompletedWhenWuFlightPendingCommit - -Event to indicate that DTU completed installation of the ESD, when WU was already Pending Commit of the feature update. - -The following fields are available: - -- **wuDeviceid** Device ID used by WU - - -### Microsoft.Windows.Update.Orchestrator.DTUEnabled - -Inbox DTU functionality enabled. - -The following fields are available: - -- **wuDeviceid** Device ID. - - -### Microsoft.Windows.Update.Orchestrator.DTUInitiated - -Inbox DTU functionality intiated. - -The following fields are available: - -- **dtuErrorCode** Return code from creating the DTU Com Server. -- **isDtuApplicable** Determination of whether DTU is applicable to the machine it is running on. -- **wuDeviceid** Return code from creating the DTU Com Server. - - ### Microsoft.Windows.Update.Orchestrator.DeferRestart -Indicates that a restart required for installing updates was postponed. +This event indicates that a restart required for installing updates was postponed. The following fields are available: -- **displayNeededReason** Semicolon-separated list of reasons reported for display needed -- **eventScenario** Indicates the purpose of the event - whether because scan started, succeded, failed, etc -- **filteredDeferReason** The raised reason that the USO did not restart (e.g. user active, low battery) that were ignorable -- **gameModeReason** Name of the executable that caused the game mode state check to trigger. -- **ignoredReason** Semicolon-separated list of reasons that were intentionally ignored. -- **revisionNumber** Update ID revision number -- **systemNeededReason** Semicolon-separated list of reasons reported for system needed. -- **updateId** Update ID -- **updateScenarioType** Update session type -- **wuDeviceid** Windows Update Device GUID -- **raisedDeferReason** The reason that the USO did not restart (e.g. user active, low battery) +- **displayNeededReason** List of reasons for needing display. +- **eventScenario** Indicates the purpose of the event (scan started, succeeded, failed, etc.). +- **filteredDeferReason** Applicable filtered reasons why reboot was postponed (such as user active, or low battery). +- **gameModeReason** Name of the executable that caused the game mode state check to start. +- **ignoredReason** List of reasons that were intentionally ignored. +- **raisedDeferReason** Indicates all potential reasons for postponing restart (such as user active, or low battery). +- **revisionNumber** Update ID revision number. +- **systemNeededReason** List of reasons why system is needed. +- **updateId** Update ID. +- **updateScenarioType** Update session type. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.Detection -A scan for an update occurred. +This event indicates that a scan for a Windows Update occurred. The following fields are available: -- **detectionBlockingPolicy** State of update action -- **detectionBlockreason** Reason for detection not completing. -- **eventScenario** End to end update session ID, or indicates the purpose of sending this event - whether because the software distribution just started installing content, or whether it was cancelled, succeeded, or failed. -- **interactive** Identifies if session is User Initiated. -- **scanTriggerSource** Source of the triggered scan. -- **updateScenarioType** The update session type. -- **wuDeviceid** Unique device ID used by Windows Update. -- **detectionRetryMode** If we retry to scan -- **errorCode** The returned error code. -- **deferReason** Reason for postponing detection -- **flightID** Flight info -- **revisionNumber** Update version -- **updateId** Update ID - GUID +- **deferReason** Reason why the device could not check for updates. +- **detectionBlockingPolicy** State of update action. +- **detectionBlockreason** Reason for blocking detection +- **detectionRetryMode** Indicates whether we will try to scan again. +- **errorCode** Error info +- **eventScenario** End-to-end update session ID, or indicates the purpose of sending this event - whether because the software distribution just started installing content, or whether it was cancelled, succeeded, or failed. +- **flightID** The specific ID of the Windows Insider build the device is getting. +- **interactive** Indicates whether the session was user initiated. - **networkStatus** Error info +- **revisionNumber** Update revision number. +- **scanTriggerSource** Source of the triggered scan. +- **updateId** Update ID. +- **updateScenarioType** Source of the triggered scan +- **wuDeviceid** Device ID ### Microsoft.Windows.Update.Orchestrator.DisplayNeeded -Reboot postponed due to needing a display +This event indicates the reboot was postponed due to needing a display. The following fields are available: -- **displayNeededReason** Reason the display is needed -- **eventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date -- **revisionNumber** Revision number of the update -- **updateId** Update ID -- **updateScenarioType** The update session type -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date +- **displayNeededReason** Reason the display is needed. +- **eventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **rebootOutsideOfActiveHours** Indicates whether the reboot was to occur outside of active hours. +- **revisionNumber** Revision number of the update. +- **updateId** Update ID. +- **updateScenarioType** The update session type. +- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated. - **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue @@ -5012,83 +5500,112 @@ This event sends launch data for a Windows Update download to help keep Windows The following fields are available: -- **deferReason** Reason for download not completing -- **errorCode** An error code represented as a hexadecimal value -- **eventScenario** End to end update session ID. -- **flightID** Unique update ID. -- **interactive** Identifies if session is user initiated. +- **deferReason** Reason for download not completing. +- **errorCode** An error code represented as a hexadecimal value. +- **eventScenario** End-to-end update session ID. +- **flightID** The specific ID of the Windows Insider build the device is getting. +- **interactive** Indicates whether the session is user initiated. - **revisionNumber** Update revision number. - **updateId** Update ID. - **updateScenarioType** The update session type. - **wuDeviceid** Unique device ID used by Windows Update. -### Microsoft.Windows.Update.Orchestrator.Escalation +### Microsoft.Windows.Update.Orchestrator.DTUCompletedWhenWuFlightPendingCommit -Event sent when USO takes an Escalation action on device. +This event indicates that DTU completed installation of the electronic software delivery (ESD), when Windows Update was already in Pending Commit phase of the feature update. The following fields are available: -- **configVersion** Escalation config version on device -- **escalationAction** Indicate the specific escalation action that took place on device -- **updateClassificationGUID** GUID of the update the device is offered -- **updateId** ID of the update the device is offered -- **wuDeviceid** Device ID used by WU +- **wuDeviceid** Device ID used by Windows Update. + + +### Microsoft.Windows.Update.Orchestrator.DTUEnabled + +This event indicates that Inbox DTU functionality was enabled. + +The following fields are available: + +- **wuDeviceid** Device ID used by Windows Update. + + +### Microsoft.Windows.Update.Orchestrator.DTUInitiated + +This event indicates that Inbox DTU functionality was intiated. + +The following fields are available: + +- **dtuErrorCode** Return code from creating the DTU Com Server. +- **isDtuApplicable** Determination of whether DTU is applicable to the machine it is running on. +- **wuDeviceid** Device ID used by Windows Update. + + +### Microsoft.Windows.Update.Orchestrator.Escalation + +This event is sent when USO takes an Escalation action on a device. + +The following fields are available: + +- **configVersion** Escalation config version on device. +- **escalationAction** Indicate the specific escalation action that took place on device. +- **updateClassificationGUID** GUID of the update the device is offered. +- **updateId** ID of the update the device is offered. +- **wuDeviceid** Device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.EscalationRiskLevels -Event sent during update scan, download, install. Indicates that the device is at risk of being out-of-date. +This event is sent during update scan, download, or install, and indicates that the device is at risk of being out-of-date. The following fields are available: -- **configVersion** Escalation config version on device -- **downloadElapsedTime** How long since the download is required on device -- **downloadRiskLevel** At-risk level of download phase -- **installElapsedTime** How long since the install is required on device -- **installRiskLevel** At-risk level of install phase -- **isSediment** WaaSmedic's assessment of whether is device is at risk or not -- **scanElapsedTime** How long since the scan is required on device -- **scanRiskLevel** At-risk level of scan phase -- **wuDeviceid** Device id used by WU +- **configVersion** Escalation config version on device . +- **downloadElapsedTime** Indicates how long since the download is required on device. +- **downloadRiskLevel** At-risk level of download phase. +- **installElapsedTime** Indicates how long since the install is required on device. +- **installRiskLevel** The at-risk level of install phase. +- **isSediment** Assessment of whether is device is at risk. +- **scanElapsedTime** Indicates how long since the scan is required on device. +- **scanRiskLevel** At-risk level of the scan phase. +- **wuDeviceid** Device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.EscalationsRefreshFailed -USO has a set of escalation actions to prevent a device from becoming out-of-date, and the actions are triggered based on the Escalation config that USO obtains from OneSettings. This event is sent when USO fails to refresh the escalation config from OneSettings. +USO has a set of escalation actions to prevent a device from becoming out-of-date, and the actions are triggered based on the Escalation configuration that USO obtains from OneSettings. This event is sent when USO fails to refresh the escalation configuration from OneSettings. The following fields are available: -- **configVersion** Current escalation config version on device -- **errorCode** Error code for the refresh failure -- **wuDeviceid** Device ID used by WU +- **configVersion** Current escalation config version on device. +- **errorCode** Error code for the refresh failure. +- **wuDeviceid** Device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.FlightInapplicable -The Update is no longer Applicable to this device +This event indicates that the update is no longer applicable to this device. The following fields are available: -- **EventPublishedTime** Flight specific info -- **flightID** Update ID revision number -- **revisionNumber** Update ID - GUID -- **updateId** Update session type -- **updateScenarioType** Last status of update -- **UpdateStatus** Is UUP fallback configured? -- **UUPFallBackConfigured** Windows Update Device GUID -- **wuDeviceid** Windows Update Device GUID +- **EventPublishedTime** Time when this event was generated +- **flightID** The specific ID of the Windows Insider build. +- **revisionNumber** Update revision number. +- **updateId** Unique Windows Update ID. +- **updateScenarioType** Update session type. +- **UpdateStatus** Last status of update. +- **UUPFallBackConfigured** Indicates whether UUP fallback is configured. +- **wuDeviceid** Unique Device ID. ### Microsoft.Windows.Update.Orchestrator.GameActive -This event indicates that an enabled GameMode process prevented the device from restarting to complete an update +This event indicates that an enabled GameMode process prevented the device from restarting to complete an update. The following fields are available: -- **eventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed -- **gameModeReason** Name of the enabled GameMode process that prevented the device from restarting to complete an update -- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue +- **eventScenario** Indicates the purpose of sending this event - whether because the software distribution just started checking for content, or whether it was cancelled, succeeded, or failed. +- **gameModeReason** Name of the enabled GameMode process that prevented the device from restarting to complete an update. +- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. ### Microsoft.Windows.Update.Orchestrator.InitiatingReboot @@ -5099,12 +5616,12 @@ The following fields are available: - **EventPublishedTime** Time of the event. - **flightID** Unique update ID -- **interactive** Indicates the reboot initiation stage of the update process was entered as a result of user action or not. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. +- **interactive** Indicates whether the reboot initiation stage of the update process was entered as a result of user action. +- **rebootOutsideOfActiveHours** Indicates whether the reboot was to occur outside of active hours. - **revisionNumber** Revision number of the update. - **updateId** Update ID. - **updateScenarioType** The update session type. -- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. +- **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated. - **wuDeviceid** Unique device ID used by Windows Update. @@ -5116,82 +5633,82 @@ The following fields are available: - **batteryLevel** Current battery capacity in mWh or percentage left. - **deferReason** Reason for install not completing. -- **eventScenario** End to end update session ID. +- **errorCode** The error code reppresented by a hexadecimal value. +- **eventScenario** End-to-end update session ID. +- **flightID** The specific ID of the Windows Insider build the device is getting. +- **flightUpdate** Indicates whether the update is a Windows Insider build. +- **ForcedRebootReminderSet** A boolean value that indicates if a forced reboot will happen for updates. +- **installCommitfailedtime** The time it took for a reboot to happen but the upgrade failed to progress. +- **installRebootinitiatetime** The time it took for a reboot to be attempted. - **interactive** Identifies if session is user initiated. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. +- **minutesToCommit** The time it took to install updates. +- **rebootOutsideOfActiveHours** Indicates whether a reboot is scheduled outside of active hours. +- **revisionNumber** Update revision number. +- **updateId** Update ID. - **updateScenarioType** The update session type. - **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. - **wuDeviceid** Unique device ID used by Windows Update. -- **flightID** Unique update ID -- **flightUpdate** Flight update -- **ForcedRebootReminderSet** A boolean value that indicates if a forced reboot will happen for updates. -- **installRebootinitiatetime** The time it took for a reboot to be attempted. -- **minutesToCommit** The time it took to install updates. -- **revisionNumber** Update revision number. -- **updateId** Update ID. -- **errorCode** The error code reppresented by a hexadecimal value. -- **installCommitfailedtime** The time it took for a reboot to happen but the upgrade failed to progress. ### Microsoft.Windows.Update.Orchestrator.PostInstall -Event sent after Update install completes. +This event is sent after a Windows update install completes. The following fields are available: -- **batteryLevel** Battery level percentage -- **bundleId** Update ID - GUID -- **bundleRevisionnumber** Update ID revision number -- **errorCode** Error value -- **eventScenario** State of update action -- **sessionType** Update session type -- **wuDeviceid** Windows Update device GUID +- **batteryLevel** Current battery capacity in mWh or percentage left. +- **bundleId** Identifier associated with the specific content bundle. +- **bundleRevisionnumber** Identifies the revision number of the content bundle. +- **errorCode** The error code returned for the current phase. +- **eventScenario** State of update action. - **flightID** The flight ID of the device -- **updateScenarioType** The scenario type of this update +- **sessionType** The Windows Update session type (Interactive or Background). +- **updateScenarioType** The update session type. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.PowerMenuOptionsChanged -This event is sent when the options in power menu changed, usually due to an update pending reboot, or after a update is installed. +This event is sent when the options in power menu changed, usually due to an update pending reboot, or after a update is installed. The following fields are available: -- **powermenuNewOptions** The new options after the power menu changed -- **powermenuOldOptions** The old options before the power menu changed -- **rebootPendingMinutes** If the power menu changed because a reboot is pending due to a update, how long that reboot has been pending -- **wuDeviceid** If the power menu changed because a reboot is pending due to a update, the device ID recorded by WU +- **powermenuNewOptions** The new options after the power menu changed. +- **powermenuOldOptions** The old options before the power menu changed. +- **rebootPendingMinutes** If the power menu changed because a reboot is pending due to a update, this indicates how long that reboot has been pending. +- **wuDeviceid** The device ID recorded by Windows Update if the power menu changed because a reboot is pending due to an update. ### Microsoft.Windows.Update.Orchestrator.PreShutdownStart -This event is generated right before the shutdown and commit operations +This event is generated before the shutdown and commit operations. The following fields are available: -- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue +- **wuDeviceid** The unique identifier of a specific device, used to identify how many devices are encountering success or a particular issue. ### Microsoft.Windows.Update.Orchestrator.Progress -Event sent when the download of a update reaches a milestone change, such as network cost policy changed, a internal phase has completed, or a transient state has changed. +This event is sent when the download of a update reaches a milestone change, such as a change in network cost policy, completion of an internal phase, or change in a transient state. The following fields are available: -- **errorCode** Error info -- **flightID** Flight info -- **interactive** Is USO session interactive or non-interactive? -- **networkCostPolicy** The current network cost policy on device -- **revisionNumber** Update ID revision number -- **updateId** Update ID - GUID -- **updateScenarioType** Update Session type -- **updateState** Subphase of the download -- **UpdateStatus** Subphase of the update -- **wuDeviceid** Device ID +- **errorCode** Error code returned. +- **flightID** The specific ID of the Windows Insider build the device is getting. +- **interactive** Identifies whether the session is user initiated. +- **networkCostPolicy** The current network cost policy on device. +- **revisionNumber** Update ID revision number. +- **updateId** Unique ID for each update. +- **updateScenarioType** Update Session type. +- **updateState** Subphase of the download. +- **UpdateStatus** Subphase of the update. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.RebootFailed -This event sends information about whether an update required a reboot and reasons for failure to help keep Windows up to date. +This event sends information about whether an update required a reboot and reasons for failure, to help keep Windows up to date. The following fields are available: @@ -5199,7 +5716,7 @@ The following fields are available: - **deferReason** Reason for install not completing. - **EventPublishedTime** The time that the reboot failure occurred. - **flightID** Unique update ID. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. +- **rebootOutsideOfActiveHours** Indicates whether a reboot was scheduled outside of active hours. - **RebootResults** Hex code indicating failure reason. Typically, we expect this to be a specific USO generated hex code. - **revisionNumber** Update revision number. - **updateId** Update ID. @@ -5215,25 +5732,25 @@ This event sends data indicating that a reboot task is missing unexpectedly on a The following fields are available: - **RebootTaskRestoredTime** Time at which this reboot task was restored. -- **wuDeviceid** Device id on which the reboot is restored +- **wuDeviceid** Device ID for the device on which the reboot is restored. ### Microsoft.Windows.Update.Orchestrator.ScanTriggered -Indicates that Update Orchestrator has started a scan operation. +This event indicates that Update Orchestrator has started a scan operation. The following fields are available: -- **errorCode** Error info -- **eventScenario** Indicates the purpose of sending this event -- **interactive** Whether or not the scan is interactive. -- **isScanPastSla** Has the SLA elapsed for scanning? -- **isScanPastTriggerSla** Has the SLA elapsed for triggering a scan? -- **minutesOverScanSla** How many minutes over the scan SLA is the scan? -- **minutesOverScanTriggerSla** How many minutes over the scan trigger SLA is the scan? -- **scanTriggerSource** What caused the scan? -- **updateScenarioType** The type of scenario we are in. -- **wuDeviceid** WU Device ID of the machine. +- **errorCode** The error code returned for the current scan operation. +- **eventScenario** Indicates the purpose of sending this event. +- **interactive** Indicates whether the scan is interactive. +- **isScanPastSla** Indicates whether the SLA has elapsed for scanning. +- **isScanPastTriggerSla** Indicates whether the SLA has elapsed for triggering a scan. +- **minutesOverScanSla** Indicates how many minutes the scan exceeded the scan SLA. +- **minutesOverScanTriggerSla** Indicates how many minutes the scan exceeded the scan trigger SLA. +- **scanTriggerSource** Indicates what caused the scan. +- **updateScenarioType** The update session type. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Orchestrator.SystemNeeded @@ -5242,10 +5759,10 @@ This event sends data about why a device is unable to reboot, to help keep Windo The following fields are available: -- **eventScenario** End to end update session ID. -- **rebootOutsideOfActiveHours** Indicates the timing that the reboot was to occur to ensure the correct update process and experience is provided to keep Windows up to date. +- **eventScenario** End-to-end update session ID. +- **rebootOutsideOfActiveHours** Indicates whether a reboot is scheduled outside of active hours. - **revisionNumber** Update revision number. -- **systemNeededReason** Reason ID +- **systemNeededReason** List of apps or tasks that are preventing the system from restarting. - **updateId** Update ID. - **updateScenarioType** The update session type. - **uxRebootstate** Indicates the exact state of the user experience at the time the required reboot was initiated to ensure the correct update process and experience is provided to keep Windows up to date. @@ -5254,26 +5771,26 @@ The following fields are available: ### Microsoft.Windows.Update.Orchestrator.TerminatedByActiveHours -Update activity was stopped due to active hours starting. +This event indicates that update activity was stopped due to active hours starting. The following fields are available: -- **activeHoursEnd** The end of the active hours window -- **activeHoursStart** The start of the active hours window -- **updatePhase** The current state of the update process -- **wuDeviceid** Device ID +- **activeHoursEnd** The end of the active hours window. +- **activeHoursStart** The start of the active hours window. +- **updatePhase** The current state of the update process. +- **wuDeviceid** The device identifier. ### Microsoft.Windows.Update.Orchestrator.TerminatedByBatteryLevel -Update activity was stopped due to a low battery level. +This event is sent when update activity was stopped due to a low battery level. The following fields are available: -- **batteryLevel** The current battery charge capacity -- **batteryLevelThreshold** The battery capacity threshold to stop update activity -- **updatePhase** The current state of the update process -- **wuDeviceid** Device ID +- **batteryLevel** The current battery charge capacity. +- **batteryLevelThreshold** The battery capacity threshold to stop update activity. +- **updatePhase** The current state of the update process. +- **wuDeviceid** The device identifier. ### Microsoft.Windows.Update.Orchestrator.UpdatePolicyCacheRefresh @@ -5282,10 +5799,10 @@ This event sends data on whether Update Management Policies were enabled on a de The following fields are available: -- **configuredPoliciescount** Policy Count -- **policiesNamevaluesource** Policy Name -- **policyCacherefreshtime** Refresh time -- **updateInstalluxsetting** This shows whether a user has set policies via UX option +- **configuredPoliciescount** Number of policies on the device. +- **policiesNamevaluesource** Policy name and source of policy (group policy, MDM or flight). +- **policyCacherefreshtime** Time when policy cache was refreshed. +- **updateInstalluxsetting** Indicates whether a user has set policies via a user experience option. - **wuDeviceid** Unique device ID used by Windows Update. @@ -5295,8 +5812,8 @@ This event sends data about whether an update required a reboot to help keep Win The following fields are available: -- **flightID** Unique update ID. -- **interactive** Indicates the reboot initiation stage of the update process was entered as a result of user action or not. +- **flightID** The specific ID of the Windows Insider build the device is getting. +- **interactive** Indicates whether the reboot initiation stage of the update process was entered as a result of user action. - **revisionNumber** Update revision number. - **updateId** Update ID. - **updateScenarioType** The update session type. @@ -5324,21 +5841,21 @@ The following fields are available: ### Microsoft.Windows.Update.Ux.MusNotification.RebootScheduled -The RebootScheduled event sends basic information for scheduling a update related reboot to facilitate the flow of getting security updates and keeping Windows up to date. +This event sends basic information about scheduling an update-related reboot, to get security updates and to help keep Windows up-to-date. The following fields are available: -- **activeHoursApplicable** Whether Active Hours applies. -- **rebootArgument** The reboot arguments -- **rebootOutsideOfActiveHours** If reboot was outside of Active Hours -- **rebootScheduledByUser** If the reboot was scheduled by the user, or the system. -- **rebootState** Which state the reboot is in -- **revisionNumber** Revision number of the OS -- **scheduledRebootTime** Time the reboot was scheduled for. -- **scheduledRebootTimeInUTC** Time the reboot was scheduled for in UTC -- **updateId** UpdateId to identify which update is being scheduled. -- **wuDeviceid** Unique DeviceID -- **IsEnhancedEngagedReboot** If Enhanced reboot was enabled. +- **activeHoursApplicable** Indicates whether Active Hours applies on this device. +- **IsEnhancedEngagedReboot** Indicates whether Enhanced reboot was enabled. +- **rebootArgument** Argument for the reboot task. It also represents specific reboot related action. +- **rebootOutsideOfActiveHours** True, if a reboot is scheduled outside of active hours. False, otherwise. +- **rebootScheduledByUser** True, if a reboot is scheduled by user. False, if a reboot is scheduled automatically. +- **rebootState** Current state of the reboot. +- **revisionNumber** Revision number of the OS. +- **scheduledRebootTime** Time scheduled for the reboot. +- **scheduledRebootTimeInUTC** Time scheduled for the reboot, in UTC. +- **updateId** Identifies which update is being scheduled. +- **wuDeviceid** Unique device ID used by Windows Update. ### Microsoft.Windows.Update.Ux.MusNotification.UxBrokerFirstReadyToReboot @@ -5353,34 +5870,34 @@ This event is sent when MUSE broker schedules a task. The following fields are available: -- **TaskArgument** The arguments with which the task is scheduled. -- **TaskName** Name of the task. +- **TaskArgument** The arguments which the task is scheduled with +- **TaskName** Name of the task ## Windows Update mitigation events ### Mitigation360Telemetry.MitigationCustom.CleanupSafeOsImages -This event sends data specific to the CleanupSafeOsImages mitigation used for OS Updates. +This event sends data specific to the CleanupSafeOsImages mitigation used for OS Updates. The following fields are available: -- **ClientId** In the WU scenario, this will be the WU client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. -- **FlightId** Unique identifier for each flight. -- **InstanceId** Unique GUID that identifies each instances of setuphost.exe. -- **MitigationScenario** The update scenario in which the mitigation was executed. -- **MountedImageCount** Number of mounted images. -- **MountedImageMatches** Number of mounted images that were under %systemdrive%\$Windows.~BT. -- **MountedImagesFailed** Number of mounted images under %systemdrive%\$Windows.~BT that could not be removed. -- **MountedImagesRemoved** Number of mounted images under %systemdrive%\$Windows.~BT that were successfully removed. -- **MountedImagesSkipped** Number of mounted images that were not under %systemdrive%\$Windows.~BT. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **Result** HResult of this operation. -- **ScenarioId** ID indicating the mitigation scenario. -- **ScenarioSupported** Indicates whether the scenario was supported. -- **SessionId** Unique value for each update attempt. -- **UpdateId** Unique ID for each Update. -- **WuId** Unique ID for the Windows Update client. +- **ClientId** Unique identifier for each flight. +- **FlightId** Unique GUID that identifies each instances of setuphost.exe. +- **InstanceId** The update scenario in which the mitigation was executed. +- **MitigationScenario** Number of mounted images. +- **MountedImageCount** Number of mounted images that were under %systemdrive%\$Windows.~BT. +- **MountedImageMatches** Number of mounted images under %systemdrive%\$Windows.~BT that could not be removed. +- **MountedImagesFailed** Number of mounted images under %systemdrive%\$Windows.~BT that were successfully removed. +- **MountedImagesRemoved** Number of mounted images that were not under %systemdrive%\$Windows.~BT. +- **MountedImagesSkipped** Correlation vector value generated from the latest USO scan. +- **RelatedCV** HResult of this operation. +- **Result** ID indicating the mitigation scenario. +- **ScenarioId** Indicates whether the scenario was supported. +- **ScenarioSupported** Unique value for each update attempt. +- **SessionId** Unique ID for each Update. +- **UpdateId** Unique ID for the Windows Update client. +- **WuId** Unique ID for the Windows Update client. ### Mitigation360Telemetry.MitigationCustom.FixAppXReparsePoints @@ -5389,19 +5906,19 @@ This event sends data specific to the FixAppXReparsePoints mitigation used for O The following fields are available: -- **ClientId** Unique identifier for each flight. -- **FlightId** Unique GUID that identifies each instances of setuphost.exe. -- **InstanceId** The update scenario in which the mitigation was executed. -- **MitigationScenario** Correlation vector value generated from the latest USO scan. -- **RelatedCV** Number of reparse points that are corrupted but we failed to fix them. -- **ReparsePointsFailed** Number of reparse points that were corrupted and were fixed by this mitigation. -- **ReparsePointsFixed** Number of reparse points that are not corrupted and no action is required. -- **ReparsePointsSkipped** HResult of this operation. -- **Result** ID indicating the mitigation scenario. -- **ScenarioId** Indicates whether the scenario was supported. -- **ScenarioSupported** Unique value for each update attempt. -- **SessionId** Unique ID for each Update. -- **UpdateId** Unique ID for the Windows Update client. +- **ClientId** In the WU scenario, this will be the WU client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **FlightId** Unique identifier for each flight. +- **InstanceId** Unique GUID that identifies each instances of setuphost.exe. +- **MitigationScenario** The update scenario in which the mitigation was executed. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **ReparsePointsFailed** Number of reparse points that are corrupted but we failed to fix them. +- **ReparsePointsFixed** Number of reparse points that were corrupted and were fixed by this mitigation. +- **ReparsePointsSkipped** Number of reparse points that are not corrupted and no action is required. +- **Result** HResult of this operation. +- **ScenarioId** ID indicating the mitigation scenario. +- **ScenarioSupported** Indicates whether the scenario was supported. +- **SessionId** Unique value for each update attempt. +- **UpdateId** Unique ID for each Update. - **WuId** Unique ID for the Windows Update client. @@ -5411,20 +5928,29 @@ This event sends data specific to the FixupEditionId mitigation used for OS upda The following fields are available: -- **ClientId** In the WU scenario, this will be the WU client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. +- **ClientId** In the WU scenario, this will be the WU client ID that is passed to Setup. In Media setup, default value is Media360, but can be overwritten by the caller to a unique value. - **EditionIdUpdated** Determine whether EditionId was changed. -- **FlightId** Unique identifier for each flight. -- **InstanceId** Unique GUID that identifies each instances of setuphost.exe. -- **MitigationScenario** The update scenario in which the mitigation was executed. +- **FlightId** Unique identifier for each flight. +- **InstanceId** Unique GUID that identifies each instances of setuphost.exe. +- **MitigationScenario** The update scenario in which the mitigation was executed. - **ProductEditionId** Expected EditionId value based on GetProductInfo. - **ProductType** Value returned by GetProductInfo. - **RegistryEditionId** EditionId value in the registry. -- **RelatedCV** Correlation vector value generated from the latest USO scan. -- **Result** HResult of this operation. -- **ScenarioId** ID indicating the mitigation scenario. -- **ScenarioSupported** Indicates whether the scenario was supported. +- **RelatedCV** Correlation vector value generated from the latest USO scan. +- **Result** HResult of this operation. +- **ScenarioId** ID indicating the mitigation scenario. +- **ScenarioSupported** Indicates whether the scenario was supported. - **SessionId** Unique value for each update attempt. -- **UpdateId** Unique ID for each update. -- **WuId** Unique ID for the Windows Update client. +- **UpdateId** Unique ID for each update. +- **WuId** Unique ID for the Windows Update client. + + +## Winlogon events + +### Microsoft.Windows.Security.Winlogon.SetupCompleteLogon + +This event signals the completion of the setup process. It happens only once during the first logon. + +