DDVCmdlets.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>DDVCmdlets</name> </assembly> <members> <member name="T:DDVCmdlets.DisableDiagnosticDataViewing"> <example> <code>Disable-DiagnosticDataViewing</code> <para>Disable Diagnostic Data Viewing.</para> </example> <summary> <para type="synopsis">Disables diagnostic data viewing.</para> <para type="description">This cmdlet disables diagnostic data viewing. Once diagnostic data viewing is disabled, this tool will throw an error. Note that disabling diagnostic data viewing will also delete the available history of diagnostic data on the device.</para> </summary> </member> <member name="M:DDVCmdlets.DisableDiagnosticDataViewing.ProcessRecord"> <summary> <para type="description">Writes query results to the output.</para> </summary> </member> <member name="T:DDVCmdlets.EnableDiagnosticDataViewing"> <example> <code>Enable-DiagnosticDataViewing</code> <para>Enable Diagnostic Data Viewing.</para> </example> <summary> <para type="synopsis">Enables diagnostic data viewing.</para> <para type="description">This cmdlet enables diagnostic data viewing. Once enabled, the device henceforth will start recording each diagnostic data event uploaded to Microsoft, where the total history is limited by the diagnostic store capacity. It may take some time for events to be shown. </para> </summary> </member> <member name="M:DDVCmdlets.EnableDiagnosticDataViewing.ProcessRecord"> <summary> <para type="description">Writes query results to the output.</para> </summary> </member> <member name="T:DDVCmdlets.Helpers.EventTranscriptManager"> <summary> This class is responsible for managing connection and other resources of UTC EventTranscript SQLite database, and fetching results requested by the callers. </summary> </member> <member name="T:DDVCmdlets.Containers.EventRecord"> <summary> <para type="description">Persisted event record.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.EventRecord.Name"> <summary> <para type="description">Full event name.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.EventRecord.Timestamp"> <summary> <para type="description">DateTime when event was persisted.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.EventRecord.Payload"> <summary> <para type="description">Full JSON payload of the event.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.EventRecord.IsRequired"> <summary> <para type="description">True if this is Required event.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.EventRecord.DiagnosticDataCategories"> <summary> <para type="description">List of event diagnostic data categories.</para> </summary> </member> <member name="T:DDVCmdlets.Containers.DiagnosticDataCategory"> <summary> <para type="description">Diagnostic data category information.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.DiagnosticDataCategory.Id"> <summary> <para type="description">Diagnostic data category ID number.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.DiagnosticDataCategory.Name"> <summary> <para type="description">Diagnostic data category name.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.DiagnosticDataCategory.Description"> <summary> <para type="description">Diagnostic data category description.</para> </summary> </member> <member name="T:DDVCmdlets.Containers.DiagnosticDataSource"> <summary> <para type="description">Diagnostic data source information.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.DiagnosticDataSource.Name"> <summary> <para type="description">Diagnostic data source name.</para> </summary> </member> <member name="T:DDVCmdlets.Containers.DiagnosticDataOtherFilter"> <summary> <para type="description">Diagnostic data other filter information.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.DiagnosticDataOtherFilter.DataSource"> <summary> <para type="description">Diagnostic data source name.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.DiagnosticDataOtherFilter.Id"> <summary> <para type="description">Diagnostic data other filter ID number.</para> </summary> </member> <member name="P:DDVCmdlets.Containers.DiagnosticDataOtherFilter.Name"> <summary> <para type="description">Diagnostic data other filter name.</para> </summary> </member> <member name="T:DDVCmdlets.CSharpCmdlets.GetDiagnosticData"> <example> <code>Get-DiagnosticData -StartTime (Get-Date).AddDays(-1) -RecordCount 1</code> <para>Returns first (oldest) diagnostic event since yesterday. Sample output below. </para> <para>Name : Microsoft.Windows.Kernel.PnP.DeviceConfig</para> <para>Timestamp : 11/8/2018 4:52:53 PM</para> <para>Payload : JSON PAYLOAD</para> <para>IsRequired : False</para> <para>DiagnosticDataCategories : {11}</para> <para></para> </example> <example> <code>Get-DiagnosticData -StartTime (Get-Date).AddHours(-12) -EndTime (Get-Date).AddHours(-6) -RequiredTelemetryOnly</code> <para>Returns all required diagnostic events sent between 12 and 6 hours before now.</para> </example> <example> <code>Get-DiagnosticData -EventNameFilter EventName</code> <para>Returns diagnostic events with name EventName (case insensitive).</para> </example> <example> <code>Get-DiagnosticData -DiagnosticDataCategory 11</code> <para>Returns diagnostic events tagged with diagnostic data category ID 11. See Get-DiagnosticDataCategories for the list of diagnostic data categories.</para> <para></para> </example> <summary> <para type="synopsis">Fetches historical Windows Diagnostic Data uploaded by this machine.</para> <para type="description">This cmdlet fetches historical Windows Diagnostic Data uploaded by this machine. The total available historical data is limited by the diagnostic data store’s configurations. See 'Set-DiagnosticStoreCapacity' for changes.</para> </summary> </member> <member name="P:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.StartTime"> <summary> <para type="description">Query filter parameter. Specifies start time of the window for the oldest event in the fetched set. </para> </summary> </member> <member name="P:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.EndTime"> <summary> <para type="description">Query filter parameter. Specifies end time of the window for the newest event in the fetched set. </para> </summary> </member> <member name="P:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.RecordCount"> <summary> <para type="description">Specifies maximum number of events to fetch.</para> </summary> </member> <member name="P:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.DiagnosticDataCategory"> <summary> <para type="description">Query filter parameter. Specifies if resultset should only include events having this diagnostic data category. See Get-DiagnosticDataCategories for data category IDs.</para> </summary> </member> <member name="P:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.DiagnosticDataSource"> <summary> <para type="description">Query filter parameter. Specifies if resultset should only include events having this diagnostic data source. See Get-DiagnosticDataSources for data source names.</para> </summary> </member> <member name="P:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.DiagnosticDataOtherFilter"> <summary> <para type="description">Query filter parameter. Specifies if resultset should only include events having this diagnostic data other filter. See Get-DiagnosticDataOtherFilters for data other filter IDs.</para> </summary> </member> <member name="P:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.RequiredTelemetryOnly"> <summary> <para type="description">Query filter parameter. Specifies if resultset should only include Required diagnostic data events.</para> </summary> </member> <member name="P:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.EventNameFilter"> <summary> <para type="description">Event name filter parameter. Specifies if resultset should only include events with this name (case insensitive.).</para> </summary> </member> <member name="M:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.BeginProcessing"> <summary> <para type="description">Fetches the requested data.</para> </summary> </member> <member name="M:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.ProcessRecord"> <summary> <para type="description">Writes query results to the output.</para> </summary> </member> <member name="M:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.EndProcessing"> <summary> <para type="description">Releases resources in case of successful termination.</para> </summary> </member> <member name="M:DDVCmdlets.CSharpCmdlets.GetDiagnosticData.StopProcessing"> <summary> <para type="description">Releases resources in case of cancellation.</para> </summary> </member> <member name="T:DDVCmdlets.CSharpCmdlets.GetDiagnosticDataCategories"> <example> <code>Get-DiagnosticDataCategories</code> <para>Fetches Windows Diagnostic Data diagnostic data categories.</para> </example> <summary> <para type="synopsis">Fetches the mapping of diagnostic data category identifiers to their corresponding descriptions.</para> <para type="description">This cmdlet shows the mapping between diagnostic data category identifiers to their official descriptions. Each diagnostic data event is grouped into a Data Category based on how Microsoft uses the data. It may take some time for descriptions to be loaded. </para> <para type="link">https://docs.microsoft.com/en-us/windows/privacy/windows-diagnostic-data</para> </summary> </member> <member name="M:DDVCmdlets.CSharpCmdlets.GetDiagnosticDataCategories.BeginProcessing"> <summary> <para type="description">Fetches the requested data.</para> </summary> </member> <member name="M:DDVCmdlets.CSharpCmdlets.GetDiagnosticDataCategories.ProcessRecord"> <summary> <para type="description">Writes query results to the output.</para> </summary> </member> <member name="M:DDVCmdlets.CSharpCmdlets.GetDiagnosticDataCategories.EndProcessing"> <summary> <para type="description">Releases resources in case of successful termination.</para> </summary> </member> <member name="M:DDVCmdlets.CSharpCmdlets.GetDiagnosticDataCategories.StopProcessing"> <summary> <para type="description">Releases resources in case of cancellation.</para> </summary> </member> <member name="T:DDVCmdlets.CSharpCmdlets.GetDiagnosticDataViewingSetting"> <example> <code>Get-DiagnosticDataViewingSetting</code> <para>Checks if Diagnostic Data Viewing is enabled.</para> </example> <summary> <para type="synopsis">Fetches whether diagnostic data viewing is currently enabled or disabled.</para> <para type="description">This cmdlet returns the current state of diagnostic data viewing. This state indicates whether diagnostic data viewing is enabled for this device. If disabled, this tool will throw an error.</para> </summary> </member> <member name="M:DDVCmdlets.CSharpCmdlets.GetDiagnosticDataViewingSetting.ProcessRecord"> <summary> <para type="description">Writes query results to the output.</para> </summary> </member> <member name="T:DDVCmdlets.GetDiagnosticDataSources"> <example> <code>Get-DiagnosticDataSources</code> <para>Fetches Windows Diagnostic Data diagnostic data sources.</para> </example> <summary> <para type="synopsis">Fetches the mapping of diagnostic data source identifiers to their corresponding descriptions.</para> <para type="description">This cmdlet shows the mapping between diagnostic data source identifiers to their official descriptions. Each diagnostic data event is grouped into a Data Source based on how Microsoft uses the data. It may take some time for descriptions to be loaded. </para> <para type="link">https://docs.microsoft.com/en-us/windows/privacy/windows-diagnostic-data</para> </summary> </member> <member name="M:DDVCmdlets.GetDiagnosticDataSources.BeginProcessing"> <summary> <para type="description">Fetches the requested data.</para> </summary> </member> <member name="M:DDVCmdlets.GetDiagnosticDataSources.ProcessRecord"> <summary> <para type="description">Writes query results to the output.</para> </summary> </member> <member name="M:DDVCmdlets.GetDiagnosticDataSources.EndProcessing"> <summary> <para type="description">Releases resources in case of successful termination.</para> </summary> </member> <member name="M:DDVCmdlets.GetDiagnosticDataSources.StopProcessing"> <summary> <para type="description">Releases resources in case of cancellation.</para> </summary> </member> <member name="T:DDVCmdlets.GetDiagnosticDataOtherFilters"> <example> <code>Get-DiagnosticDataOtherFilters</code> <para>Fetches Windows Diagnostic Data diagnostic data other filters.</para> </example> <summary> <para type="synopsis">Fetches the mapping of diagnostic data other filter identifiers to their corresponding descriptions.</para> <para type="description">This cmdlet shows the mapping between diagnostic data other filter identifiers to their official descriptions. Some diagnostic data event are assigned to a Data Other Filter based on how Microsoft uses the data. It may take some time for descriptions to be loaded. </para> <para type="link">https://docs.microsoft.com/en-us/windows/privacy/windows-diagnostic-data</para> </summary> </member> <member name="M:DDVCmdlets.GetDiagnosticDataOtherFilters.BeginProcessing"> <summary> <para type="description">Fetches the requested data.</para> </summary> </member> <member name="M:DDVCmdlets.GetDiagnosticDataOtherFilters.ProcessRecord"> <summary> <para type="description">Writes query results to the output.</para> </summary> </member> <member name="M:DDVCmdlets.GetDiagnosticDataOtherFilters.EndProcessing"> <summary> <para type="description">Releases resources in case of successful termination.</para> </summary> </member> <member name="M:DDVCmdlets.GetDiagnosticDataOtherFilters.StopProcessing"> <summary> <para type="description">Releases resources in case of cancellation.</para> </summary> </member> <member name="T:DDVCmdlets.GetDiagnosticStoreCapacity"> <example> <code>Get-DiagnosticStoreCapacity -Size</code> <para>Get configured size capacity (megabytes) of the Diagnostic store.</para> </example> <example> <code>Get-DiagnosticStoreCapacity -Time</code> <para>Get configured time capacity (hours) of the Diagnostic store.</para> </example> <summary> <para type="synopsis">Fetches the current diagnostic store capacity. Parameter [-Size] returns the diagnostic store size capacity in megabytes. Parameter [-Time] returns the diagnostic store capacity in days. The default diagnostic data store size capacity is 1024 MB. The default time capacity is 30 days.</para> <para type="description">The amount of Diagnostic Data history that can be shown through this tool is capped based on time in days and size in megabytes. Once either cap is reached (whichever comes first), diagnostic data is removed based on a first in first out order. For example, if the size cap is 1GB and the time cap is 30 days, then once the diagnostic data store has reached 1GB of history or the oldest record is 30 days old (whichever comes first), the oldest seen event is dropped.</para> </summary> </member> <member name="P:DDVCmdlets.GetDiagnosticStoreCapacity.Size"> <summary> <para type="description">Get configured size capacity (megabytes) of the Diagnostic store.</para> </summary> </member> <member name="P:DDVCmdlets.GetDiagnosticStoreCapacity.Time"> <summary> <para type="description">Get configured time capacity (hours) of the Diagnostic store.</para> </summary> </member> <member name="M:DDVCmdlets.GetDiagnosticStoreCapacity.ProcessRecord"> <summary> <para type="description">Writes query results to the output.</para> </summary> </member> <member name="T:DDVCmdlets.SetDiagnosticStoreCapacity"> <example> <code>Set-DiagnosticStoreCapacity -Size 1024</code> <para>Set store capacity (megabytes) of the diagnostic store.</para> </example> <example> <code>Set-DiagnosticStoreCapacity -Time 24</code> <para>Set time capacity (hours) of the diagnostic store.</para> </example> <example> <code>Set-DiagnosticStoreCapacity -Size 1024 -Time 24</code> <para>Set store capacity (megabytes) and time capacity (hours) of the diagnostic store at the same time.</para> </example> <summary> <para type="synopsis">Sets the diagnostic store time and size capacity.</para> <para type="description">This cmdlet sets the maximum amount of Diagnostic Data history (by time and by size) that can be shown through this tool. The size cap is measured in megabytes, and the time cap is measured in days. Once the either cap is reached (whichever comes first), diagnostic data history is removed based on a first in first out order.</para> </summary> </member> <member name="P:DDVCmdlets.SetDiagnosticStoreCapacity.Size"> <summary> <para type="description">Set size capacity of the diagnostic store.</para> </summary> </member> <member name="P:DDVCmdlets.SetDiagnosticStoreCapacity.Time"> <summary> <para type="description">Set time capacity of the diagnostic store.</para> </summary> </member> <member name="M:DDVCmdlets.SetDiagnosticStoreCapacity.ProcessRecord"> <summary> <para type="description">Writes query results to the output.</para> </summary> </member> </members> </doc> |