Microsoft Azure ComputeNodes API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Compute Nodes API
tags:
- name: ComputeNodes
paths:
  /pools/{poolId}/removenodes:
    post:
      tags:
      - ComputeNodes
      operationId: microsoftAzurePoolRemovenodes
      x-ms-examples:
        Pool remove nodes:
          $ref: ./examples/PoolRemoveNodes.json
      summary: Microsoft Azure Removes Compute Nodes From The Specified Pool
      description: This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing. Each request may remove up to 100 nodes.
      x-ms-request-id: request-id
      parameters:
      - name: poolId
        in: path
        required: true
        description: The ID of the Pool from which you want to remove Compute Nodes.
        schema:
          type: string
      - name: timeout
        in: query
        required: false
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        x-ms-client-request-id: true
        schema:
          type: string
          format: uuid
      - name: return-client-request-id
        in: header
        required: false
        description: Whether the server should return the client-request-id in the response.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - name: If-Match
        in: header
        required: false
        description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
      - name: If-None-Match
        in: header
        required: false
        description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
      - name: If-Modified-Since
        in: header
        required: false
        description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - name: If-Unmodified-Since
        in: header
        required: false
        description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          headers:
            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
                format: uuid
            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
                format: uuid
            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-rfc1123
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
          description: The request to the Batch service was successful.
        default:
          description: The error from the Batch service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodeRemoveParameter'
        description: The parameters for the request.
        required: true
  /pools/{poolId}/nodes/{nodeId}/users:
    post:
      tags:
      - ComputeNodes
      operationId: microsoftAzureComputenodeAdduser
      x-ms-examples:
        Node add user:
          $ref: ./examples/NodeAddUser.json
      summary: Microsoft Azure Adds A User Account To The Specified Compute Node
      description: You can add a user Account to a Compute Node only when it is in the idle or running state.
      x-ms-request-id: request-id
      parameters:
      - name: poolId
        in: path
        required: true
        description: The ID of the Pool that contains the Compute Node.
        schema:
          type: string
      - name: nodeId
        in: path
        required: true
        description: The ID of the machine on which you want to create a user Account.
        schema:
          type: string
      - name: timeout
        in: query
        required: false
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        x-ms-client-request-id: true
        schema:
          type: string
          format: uuid
      - name: return-client-request-id
        in: header
        required: false
        description: Whether the server should return the client-request-id in the response.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '201':
          headers:
            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
                format: uuid
            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
                format: uuid
            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-rfc1123
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
          description: The request to the Batch service was successful.
        default:
          description: The error from the Batch service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeNodeUser'
        description: The user Account to be created.
        required: true
  /pools/{poolId}/nodes/{nodeId}/users/{userName}:
    delete:
      tags:
      - ComputeNodes
      operationId: microsoftAzureComputenodeDeleteuser
      x-ms-examples:
        Node delete user:
          $ref: ./examples/NodeDeleteUser.json
      summary: Microsoft Azure Deletes A User Account From The Specified Compute Node
      description: You can delete a user Account to a Compute Node only when it is in the idle or running state.
      x-ms-request-id: request-id
      parameters:
      - name: poolId
        in: path
        required: true
        description: The ID of the Pool that contains the Compute Node.
        schema:
          type: string
      - name: nodeId
        in: path
        required: true
        description: The ID of the machine on which you want to delete a user Account.
        schema:
          type: string
      - name: userName
        in: path
        required: true
        description: The name of the user Account to delete.
        schema:
          type: string
      - name: timeout
        in: query
        required: false
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        x-ms-client-request-id: true
        schema:
          type: string
          format: uuid
      - name: return-client-request-id
        in: header
        required: false
        description: Whether the server should return the client-request-id in the response.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          headers:
            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
          description: The request to the Batch service was successful.
        default:
          description: The error from the Batch service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
    put:
      tags:
      - ComputeNodes
      operationId: microsoftAzureComputenodeUpdateuser
      x-ms-examples:
        Node update user:
          $ref: ./examples/NodeUpdateUser.json
      summary: Microsoft Azure Updates The Password And Expiration Time Of A User Account On The Specified Compute Node
      description: This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state.
      x-ms-request-id: request-id
      parameters:
      - name: poolId
        in: path
        required: true
        description: The ID of the Pool that contains the Compute Node.
        schema:
          type: string
      - name: nodeId
        in: path
        required: true
        description: The ID of the machine on which you want to update a user Account.
        schema:
          type: string
      - name: userName
        in: path
        required: true
        description: The name of the user Account to update.
        schema:
          type: string
      - name: timeout
        in: query
        required: false
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        x-ms-client-request-id: true
        schema:
          type: string
          format: uuid
      - name: return-client-request-id
        in: header
        required: false
        description: Whether the server should return the client-request-id in the response.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          headers:
            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
                format: uuid
            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
                format: uuid
            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-rfc1123
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
          description: The request to the Batch service was successful.
        default:
          description: The error from the Batch service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodeUpdateUserParameter'
        description: The parameters for the request.
        required: true
  /pools/{poolId}/nodes/{nodeId}:
    get:
      tags:
      - ComputeNodes
      operationId: microsoftAzureComputenodeGet
      x-ms-examples:
        Node get:
          $ref: ./examples/NodeGet_Basic.json
      summary: Microsoft Azure Gets Information About The Specified Compute Node
      x-ms-request-id: request-id
      parameters:
      - name: poolId
        in: path
        required: true
        description: The ID of the Pool that contains the Compute Node.
        schema:
          type: string
      - name: nodeId
        in: path
        required: true
        description: The ID of the Compute Node that you want to get information about.
        schema:
          type: string
      - name: $select
        in: query
        required: false
        description: An OData $select clause.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
      - name: timeout
        in: query
        required: false
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        x-ms-client-request-id: true
        schema:
          type: string
          format: uuid
      - name: return-client-request-id
        in: header
        required: false
        description: Whether the server should return the client-request-id in the response.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          headers:
            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
                format: uuid
            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
                format: uuid
            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-rfc1123
          description: A response containing the Compute Node.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeNode'
        default:
          description: The error from the Batch service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      description: Needs a more full description created.
  /pools/{poolId}/nodes/{nodeId}/reboot:
    post:
      tags:
      - ComputeNodes
      operationId: microsoftAzureComputenodeReboot
      x-ms-examples:
        Node reboot:
          $ref: ./examples/NodeReboot.json
      summary: Microsoft Azure Restarts The Specified Compute Node
      description: You can restart a Compute Node only if it is in an idle or running state.
      x-ms-request-id: request-id
      parameters:
      - name: poolId
        in: path
        required: true
        description: The ID of the Pool that contains the Compute Node.
        schema:
          type: string
      - name: nodeId
        in: path
        required: true
        description: The ID of the Compute Node that you want to restart.
        schema:
          type: string
      - name: timeout
        in: query
        required: false
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        x-ms-client-request-id: true
        schema:
          type: string
          format: uuid
      - name: return-client-request-id
        in: header
        required: false
        description: Whether the server should return the client-request-id in the response.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          headers:
            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
                format: uuid
            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
                format: uuid
            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-rfc1123
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
          description: The request to the Batch service was successful.
        default:
          description: The error from the Batch service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodeRebootParameter'
        description: The parameters for the request.
  /pools/{poolId}/nodes/{nodeId}/reimage:
    post:
      tags:
      - ComputeNodes
      operationId: microsoftAzureComputenodeReimage
      x-ms-examples:
        Node reimage:
          $ref: ./examples/NodeReimage.json
      summary: Microsoft Azure Reinstalls The Operating System On The Specified Compute Node
      description: You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property.
      x-ms-request-id: request-id
      parameters:
      - name: poolId
        in: path
        required: true
        description: The ID of the Pool that contains the Compute Node.
        schema:
          type: string
      - name: nodeId
        in: path
        required: true
        description: The ID of the Compute Node that you want to restart.
        schema:
          type: string
      - name: timeout
        in: query
        required: false
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        x-ms-client-request-id: true
        schema:
          type: string
          format: uuid
      - name: return-client-request-id
        in: header
        required: false
        description: Whether the server should return the client-request-id in the response.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          headers:
            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
                format: uuid
            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
                format: uuid
            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-rfc1123
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
          description: The request to the Batch service was successful.
        default:
          description: The error from the Batch service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodeReimageParameter'
        description: The parameters for the request.
  /pools/{poolId}/nodes/{nodeId}/disablescheduling:
    post:
      tags:
      - ComputeNodes
      operationId: microsoftAzureComputenodeDisablescheduling
      x-ms-examples:
        Node disable scheduling:
          $ref: ./examples/NodeDisableScheduling.json
      summary: Microsoft Azure Disables Task Scheduling On The Specified Compute Node
      description: You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.
      x-ms-request-id: request-id
      parameters:
      - name: poolId
        in: path
        required: true
        description: The ID of the Pool that contains the Compute Node.
 

# --- truncated at 32 KB (127 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-computenodes-api-openapi.yml