Microsoft Azure

Microsoft Azure Nodecounts API

The Nodecounts API from Microsoft Azure — 1 operation(s) for nodecounts.

Documentation GitHub OpenAPI

Operations 1

GET /nodecounts Microsoft Azure Get Nodecounts #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-nodecounts-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Nodecounts API
tags:
- name: Nodecounts
paths:
  /nodecounts:
    get:
      operationId: microsoftAzureBatchListpoolnodecounts
      description: Gets the number of Compute Nodes in each state, grouped by Pool. Note that the<br>numbers returned may not always be up to date. If you need exact node counts,<br>use a list query.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: 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.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: '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.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: maxresults
        in: query
        description: 'The maximum number of items to return in the response. A maximum of 1000

          applications can be returned.'
        required: false
        schema:
          type: integer
          format: int32
          default: 1000
          maximum: 1000
          minimum: 1
      - name: $filter
        in: query
        description: 'An OData $filter clause. For more information on constructing this filter, see

          https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPoolNodeCountsListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        NodeCountsPayload:
          $ref: ./examples/AccountListPoolNodeCounts.json
      x-ms-pageable:
        nextLinkName: odata.nextLink
      summary: Microsoft Azure Get Nodecounts
      tags:
      - Nodecounts
components:
  schemas:
    BatchErrorMessage:
      type: object
      description: An error message received in an Azure Batch error response.
      properties:
        lang:
          type: string
          description: The language code of the error message.
        value:
          type: string
          description: The text of the message.
    BatchNodeCounts:
      type: object
      description: The number of Compute Nodes in each Compute Node state.
      properties:
        creating:
          type: integer
          format: int32
          description: The number of Compute Nodes in the creating state.
        idle:
          type: integer
          format: int32
          description: The number of Compute Nodes in the idle state.
        offline:
          type: integer
          format: int32
          description: The number of Compute Nodes in the offline state.
        preempted:
          type: integer
          format: int32
          description: The number of Compute Nodes in the preempted state.
        rebooting:
          type: integer
          format: int32
          description: The count of Compute Nodes in the rebooting state.
        reimaging:
          type: integer
          format: int32
          description: The number of Compute Nodes in the reimaging state.
        running:
          type: integer
          format: int32
          description: The number of Compute Nodes in the running state.
        starting:
          type: integer
          format: int32
          description: The number of Compute Nodes in the starting state.
        startTaskFailed:
          type: integer
          format: int32
          description: The number of Compute Nodes in the startTaskFailed state.
        leavingPool:
          type: integer
          format: int32
          description: The number of Compute Nodes in the leavingPool state.
        unknown:
          type: integer
          format: int32
          description: The number of Compute Nodes in the unknown state.
        unusable:
          type: integer
          format: int32
          description: The number of Compute Nodes in the unusable state.
        waitingForStartTask:
          type: integer
          format: int32
          description: The number of Compute Nodes in the waitingForStartTask state.
        total:
          type: integer
          format: int32
          description: The total number of Compute Nodes.
        upgradingOs:
          type: integer
          format: int32
          description: The number of Compute Nodes in the upgradingOS state.
          x-ms-client-name: upgradingOS
      required:
      - creating
      - idle
      - offline
      - preempted
      - rebooting
      - reimaging
      - running
      - starting
      - startTaskFailed
      - leavingPool
      - unknown
      - unusable
      - waitingForStartTask
      - total
      - upgradingOs
    BatchErrorDetail:
      type: object
      description: An item of additional information included in an Azure Batch error response.
      properties:
        key:
          type: string
          description: An identifier specifying the meaning of the Value property.
        value:
          type: string
          description: The additional information included with the error response.
    BatchPoolNodeCountsListResult:
      type: object
      description: The result of listing the Compute Node counts in the Account.
      properties:
        value:
          type: array
          description: A list of Compute Node counts by Pool.
          items:
            $ref: '#/components/schemas/BatchPoolNodeCounts'
          x-ms-identifiers: []
        odata.nextLink:
          type: string
          description: The URL to get the next set of results.
    BatchPoolNodeCounts:
      type: object
      description: The number of Compute Nodes in each state for a Pool.
      properties:
        poolId:
          type: string
          description: The ID of the Pool.
        dedicated:
          $ref: '#/components/schemas/BatchNodeCounts'
          description: The number of dedicated Compute Nodes in each state.
        lowPriority:
          $ref: '#/components/schemas/BatchNodeCounts'
          description: The number of Spot/Low-priority Compute Nodes in each state.
      required:
      - poolId
    BatchError:
      type: object
      description: An error response received from the Azure Batch service.
      properties:
        code:
          type: string
          description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        message:
          $ref: '#/components/schemas/BatchErrorMessage'
          description: A message describing the error, intended to be suitable for display in a user interface.
        values:
          type: array
          description: A collection of key-value pairs containing additional details about the error.
          items:
            $ref: '#/components/schemas/BatchErrorDetail'
          x-ms-identifiers: []
      required:
      - code
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'