TaskAgentSkuUsageSummaryQuery interface

Package:

azure-devops-extension-api

Query for SKU usage statistics on an agent cloud pool. Groups billing data by a specified dimension and returns the top N consumers per SKU, ranked by total billed minutes.

Properties

endTimeExclusive	End of the time range (exclusive).
groupBy	The billing dimension to group and rank results by.
meterIds	Optional: restrict to specific SKUs. Null or empty means all SKUs. When multiple MeterIds are provided, results are ranked independently per SKU.
poolId	The pool to query usage for.
queueId	Optional: narrow results to a specific queue before grouping. Only valid when GroupBy is DefinitionId. The queue implicitly identifies the project.
scopeIdentifier	Optional: narrow results to a specific project before grouping. Typically used when drilling down from pool → project, with GroupBy set to DefinitionId to see pipelines within that project.
startTimeInclusive	Start of the time range (inclusive).
topN	Maximum results per SKU. Defaults to 5 server-side.

Property Details

endTimeExclusive

End of the time range (exclusive).

endTimeExclusive: Date

Property Value

Date

groupBy

The billing dimension to group and rank results by.

groupBy: TaskAgentSkuUsageDimension

Property Value

TaskAgentSkuUsageDimension

meterIds

Optional: restrict to specific SKUs. Null or empty means all SKUs. When multiple MeterIds are provided, results are ranked independently per SKU.

meterIds: string[]

Property Value

string[]

poolId

The pool to query usage for.

poolId: number

Property Value

number

queueId

Optional: narrow results to a specific queue before grouping. Only valid when GroupBy is DefinitionId. The queue implicitly identifies the project.

queueId: number

Property Value

number

scopeIdentifier

Optional: narrow results to a specific project before grouping. Typically used when drilling down from pool → project, with GroupBy set to DefinitionId to see pipelines within that project.

scopeIdentifier: string

Property Value

string

startTimeInclusive

Start of the time range (inclusive).

startTimeInclusive: Date

Property Value

Date

topN

Maximum results per SKU. Defaults to 5 server-side.

topN: number

Property Value

number