Edit

costManagementUsageReportRoot resource type

Important

APIs under the /beta version are subject to change. Use of these APIs in production applications is not supported.

The Copilot Cost Management usage reporting root, contained by costManagementRoot at /copilot/costManagement/usageReports. It's the containment parent for the usage report collections, which report consumption of Copilot Credits by user, security group, governed service, and funding class, and for raw per-user usage detail. Every usage report requires a time selector query parameter. For details, see Usage report time selectors and paging.

Note

The root itself isn't readable. GET /copilot/costManagement/usageReports returns a 404 response and carries no data. Use the contained collections instead.

Methods

Method Return type Description
List user usage records costManagementUserUsageRecord collection Get reported consumption per user for one completed UTC day.
List group usage records costManagementGroupUsageRecord collection Get reported consumption per security group for one completed UTC day.
List service usage records costManagementServiceUsageRecord collection Get reported consumption per governed service for one completed UTC day.
List funding usage records costManagementFundingUsageRecord collection Get reported consumption per funding class for a calendar month.
Get user usage detail costManagementUserUsageDetail Get one user's raw usage detail over a timestamp window.

Properties

Property Type Description
id String Inherited from entity. Read-only.

Relationships

Relationship Type Description
fundingUsageRecords costManagementFundingUsageRecord collection Reported consumption per funding class for a calendar month.
groupUsageRecords costManagementGroupUsageRecord collection Reported consumption per security group for one completed UTC day.
serviceUsageRecords costManagementServiceUsageRecord collection Reported consumption per governed service for one completed UTC day.
userUsageDetails costManagementUserUsageDetail collection Raw per-user usage detail, read one user at a time. The collection isn't listable; read by key only.
userUsageRecords costManagementUserUsageRecord collection Reported consumption per user for one completed UTC day, ranked by consumption.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.costManagementUsageReportRoot",
  "id": "String"
}