APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Get a usage report on shared-use licenses, such as servicePlanId, licenseCount, and claimedLicenseCount, for real-time, 7 days, or 28 days trend.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type
Permissions (from least to most privileged)
Delegated (work or school account)
CloudPC.Read.All, CloudPC.ReadWrite.All
Delegated (personal Microsoft account)
Not supported.
Application
CloudPC.Read.All, CloudPC.ReadWrite.All
HTTP request
POST /deviceManagement/virtualEndpoint/reports/getSharedUseLicenseUsageReport
Request headers
Name
Description
Authorization
Bearer {token}. Required.
Content-Type
application/json. Required.
Request body
In the request body, supply a JSON representation of the parameters.
The following table shows the parameters that can be used with this action.
Parameter
Type
Description
reportName
String
Specifies the report name.
filter
String
OData filter syntax. Supported filters include and, or, lt, le, gt, ge, and eq.
select
String collection
OData select syntax. Represents the selected columns of the reports.
search
String
Specifies a string to search.
groupBy
String collection
Specifies how to group the reports. If used, must have the same content as the select parameter.
orderBy
String collection
Specifies how to sort the reports.
skip
Int32
The number of records to skip.
top
Int32
The number of top records to return.
Response
If successful, this action returns a 200 OK response code and a Stream in the response body.
// Code snippets are only available for the latest version. Current version is 5.x
var graphClient = new GraphServiceClient(requestAdapter);
var requestBody = new Microsoft.Graph.Beta.DeviceManagement.VirtualEndpoint.Reports.GetSharedUseLicenseUsageReport.GetSharedUseLicenseUsageReportPostRequestBody
{
ReportName = CloudPcReportName.SharedUseLicenseUsageReport,
Filter = "ServicePlanId eq '2d1d344e-d10c-41bb-953b-b3a47521dca0' and DateTimeUTC gt datetime'2022-11-30'",
Select = new List<string>
{
"ServicePlanId",
"LicenseCount",
"ClaimedLicenseCount",
"DateTimeUTC",
},
Skip = 0,
Top = 100,
};
await graphClient.DeviceManagement.VirtualEndpoint.Reports.GetSharedUseLicenseUsageReport.PostAsync(requestBody);
Important
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
<?php
// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);
$requestBody = new GetSharedUseLicenseUsageReportPostRequestBody();
$requestBody->setReportName(new CloudPcReportName('shareduselicenseusagereport'));
$requestBody->setFilter('ServicePlanId eq \'2d1d344e-d10c-41bb-953b-b3a47521dca0\' and DateTimeUTC gt datetime\'2022-11-30\'');
$requestBody->setSelect(['ServicePlanId', 'LicenseCount', 'ClaimedLicenseCount', 'DateTimeUTC', ]);
$requestBody->setSkip(0);
$requestBody->setTop(100);
$graphServiceClient->deviceManagement()->virtualEndpoint()->reports()->getSharedUseLicenseUsageReport()->post($requestBody);
Important
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.
// THE PYTHON SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
client = GraphServiceClient(request_adapter)
request_body = GetSharedUseLicenseUsageReportPostRequestBody()
request_body.reportname(CloudPcReportName.SharedUseLicenseUsageReport('cloudpcreportname.shareduselicenseusagereport'))
request_body.filter = 'ServicePlanId eq \'2d1d344e-d10c-41bb-953b-b3a47521dca0\' and DateTimeUTC gt datetime\'2022-11-30\''
request_body.Select(['ServicePlanId', 'LicenseCount', 'ClaimedLicenseCount', 'DateTimeUTC', ])
request_body.Skip = 0
request_body.Top = 100
await client.device_management.virtual_endpoint.reports.get_shared_use_license_usage_report.post(request_body = request_body)
Important
Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.