Microsoft Azure BatchServiceClient — ComputeNodes

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure BatchServiceClient — ComputeNodes
  description: 'Microsoft Azure BatchServiceClient — ComputeNodes. 15 operations. Lead operation: Microsoft Azure Lists The
    Compute Nodes In The Specified Pool. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - ComputeNodes
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: batchserviceclient-computenodes
    baseUri: ''
    description: Microsoft Azure BatchServiceClient — ComputeNodes business capability. Self-contained, no shared references.
    resources:
    - name: pools-poolId-nodes
      path: /pools/{poolId}/nodes
      operations:
      - name: microsoftazurecomputenodelist
        method: GET
        description: Microsoft Azure Lists The Compute Nodes In The Specified Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool from which you want to list Compute Nodes.
          required: true
        - name: $filter
          in: query
          type: string
          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#lis
        - name: $select
          in: query
          type: string
          description: An OData $select clause.
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000 Compute Nodes can be returned.
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId
      path: /pools/{poolId}/nodes/{nodeId}
      operations:
      - name: microsoftazurecomputenodeget
        method: GET
        description: Microsoft Azure Gets Information About The Specified Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the Compute Node that you want to get information about.
          required: true
        - name: $select
          in: query
          type: string
          description: An OData $select clause.
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId-disablescheduling
      path: /pools/{poolId}/nodes/{nodeId}/disablescheduling
      operations:
      - name: microsoftazurecomputenodedisablescheduling
        method: POST
        description: Microsoft Azure Disables Task Scheduling On The Specified Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the Compute Node on which you want to disable Task scheduling.
          required: true
        - name: nodeDisableSchedulingParameter
          in: body
          type: string
          description: The parameters for the request.
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId-enablescheduling
      path: /pools/{poolId}/nodes/{nodeId}/enablescheduling
      operations:
      - name: microsoftazurecomputenodeenablescheduling
        method: POST
        description: Microsoft Azure Enables Task Scheduling On The Specified Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the Compute Node on which you want to enable Task scheduling.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId-extensions
      path: /pools/{poolId}/nodes/{nodeId}/extensions
      operations:
      - name: microsoftazurecomputenodeextensionlist
        method: GET
        description: Microsoft Azure Lists The Compute Nodes Extensions In The Specified Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the Compute Node that you want to list extensions.
          required: true
        - name: $select
          in: query
          type: string
          description: An OData $select clause.
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000 Compute Nodes can be returned.
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId-extensions-extensionName
      path: /pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}
      operations:
      - name: microsoftazurecomputenodeextensionget
        method: GET
        description: Microsoft Azure Gets Information About The Specified Compute Node Extension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the Compute Node that contains the extensions.
          required: true
        - name: extensionName
          in: path
          type: string
          description: The name of the of the Compute Node Extension that you want to get information about.
          required: true
        - name: $select
          in: query
          type: string
          description: An OData $select clause.
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId-rdp
      path: /pools/{poolId}/nodes/{nodeId}/rdp
      operations:
      - name: microsoftazurecomputenodegetremotedesktop
        method: GET
        description: Microsoft Azure Gets The Remote Desktop Protocol File For The Specified Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the Compute Node for which you want to get the Remote Desktop Protocol file.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId-reboot
      path: /pools/{poolId}/nodes/{nodeId}/reboot
      operations:
      - name: microsoftazurecomputenodereboot
        method: POST
        description: Microsoft Azure Restarts The Specified Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the Compute Node that you want to restart.
          required: true
        - name: nodeRebootParameter
          in: body
          type: string
          description: The parameters for the request.
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId-reimage
      path: /pools/{poolId}/nodes/{nodeId}/reimage
      operations:
      - name: microsoftazurecomputenodereimage
        method: POST
        description: Microsoft Azure Reinstalls The Operating System On The Specified Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the Compute Node that you want to restart.
          required: true
        - name: nodeReimageParameter
          in: body
          type: string
          description: The parameters for the request.
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId-remoteloginsettings
      path: /pools/{poolId}/nodes/{nodeId}/remoteloginsettings
      operations:
      - name: microsoftazurecomputenodegetremoteloginsettings
        method: GET
        description: Microsoft Azure Gets The Settings Required For Remote Login To A Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the Compute Node for which to obtain the remote login settings.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId-uploadbatchservicelogs
      path: /pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs
      operations:
      - name: microsoftazurecomputenodeuploadbatchservicelogs
        method: POST
        description: Microsoft Azure Upload Azure Batch Service Log Files From The Specified Compute Node To Azure Blob Storage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the Compute Node from which you want to upload the Azure Batch service log files.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
        - name: uploadBatchServiceLogsConfiguration
          in: body
          type: string
          description: The Azure Batch service log files upload configuration.
          required: true
    - name: pools-poolId-nodes-nodeId-users
      path: /pools/{poolId}/nodes/{nodeId}/users
      operations:
      - name: microsoftazurecomputenodeadduser
        method: POST
        description: Microsoft Azure Adds A User Account To The Specified Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the machine on which you want to create a user Account.
          required: true
        - name: user
          in: body
          type: string
          description: The user Account to be created.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-nodes-nodeId-users-userName
      path: /pools/{poolId}/nodes/{nodeId}/users/{userName}
      operations:
      - name: microsoftazurecomputenodedeleteuser
        method: DELETE
        description: Microsoft Azure Deletes A User Account From The Specified Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the machine on which you want to delete a user Account.
          required: true
        - name: userName
          in: path
          type: string
          description: The name of the user Account to delete.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
      - name: microsoftazurecomputenodeupdateuser
        method: PUT
        description: Microsoft Azure Updates The Password And Expiration Time Of A User Account On The Specified Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool that contains the Compute Node.
          required: true
        - name: nodeId
          in: path
          type: string
          description: The ID of the machine on which you want to update a user Account.
          required: true
        - name: userName
          in: path
          type: string
          description: The name of the user Account to update.
          required: true
        - name: nodeUpdateUserParameter
          in: body
          type: string
          description: The parameters for the request.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-removenodes
      path: /pools/{poolId}/removenodes
      operations:
      - name: microsoftazurepoolremovenodes
        method: POST
        description: Microsoft Azure Removes Compute Nodes From The Specified Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool from which you want to remove Compute Nodes.
          required: true
        - name: nodeRemoveParameter
          in: body
          type: string
          description: The parameters for the request.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
        - name: If-Match
          in: header
          type: string
          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 servic
        - name: If-None-Match
          in: header
          type: string
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
  exposes:
  - type: rest
    namespace: batchserviceclient-computenodes-rest
    port: 8080
    description: REST adapter for Microsoft Azure BatchServiceClient — ComputeNodes. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/pools/{poolid}/nodes
      name: pools-poolid-nodes
      description: REST surface for pools-poolId-nodes.
      operations:
      - method: GET
        name: microsoftazurecomputenodelist
        description: Microsoft Azure Lists The Compute Nodes In The Specified Pool
        call: batchserviceclient-computenodes.microsoftazurecomputenodelist
        with:
          poolId: rest.poolId
          $filter: rest.$filter
          $select: rest.$select
          maxresults: rest.maxresults
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pools/{poolid}/nodes/{nodeid}
      name: pools-poolid-nodes-nodeid
      description: REST surface for pools-poolId-nodes-nodeId.
      operations:
      - method: GET
        name: microsoftazurecomputenodeget
        description: Microsoft Azure Gets Information About The Specified Compute Node
        call: batchserviceclient-computenodes.microsoftazurecomputenodeget
        with:
          poolId: rest.poolId
          nodeId: rest.nodeId
          $select: rest.$select
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pools/{poolid}/nodes/{nodeid}/disablescheduling
      name: pools-poolid-nodes-nodeid-disablescheduling
      description: REST surface for pools-poolId-nodes-nodeId-disablescheduling.
      operations:
      - method: POST
        name: microsoftazurecomputenodedisablescheduling
        description: Microsoft Azure Disables Task Scheduling On The Specified Compute Node
        call: batchserviceclient-computenodes.microsoftazurecomputenodedisablescheduling
        with:
          poolId: rest.poolId
          nodeId: rest.nodeId
          nodeDisableSchedulingParameter: rest.nodeDisableSchedulingParameter
          timeout: rest.timeout
          clie

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/capabilities/batchserviceclient-computenodes.yaml