pool_node_counts

Creates, updates, deletes, gets or lists a pool_node_counts resource.

Overview

Name	pool_node_counts
Type	Resource
Id	azure.batch_dataplane.pool_node_counts

Fields

The following fields are returned by SELECT queries:

list_pool_node_counts

Name	Datatype	Description
dedicated	object	The number of dedicated Compute Nodes in each state.
lowPriority	object	The number of Spot/Low-priority Compute Nodes in each state.
poolId	string	The ID of the Pool. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_pool_node_counts	select	endpoint	timeOut, ocp-date, maxresults, $filter	Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
$filter	string	An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images _. Default value is None.
maxresults	integer	The maximum number of items to return in the response. A maximum of 1000 applications can be returned. Default value is None.
ocp-date	string	The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. Default value is None.
timeOut	integer	The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". Default value is None.

SELECT examples

list_pool_node_counts

Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.

SELECT
dedicated,
lowPriority,
poolId
FROM azure.batch_dataplane.pool_node_counts
WHERE endpoint = '{{ endpoint }}' -- required
AND timeOut = '{{ timeOut }}'
AND ocp-date = '{{ ocp-date }}'
AND maxresults = '{{ maxresults }}'
AND $filter = '{{ $filter }}'
;