costManagementUserServiceBalance resource type

Important

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

Per-service balance and enforcement-selection diagnosis for a user. Keyed by serviceId; a user holds at most one balance per service.

Methods

Method	Return type	Description
List	costManagementUserServiceBalance collection	Get a list of costManagementUserServiceBalance objects.
Get	costManagementUserServiceBalance	Retrieve the properties of a costManagementUserServiceBalance object.

Properties

Property	Type	Description
accessDecisionReason	accessDecisionReason	The reason for the access decision.
configuredPerUserLimit	costManagementQuantity	The selected policy's per-user limit for the current UTC month; unlimitedCostManagementQuantity when no per-user cap.
configuredPeriodLimit	costManagementQuantity	The selected policy's consumption limit for the current UTC month.
consumedQuantity	Double	Measured consumption for the selected service context, month-to-date in UTC.
dataStatus	costManagementDataStatus	Freshness of the source data behind this row.
effectiveCapacityQuantity	costManagementQuantity	Capacity available from the selected policy; unlimitedCostManagementQuantity when no cap.
isConsumptionAllowed	Boolean	Whether the user can currently consume the service. A false value can mean missing entitlement or an exhausted limit; inspect accessDecisionReason. Supports $filter (eq).
remainingQuantity	costManagementQuantity	Remaining quantity under the selected policy for the current period; unlimitedCostManagementQuantity when no cap.
serviceId	String	The service identifier. Key, read-only. Case-sensitive. Supports $filter (eq, in) and $orderby when listing one user's service balances.
spendingPolicyId	String	Identifier of the spending policy selected for this service. Always present for a balance row. Read-only.
unit	costManagementUnit	The unit for consumedQuantity.

accessDecisionReason enumeration

An evolvable enumeration with the following possible values.

Value	Description
allowed	The user is allowed to consume.
notEntitled	The user isn't entitled to the service.
limitExhausted	The applicable limit is exhausted.
unknownFutureValue	Evolvable enumeration sentinel value.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.costManagementUserServiceBalance",
  "accessDecisionReason": "String",
  "configuredPerUserLimit": {
    "@odata.type": "microsoft.graph.costManagementQuantity"
  },
  "configuredPeriodLimit": {
    "@odata.type": "microsoft.graph.costManagementQuantity"
  },
  "consumedQuantity": "Double",
  "dataStatus": {
    "@odata.type": "microsoft.graph.costManagementDataStatus"
  },
  "effectiveCapacityQuantity": {
    "@odata.type": "microsoft.graph.costManagementQuantity"
  },
  "isConsumptionAllowed": "Boolean",
  "remainingQuantity": {
    "@odata.type": "microsoft.graph.costManagementQuantity"
  },
  "serviceId": "String",
  "spendingPolicyId": "String",
  "unit": "String"
}