Share via

Get-MgBetaReportMicrosoft365CopilotUserCountSummary

  • Reference
Module:
Microsoft.Graph.Beta.Reports

Get the aggregated number of active and enabled users of Copilot for Microsoft 365 for a specified time period.

Syntax

Get-MgBetaReportMicrosoft365CopilotUserCountSummary
   -Period <String>
   -OutFile <String>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-PassThru]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-MgBetaReportMicrosoft365CopilotUserCountSummary
   -InputObject <IReportsIdentity>
   -OutFile <String>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-PassThru]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Get the aggregated number of active and enabled users of Copilot for Microsoft 365 for a specified time period.

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.Beta.Reports

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

This example will csv output

Example 2: JSON output

Import-Module Microsoft.Graph.Beta.Reports

Get-MgBetaReportMicrosoft365CopilotUserCountSummary -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.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
  • [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
  • [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
  • [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