Microsoft Azure Nodecounts API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Nodecounts API
schemes:
- https
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: '#/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
        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
        type: string
        x-ms-client-name: clientRequestId
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        type: boolean
        default: false
        x-ms-client-name: returnClientRequestId
      - 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
        type: string
        format: date-time-rfc7231
        x-ms-client-name: ocpdate
      - 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
        type: integer
        format: int32
        default: 1000
        minimum: 1
        maximum: 1000
      - 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
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/BatchPoolNodeCountsListResult'
          headers:
            ETag:
              type: string
              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.
            Last-Modified:
              type: string
              format: date-time-rfc7231
              description: The time at which the resource was last modified.
            client-request-id:
              type: string
              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.
            request-id:
              type: string
              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.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/BatchError'
      x-ms-examples:
        NodeCountsPayload:
          $ref: ./examples/AccountListPoolNodeCounts.json
      x-ms-pageable:
        nextLinkName: odata.nextLink
      summary: Microsoft Azure Get Nodecounts
      tags:
      - Nodecounts
definitions:
  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: '#/definitions/BatchNodeCounts'
        description: The number of dedicated Compute Nodes in each state.
      lowPriority:
        $ref: '#/definitions/BatchNodeCounts'
        description: The number of Spot/Low-priority Compute Nodes in each state.
    required:
    - poolId
  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
  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: '#/definitions/BatchPoolNodeCounts'
        x-ms-identifiers: []
      odata.nextLink:
        type: string
        description: The URL to get the next set of results.
  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: '#/definitions/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: '#/definitions/BatchErrorDetail'
        x-ms-identifiers: []
    required:
    - code
  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.
  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.
parameters:
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'