Microsoft Azure Poolusagemetrics API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Batch Poolusagemetrics API
  version: 2024-02-01.19.0
  description: Azure Batch provides Cloud-scale job scheduling and compute management.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
  - https://batch.core.windows.net//.default
tags:
- name: Poolusagemetrics
paths:
  /poolusagemetrics:
    get:
      operationId: microsoftAzureBatchListpoolusagemetrics
      summary: Microsoft Azure Lists The Usage Metrics, Aggregated By Pool Across Individual…
      description: 'If you do not specify a $filter clause including a poolId, the response

        includes all Pools that existed in the Account in the time range of the

        returned aggregation intervals. If you do not specify a $filter clause

        including a startTime or endTime these filters default to the start and end

        times of the last aggregation interval currently available; that is, only the

        last aggregation interval is returned.'
      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: startTime
        in: query
        description: 'The earliest time from which to include metrics. This must be at least two and

          a half hours before the current time. If not specified this defaults to the

          start time of the last aggregation interval currently available.'
        required: false
        schema:
          type: string
          format: date-time
      - name: endtime
        in: query
        description: 'The latest time from which to include metrics. This must be at least two hours

          before the current time. If not specified this defaults to the end time of the

          last aggregation interval currently available.'
        required: false
        schema:
          type: string
          format: date-time
      - 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-account-usage-metrics.'
        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/BatchPoolListUsageMetricsResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Pool list usage metrics:
          $ref: ./examples/PoolListUsageMetrics.json
      x-ms-pageable:
        nextLinkName: odata.nextLink
      tags:
      - Poolusagemetrics
components:
  schemas:
    BatchPoolUsageMetrics:
      type: object
      description: Usage metrics for a Pool across an aggregation interval.
      properties:
        poolId:
          type: string
          description: The ID of the Pool whose metrics are aggregated in this entry.
        startTime:
          type: string
          format: date-time
          description: The start time of the aggregation interval covered by this entry.
        endTime:
          type: string
          format: date-time
          description: The end time of the aggregation interval covered by this entry.
        vmSize:
          type: string
          description: The size of virtual machines in the Pool. All VMs in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
        totalCoreHours:
          type: number
          format: float
          description: The total core hours used in the Pool during this aggregation interval.
      required:
      - poolId
      - startTime
      - endTime
      - vmSize
      - totalCoreHours
    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.
    BatchPoolListUsageMetricsResult:
      type: object
      description: The result of a listing the usage metrics for an Account.
      properties:
        value:
          type: array
          description: The Pool usage metrics data.
          items:
            $ref: '#/components/schemas/BatchPoolUsageMetrics'
          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: '#/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
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://batch.core.windows.net//.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: 'Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).'
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true