Get-O365ClientOSDetailReport
This cmdlet is available only in the cloud-based service.
This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph.
Use the Get-O365ClientOSDetailReport cmdlet to get a detailed report of client operating system use.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Get-O365ClientOSDetailReport
[-EndDate <DateTime>]
[-OperatingSystem <String>]
[-OperatingSystemVersion <String>]
[-ResultSize <Unlimited>]
[-StartDate <DateTime>]
[-WindowsLiveID <String>]
[<CommonParameters>] Description
This report provides operating system details for all active users. The data contains a maximum of four operating systems per user, are aggregated daily and retained for 5 days. The properties that are returned in the results are described in the following list.
- TenantGuid: Unique identifier of the tenant.
- TenantName: Tenant name.
- Date: The timestamp for the connection for the operating system and version combination.
- WindowsLiveID: User ID in the format user@domain.
- DisplayName: User name.
- LastAccessTime: Last date the user connected with this operating system and version combination.
- ObjectId: User object ID.
- OperatingSystem: Operating system name.
- Version: Operating system version.
- OperatingSystemUsageCount: Number of days this operating system and version combination was used during the period of the report
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Examples
Example 1
Get-O365ClientOSDetailReport -WindowsLiveID john@contoso.com -StartDate 05/01/2017 -EndDate 05/03/2017This example retrieves the operating system details for user John between May 1, 2017 and May 3, 2017.
Example 2
Get-O365ClientOSDetailReport -OperatingSystem AndroidThis example retrieves the operating system details for the Android operating system for the current 5 day retention period (no start and end date are specified).
Parameters
-EndDate
The EndDate parameter specifies the end date of the date range.
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-OperatingSystem
The OS parameter filters the report by operating system. If you don't use this parameter, all operating systems will be included. The accepted values for this parameter are:
- Windows
- Android
- iOS
- "Mac OS"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-OperatingSystemVersion
The OperatingSystemVersion parameter filters the report by operating system version. If you don't use this parameter, all operating system versions will be included. The parameter accepts version numbers up to the first minor version. For example, use 6 or 6.1, not 6.1.9600. Wildcards are not accepted.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ResultSize
The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.
| Type: | Unlimited |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-StartDate
The StartDate parameter specifies the start date of the date range.
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-WindowsLiveID
The WindowsLiveID filters the report by user ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for