Get-MgReportM365AppUserCount
Get a report that provides the trend in the number of active users for each app (Outlook, Word, Excel, PowerPoint, OneNote, and Teams) in your organization.
Note
To view the beta release of this cmdlet, view Get-MgBetaReportM365AppUserCount
Syntax
Get-MgReportM365AppUserCount
-Period <String>
-OutFile <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-MgReportM365AppUserCount
-InputObject <IReportsIdentity>
-OutFile <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Description
Get a report that provides the trend in the number of active users for each app (Outlook, Word, Excel, PowerPoint, OneNote, and Teams) in your organization.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Reports.Read.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Reports.Read.All | Not available. |
Examples
Example 1: CSV output
Import-Module Microsoft.Graph.Reports
Get-MgReportM365AppUserCount -Format "text/csv" -Period $periodId
This example will csv output
Example 2: JSON output
Import-Module Microsoft.Graph.Reports
Get-MgReportM365AppUserCount -Format "application/json" -Period $periodId
This example will json output
Parameters
-Headers
Optional headers that will be added to the request.
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IReportsIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-OutFile
Path to write output file to
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Returns true when the command succeeds
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Period
Usage: period='{period}'
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
Type: | ActionPreference |
Aliases: | proga |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Type: | String |
Aliases: | RHV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IReportsIdentity
System.Collections.IDictionary
Outputs
System.Boolean
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IReportsIdentity>
: Identity Parameter
[Date <DateTime?>]
: Usage: date={date}[DeviceManagementExportJobId <String>]
: The unique identifier of deviceManagementExportJob[DirectoryAuditId <String>]
: The unique identifier of directoryAudit[EndDateTime <DateTime?>]
: Usage: endDateTime={endDateTime}[Filter <String>]
: Usage: filter='{filter}'[GroupId <String>]
: Usage: groupId='{groupId}'[IncludedUserRoles <String>]
: Usage: includedUserRoles='{includedUserRoles}'[IncludedUserTypes <String>]
: Usage: includedUserTypes='{includedUserTypes}'[ManifestId <String>]
: The unique identifier of manifest[OperationId <String>]
: The unique identifier of operation[Period <String>]
: Usage: period='{period}'[PrintUsageByPrinterId <String>]
: The unique identifier of printUsageByPrinter[PrintUsageByUserId <String>]
: The unique identifier of printUsageByUser[PrinterId <String>]
: Usage: printerId='{printerId}'[ProvisioningObjectSummaryId <String>]
: The unique identifier of provisioningObjectSummary[SignInId <String>]
: The unique identifier of signIn[Skip <Int32?>]
: Usage: skip={skip}[SkipToken <String>]
: Usage: skipToken='{skipToken}'[StartDateTime <DateTime?>]
: Usage: startDateTime={startDateTime}[Top <Int32?>]
: Usage: top={top}[UserId <String>]
: Usage: userId='{userId}'[UserRegistrationDetailsId <String>]
: The unique identifier of userRegistrationDetails