Get-MgBetaReportM365AppUserCount

Module:

Microsoft.Graph.Beta.Reports Module

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 v1.0 release of this cmdlet, view Get-MgReportM365AppUserCount

Syntax

Get (Default)

Get-MgBetaReportM365AppUserCount
    -Period <String>
    -OutFile <String>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [<CommonParameters>]

GetViaIdentity

Get-MgBetaReportM365AppUserCount
    -InputObject <IReportsIdentity>
    -OutFile <String>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [<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.

Examples

Example 1: CSV output

Import-Module Microsoft.Graph.Beta.Reports

Get-MgBetaReportM365AppUserCount -Format "text/csv"  -Period $periodId

This example will csv output

Example 2: JSON output

Import-Module Microsoft.Graph.Beta.Reports

Get-MgBetaReportM365AppUserCount -Format "application/json"  -Period $periodId

This example will json output

Parameters

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:	IDictionary
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:	IReportsIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OutFile

Path to write output file to

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Period

Usage: period='{period}'

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	RHV

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.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

• [ActiveUsersMetricId <String>]: The unique identifier of activeUsersMetric
• [AlertConfigurationId <String>]: The unique identifier of alertConfiguration
• [AlertId <String>]: The unique identifier of alert
• [AppCredentialSignInActivityId <String>]: The unique identifier of appCredentialSignInActivity
• [ApplicationSignInDetailedSummaryId <String>]: The unique identifier of applicationSignInDetailedSummary
• [AuthenticationsMetricId <String>]: The unique identifier of authenticationsMetric
• [CredentialUserRegistrationDetailsId <String>]: The unique identifier of credentialUserRegistrationDetails
• [CustomSecurityAttributeAuditId <String>]: The unique identifier of customSecurityAttributeAudit
• [DailyInactiveUsersByApplicationMetricId <String>]: The unique identifier of dailyInactiveUsersByApplicationMetric
• [DailyInactiveUsersMetricId <String>]: The unique identifier of dailyInactiveUsersMetric
• [Date <DateTime?>]: Usage: date={date}
• [DeviceManagementCachedReportConfigurationId <String>]: The unique identifier of deviceManagementCachedReportConfiguration
• [DeviceManagementExportJobId <String>]: The unique identifier of deviceManagementExportJob
• [DirectoryAuditId <String>]: The unique identifier of directoryAudit
• [EndDateTime <DateTime?>]: Usage: endDateTime={endDateTime}
• [ExclusiveIntervalEndDateTime <DateTime?>]: Usage: exclusiveIntervalEndDateTime={exclusiveIntervalEndDateTime}
• [Filter <String>]: Usage: filter='{filter}'
• [GroupId <String>]: Usage: groupId='{groupId}'
• [IncludedUserRoles <String>]: Usage: includedUserRoles='{includedUserRoles}'
• [IncludedUserTypes <String>]: Usage: includedUserTypes='{includedUserTypes}'
• [InclusiveIntervalStartDateTime <DateTime?>]: Usage: inclusiveIntervalStartDateTime={inclusiveIntervalStartDateTime}
• [InsightSummaryId <String>]: The unique identifier of insightSummary
• [ManifestId <String>]: The unique identifier of manifest
• [MfaCompletionMetricId <String>]: The unique identifier of mfaCompletionMetric
• [MfaTelecomFraudMetricId <String>]: The unique identifier of mfaTelecomFraudMetric
• [MfaUserCountMetricId <String>]: The unique identifier of mfaUserCountMetric
• [MonthlyInactiveUsersByApplicationMetricId <String>]: The unique identifier of monthlyInactiveUsersByApplicationMetric
• [MonthlyInactiveUsersMetricId <String>]: The unique identifier of monthlyInactiveUsersMetric
• [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
• [PrintUsageId <String>]: The unique identifier of printUsage
• [PrinterId <String>]: Usage: printerId='{printerId}'
• [ProvisioningObjectSummaryId <String>]: The unique identifier of provisioningObjectSummary
• [SelfServiceSignUpId <String>]: The unique identifier of selfServiceSignUp
• [ServicePrincipalSignInActivityId <String>]: The unique identifier of servicePrincipalSignInActivity
• [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}
• [UserCountMetricId <String>]: The unique identifier of userCountMetric
• [UserCredentialUsageDetailsId <String>]: The unique identifier of userCredentialUsageDetails
• [UserId <String>]: Usage: userId='{userId}'
• [UserRegistrationDetailsId <String>]: The unique identifier of userRegistrationDetails
• [UserRequestsMetricId <String>]: The unique identifier of userRequestsMetric
• [UserSignUpMetricId <String>]: The unique identifier of userSignUpMetric

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.reports/get-mgbetareportm365appusercount
• https://learn.microsoft.com/graph/api/reportroot-getm365appusercounts?view=graph-rest-beta