Share via


Tenant Capacity Details - Get Tenant Capacity Details

Get the tenant capacity details for the tenant.

GET https://api.powerplatform.com/licensing/tenantCapacity?api-version=2022-03-01-preview

URI Parameters

Name In Required Type Description
api-version
query True

string

The API version.

Responses

Name Type Description
200 OK

TenantCapacityDetailsModel

Success

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
CapacityAvailabilityStatus
CapacityEntitlementType
CapacityStatusMessageCode
CapacitySummary
CapacityType
CapacityUnits
ConsumptionModel
LegacyCapacityModel
LicenseDetailsModel
LicenseModel
LicenseQuantity
OverflowCapacityModel
TemporaryLicenseInfo
TenantCapacityAndConsumptionModel
TenantCapacityDetailsModel
TenantCapacityEntitlementModel

CapacityAvailabilityStatus

Value Description
None
Available
AvailableByOverflow
NotAvailable

CapacityEntitlementType

Value Description
None
DatabaseBase
DatabaseIncremental
DatabaseAddOn
FileBase
FileIncremental
FileAddOn
LogBase
LogAddOn
SubscriptionTrialDatabaseBase
SubscriptionTrialFileBase
SubscriptionTrialLogBase
SubscriptionTrialEnvironmentCountBase
SubscriptionTrialEnvironmentCountIncremental
TrialDatabaseBase
TrialFileBase
TrialLogBase
M365DatabaseBase
M365DatabaseIncremental
M365EnvironmentCountBase
M365EnvironmentCountIncremental
ApiCallCountIncremental
ApiCallCountBase
CapacityPassBase
FinOpsDatabaseBase
FinOpsDatabaseIncremental
FinOpsFileBase
FinOpsFileIncremental

CapacityStatusMessageCode

Value Description
AllCapacityAvailable
DBCapacityOver
LogOverDBCover
LogCapacityOver
FileOverDBCover
FileOverLogCover
FileOverDBAndLogCover
FileCapacityOver
DBAndLogOver
DBAndFileOver
LogAndFileOverDBCover
LogAndFileOver
AllCapacityOver
LegacyCapacityAvailable
LegacyCapacityOver
FinOpsAllCapacityAvailable
FinOpsNotAvailable
FinOpsAllCapacityOver
FinOpsDBCapacityOver
FinOpsFileCapacityOver
LegacyCapacityMoreThanEightyFive
DBCapacityMoreThanEightyFive
LogCapacityMoreThanEightyFive
FileCapacityMoreThanEightyFive
DBAndFileCapacityMoreThanEightyFive
DBAndLogCapacityMoreThanEightyFive
LogAndFileCapacityMoreThanEightyFive
AllCapacityMoreThanEightyFive

CapacitySummary

Name Type Description
finOpsStatus

CapacityAvailabilityStatus

finOpsStatusMessage

string

finOpsStatusMessageCode

CapacityStatusMessageCode

status

CapacityAvailabilityStatus

statusMessage

string

statusMessageCode

CapacityStatusMessageCode

CapacityType

Value Description
None
Database
File
Log
TrialDatabase
TrialFile
TrialLog
SubscriptionTrialDatabase
SubscriptionTrialFile
SubscriptionTrialLog
M365Database
M365EnvironmentCount
SubscriptionTrialEnvironmentCount
CapacityPass
ApiCallCount
FinOpsDatabase
FinOpsFile
PIProcess

CapacityUnits

Value Description
None
Unit
MB

ConsumptionModel

Name Type Description
actual

number (double)

actualUpdatedOn

string (date-time)

rated

number (double)

ratedUpdatedOn

string (date-time)

LegacyCapacityModel

Name Type Description
capacityUnits

CapacityUnits

totalCapacity

number (double)

totalConsumption

number (double)

LicenseDetailsModel

Name Type Description
capabilityStatus

string

displayName

string

entitlementCode

string

isTemporaryLicense

boolean

nextLifecycleDate

string (date-time)

paid

LicenseQuantity

servicePlanId

string (uuid)

skuId

string (uuid)

temporaryLicenseExpiryDate

string (date-time)

totalCapacity

number (double)

trial

LicenseQuantity

LicenseModel

Value Description
None
Legacy
StorageDriven

LicenseQuantity

Name Type Description
enabled

integer (int32)

suspended

integer (int32)

warning

integer (int32)

OverflowCapacityModel

Name Type Description
capacityType

CapacityType

value

number (double)

TemporaryLicenseInfo

Name Type Description
hasTemporaryLicense

boolean

temporaryLicenseExpiryDate

string (date-time)

TenantCapacityAndConsumptionModel

Name Type Description
capacityEntitlements

TenantCapacityEntitlementModel[]

capacityType

CapacityType

capacityUnits

CapacityUnits

consumption

ConsumptionModel

maxCapacity

number (double)

overflowCapacity

OverflowCapacityModel[]

status

CapacityAvailabilityStatus

totalCapacity

number (double)

TenantCapacityDetailsModel

Name Type Description
capacitySummary

CapacitySummary

legacyModelCapacity

LegacyCapacityModel

licenseModelType

LicenseModel

temporaryLicenseInfo

TemporaryLicenseInfo

tenantCapacities

TenantCapacityAndConsumptionModel[]

tenantId

string (uuid)

TenantCapacityEntitlementModel

Name Type Description
capacitySubType

CapacityEntitlementType

capacityType

CapacityType

licenses

LicenseDetailsModel[]

maxNextLifecycleDate

string (date-time)

totalCapacity

number (double)