Entitlement Insight - Get Environment Resources

Service:

Power Platform API

API Version:

2024-10-01

Get environment resource entitlement snapshots for an entitlement.

GET https://api.powerplatform.com/licensing/entitlements/{entitlementId}/environments/{environmentId}/resources?fromDate={fromDate}&toDate={toDate}&api-version=2024-10-01

With optional parameters:

GET https://api.powerplatform.com/licensing/entitlements/{entitlementId}/environments/{environmentId}/resources?fromDate={fromDate}&toDate={toDate}&searchRequest={searchRequest}&includeFields={includeFields}&orderbyConsumed={orderbyConsumed}&continuationToken={continuationToken}&api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
entitlementId	path	True	string	The entitlement ID.
environmentId	path	True	string	The environment ID.
api-version	query	True	string	The API version.
fromDate	query	True	string	The start date (inclusive) of the query range.
toDate	query	True	string	The end date (inclusive) of the query range.
continuationToken	query		string	Continuation token for pagination.
includeFields	query		string	Comma separated additional fields to include in the response.
orderbyConsumed	query		string	Order by consumed date time if specified.
searchRequest	query		string	Search request for filtering the resources.

Responses

Name	Type	Description
200 OK	EnvironmentEntitlementSnapshotResponseModelPagedResponse	Success
204 No Content		No Content
400 Bad Request		Bad Request
401 Unauthorized		Unauthorized
403 Forbidden		Forbidden
404 Not Found		Not Found

Security

oauth2

Microsoft Entra ID OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com

Scopes

Name	Description
.default	.default

Definitions

Name	Description
EntitlementUnit	The unit of measure for an entitlement.
EnvironmentEntitlementSnapshotResponseModel
EnvironmentEntitlementSnapshotResponseModelPagedResponse	A paged response with a continuation token.
EnvironmentResourceEntitlementSnapshotResponseModel

EntitlementUnit

Enumeration

The unit of measure for an entitlement.

Value	Description
NotSpecified
MB
Count
Hour

EnvironmentEntitlementSnapshotResponseModel

Object

Name	Type	Description
resources	EnvironmentResourceEntitlementSnapshotResponseModel[]

EnvironmentEntitlementSnapshotResponseModelPagedResponse

Object

A paged response with a continuation token.

Name	Type	Description
@odata.count	integer (int32)
@odata.nextLink	string
continuationtoken	string
value	EnvironmentEntitlementSnapshotResponseModel[]

EnvironmentResourceEntitlementSnapshotResponseModel

Object

Name	Type	Description
consumed	number (double)	The consumed value.
lastRefreshedDate	string (date-time)	The last refreshed date.
metadata	object	Additional metadata such as Feature, ProductName and nonBillableConsumed for MCSMessages.
resourceId	string	The resource ID.
unit	EntitlementUnit	The unit of measure for an entitlement.