openapi: 3.2.0 info: title: Azure Batch Nodes API version: '2025-06-01' 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: Nodes paths: /pools/{poolId}/nodes: get: operationId: Nodes_ListNodes tags: - Nodes summary: Lists the Compute Nodes in the specified Pool description: Lists the Compute Nodes in the specified Pool. 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 - 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: poolId in: path description: The ID of the Pool from which you want to list Compute Nodes. required: true schema: type: string - name: $filter in: query description: 'An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.' required: false schema: type: string - name: $select in: query description: An OData $select clause. required: false style: form explode: false schema: type: array items: 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/BatchNodeListResult' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node list: $ref: ./examples/Nodes_ListNodes.json x-ms-pageable: nextLinkName: odata.nextLink /pools/{poolId}/nodes/{nodeId}: get: operationId: Nodes_GetNode tags: - Nodes summary: Gets information about the specified Compute Node description: Gets information about the specified Compute Node. 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node that you want to get information about. required: true schema: type: string - name: $select in: query description: An OData $select clause. required: false style: form explode: false schema: type: array items: 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/BatchNode' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node enable scheduling: $ref: ./examples/Nodes_Get_DualStackNetworking.json Node get: $ref: ./examples/Nodes_GetNode.json /pools/{poolId}/nodes/{nodeId}/deallocate: post: operationId: Nodes_DeallocateNode tags: - Nodes summary: Deallocates the specified Compute Node description: You can deallocate a Compute Node only if it is in an idle or running state. 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node that you want to restart. required: true schema: type: string responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node Deallocate: $ref: ./examples/Node_DeallocateNode.json requestBody: content: application/json; odata=minimalmetadata: schema: $ref: '#/components/schemas/BatchNodeDeallocateOptions' description: The options to use for deallocating the Compute Node. /pools/{poolId}/nodes/{nodeId}/disablescheduling: post: operationId: Nodes_DisableNodeScheduling tags: - Nodes summary: 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.' 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node on which you want to disable Task scheduling. required: true schema: type: string responses: '200': description: The request has succeeded. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node disable scheduling: $ref: ./examples/Nodes_DisableNodeScheduling.json requestBody: content: application/json; odata=minimalmetadata: schema: $ref: '#/components/schemas/BatchNodeDisableSchedulingOptions' description: The options to use for disabling scheduling on the Compute Node. /pools/{poolId}/nodes/{nodeId}/enablescheduling: post: operationId: Nodes_EnableNodeScheduling tags: - Nodes summary: Enables Task scheduling on the specified Compute Node description: 'You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled' 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node on which you want to enable Task scheduling. required: true schema: type: string responses: '200': description: The request has succeeded. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node enable scheduling: $ref: ./examples/Nodes_EnableNodeScheduling.json /pools/{poolId}/nodes/{nodeId}/extensions: get: operationId: Nodes_ListNodeExtensions tags: - Nodes summary: Lists the Compute Nodes Extensions in the specified Pool description: Lists the Compute Nodes Extensions in the specified Pool. 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 - 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: poolId in: path description: The ID of the Pool that contains Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node that you want to list extensions. required: true schema: type: string - name: $select in: query description: An OData $select clause. required: false style: form explode: false schema: type: array items: 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/BatchNodeVMExtensionListResult' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: List compute node extensions: $ref: ./examples/Nodes_ListNodeExtensions.json x-ms-pageable: nextLinkName: odata.nextLink /pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}: get: operationId: Nodes_GetNodeExtension tags: - Nodes summary: Gets information about the specified Compute Node Extension description: Gets information about the specified Compute Node Extension. 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node that contains the extensions. required: true schema: type: string - name: extensionName in: path description: The name of the Compute Node Extension that you want to get information about. required: true schema: type: string - name: $select in: query description: An OData $select clause. required: false style: form explode: false schema: type: array items: 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/BatchNodeVMExtension' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Get batch node extension: $ref: ./examples/Nodes_GetNodeExtension.json /pools/{poolId}/nodes/{nodeId}/files: get: operationId: Nodes_ListNodeFiles tags: - Nodes summary: Lists all of the files in Task directories on the specified Compute Node description: Lists all of the files in Task directories on the specified Compute Node. 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node whose files you want to list. required: true schema: type: string - name: $filter in: query description: 'An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.' required: false schema: type: string - name: recursive in: query description: Whether to list children of a directory. required: false schema: type: boolean 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/BatchNodeFileListResult' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: File list from node: $ref: ./examples/Nodes_ListNodeFiles.json x-ms-pageable: nextLinkName: odata.nextLink /pools/{poolId}/nodes/{nodeId}/files/{filePath}: get: operationId: Nodes_GetNodeFile tags: - Nodes description: Returns the content of the specified Compute Node file. 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node. required: true schema: type: string - name: filePath in: path description: The path to the file or directory. required: true schema: type: string - name: If-Modified-Since in: header 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.' required: false x-ms-client-name: ifModifiedSince schema: type: string format: date-time-rfc7231 - name: If-Unmodified-Since in: header 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.' required: false x-ms-client-name: ifUnmodifiedSince schema: type: string format: date-time-rfc7231 - name: ocp-range in: header description: 'The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.' required: false schema: type: string responses: '200': description: The request has succeeded. headers: Content-Length: description: The length of the file. schema: type: string format: int64 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 ocp-batch-file-isdirectory: description: Whether the object represents a directory. schema: type: boolean ocp-batch-file-mode: description: The file mode attribute in octal format. schema: type: string ocp-batch-file-url: description: The URL of the file. schema: type: string ocp-creation-time: description: The file creation time. schema: type: string format: date-time-rfc7231 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/octet-stream: schema: type: string format: binary application/json: schema: type: string format: binary default: description: An unexpected error response. content: application/octet-stream: schema: $ref: '#/components/schemas/BatchError' application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Get File From Compute Node: $ref: ./examples/Nodes_GetNodeFile.json summary: Nodes get node file x-summary-source: derived delete: operationId: Nodes_DeleteNodeFile tags: - Nodes summary: Deletes the specified file from the Compute Node description: Deletes the specified file from the Compute Node. 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node. required: true schema: type: string - name: filePath in: path description: The path to the file or directory. required: true schema: type: string - name: recursive in: query description: 'Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.' required: false schema: type: boolean responses: '200': description: The request has succeeded. 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: File delete from node: $ref: ./examples/Nodes_DeleteNodeFile.json head: operationId: Nodes_GetNodeFileProperties tags: - Nodes description: Gets the properties of the specified Compute Node file. 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node. required: true schema: type: string - name: filePath in: path description: The path to the file or directory. required: true schema: type: string - name: If-Modified-Since in: header 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.' required: false x-ms-client-name: ifModifiedSince schema: type: string format: date-time-rfc7231 - name: If-Unmodified-Since in: header 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.' required: false x-ms-client-name: ifUnmodifiedSince schema: type: string format: date-time-rfc7231 responses: '200': description: The request has succeeded. headers: Content-Length: description: The length of the file. schema: type: string format: int64 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 ocp-batch-file-isdirectory: description: Whether the object represents a directory. schema: type: boolean ocp-batch-file-mode: description: The file mode attribute in octal format. schema: type: string ocp-batch-file-url: description: The URL of the file. schema: type: string ocp-creation-time: description: The file creation time. schema: type: string format: date-time-rfc7231 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: File get properties from node: $ref: ./examples/Nodes_GetNodeFileProperties.json summary: Nodes get node file properties x-summary-source: derived /pools/{poolId}/nodes/{nodeId}/reboot: post: operationId: Nodes_RebootNode tags: - Nodes summary: Restarts the specified Compute Node description: You can restart a Compute Node only if it is in an idle or running state. 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node that you want to restart. required: true schema: type: string responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node reboot: $ref: ./examples/Nodes_RebootNode.json requestBody: content: application/json; odata=minimalmetadata: schema: $ref: '#/components/schemas/BatchNodeRebootOptions' description: The options to use for rebooting the Compute Node. /pools/{poolId}/nodes/{nodeId}/reimage: post: operationId: Nodes_ReimageNode tags: - Nodes summary: 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.' 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node that you want to restart. required: true schema: type: string responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node reimage: $ref: ./examples/Nodes_NodeReimage.json requestBody: content: application/json; odata=minimalmetadata: schema: $ref: '#/components/schemas/BatchNodeReimageOptions' description: The options to use for reimaging the Compute Node. /pools/{poolId}/nodes/{nodeId}/remoteloginsettings: get: operationId: Nodes_GetNodeRemoteLoginSettings tags: - Nodes summary: Gets the settings required for remote login to a Compute Node description: Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node and configure access ports for SSH and RDP. For more information, see https://learn.microsoft.com/azure/batch/pool-endpoint-configuration 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node for which to obtain the remote login settings. required: true 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/BatchNodeRemoteLoginSettings' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Get batch node Dual Stack Networking Remote: $ref: ./examples/Nodes_GetNodeRemoteLoginSettings_DualStackNetworking.json Node get remote login settings: $ref: ./examples/Nodes_GetNodeRemoteLoginSettings.json /pools/{poolId}/nodes/{nodeId}/start: post: operationId: Nodes_StartNode tags: - Nodes summary: Starts the specified Compute Node description: You can start a Compute Node only if it has been deallocated. 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the Compute Node that you want to restart. required: true schema: type: string responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node start: $ref: ./examples/Node_StartNode.json /pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs: post: operationId: Nodes_UploadNodeLogs tags: - Nodes summary: Upload Azure Batch service log files from the specified Compute Node to Azure… description: 'This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service.' 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: 'The ID of the Compute Node for which you want to get the Remote Desktop Protocol file.' required: true 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/UploadBatchServiceLogsResult' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Upload BatchService Logs: $ref: ./examples/Nodes_UploadNodeLogs.json requestBody: content: application/json; odata=minimalmetadata: schema: $ref: '#/components/schemas/UploadBatchServiceLogsOptions' description: The Azure Batch service log files upload options. required: true /pools/{poolId}/nodes/{nodeId}/users: post: operationId: Nodes_CreateNodeUser tags: - Nodes summary: 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. Before you can remotely login to a Compute Node you must configure access ports for SSH and RDP. For more information, see https://learn.microsoft.com/azure/batch/pool-endpoint-configuration' 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the machine on which you want to create a user Account. required: true schema: type: string responses: '201': description: The request has succeeded and a new resource has been created as a result. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node create user: $ref: ./examples/Nodes_CreateNodeUser.json requestBody: content: application/json; odata=minimalmetadata: schema: $ref: '#/components/schemas/BatchNodeUserCreateOptions' description: The options to use for creating the user. required: true /pools/{poolId}/nodes/{nodeId}/users/{userName}: put: operationId: Nodes_ReplaceNodeUser tags: - Nodes summary: Updates the password and expiration time of a user Account on the specified… 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.' 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the machine on which you want to update a user Account. required: true schema: type: string - name: userName in: path description: The name of the user Account to update. required: true schema: type: string responses: '200': description: The request has succeeded. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node update user: $ref: ./examples/Nodes_ReplaceNodeUser.json requestBody: content: application/json; odata=minimalmetadata: schema: $ref: '#/components/schemas/BatchNodeUserUpdateOptions' description: The options to use for updating the user. required: true delete: operationId: Nodes_DeleteNodeUser tags: - Nodes summary: 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. Before you can remotely login to a Compute Node you must configure access ports for SSH and RDP. For more information, see https://learn.microsoft.com/azure/batch/pool-endpoint-configuration' 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 - 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: poolId in: path description: The ID of the Pool that contains the Compute Node. required: true schema: type: string - name: nodeId in: path description: The ID of the machine on which you want to delete a user Account. required: true schema: type: string - name: userName in: path description: The name of the user Account to delete. required: true schema: type: string responses: '200': description: The request has succeeded. 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 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Node delete user: $ref: ./examples/Nodes_DeleteNodeUser.json components: schemas: BatchStartTask: type: object description: 'Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask.' properties: commandLine: type: string description: The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/components/schemas/BatchTaskContainerSettings' description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array description: A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's working directory. items: $ref: '#/components/schemas/ResourceFile' environmentSettings: type: array description: A list of environment variable settings for the StartTask. items: $ref: '#/components/schemas/EnvironmentSetting' userIdentity: $ref: '#/components/schemas/UserIdentity' description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. maxTaskRetryCount: type: integer format: int32 description: The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries). waitForSuccess: type: boolean description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. required: - commandLine 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. BatchNodeError: type: object description: An error encountered by a Compute Node. properties: code: type: string description: An identifier for the Compute Node error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the Compute Node error, intended to be suitable for display in a user interface. errorDetails: type: array description: The list of additional error details related to the Compute Node error. items: $ref: '#/components/schemas/NameValuePair' ContainerHostDataPath: type: string description: The paths which will be mounted to container task's container. enum: - Shared - Startup - VfsMounts - Task - JobPrep - Applications x-ms-enum: name: ContainerHostDataPath modelAsString: true values: - name: Shared value: Shared description: The path for multi-instances task to shared their files. - name: Startup value: Startup description: The path for start task. - name: VfsMounts value: VfsMounts description: The path contains all virtual file systems are mounted on this node. - name: Task value: Task description: The task path. - name: JobPrep value: JobPrep description: The job-prep task path. - name: Applications value: Applications description: The applications path. VMExtensionInstanceView: type: object description: The vm extension instance view. properties: name: type: string description: The name of the vm extension instance view. statuses: type: array description: The resource status information. items: $ref: '#/components/schemas/InstanceViewStatus' subStatuses: type: array description: The resource status information. items: $ref: '#/components/schemas/InstanceViewStatus' BatchNodeVMExtension: type: object description: The configuration for virtual machine extension instance view. properties: provisioningState: type: string description: The provisioning state of the virtual machine extension. vmExtension: $ref: '#/components/schemas/VMExtension' description: The virtual machine extension. instanceView: $ref: '#/components/schemas/VMExtensionInstanceView' description: The vm extension instance view. BatchNodeRebootOptions: type: object description: Parameters for rebooting an Azure Batch Compute Node. properties: nodeRebootOption: $ref: '#/components/schemas/BatchNodeRebootKind' description: When to reboot the Compute Node and what to do with currently running Tasks. The default value is requeue. x-ms-client-name: nodeRebootKind UserIdentity: type: object description: The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both. properties: username: type: string description: The name of the user identity under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. autoUser: $ref: '#/components/schemas/AutoUserSpecification' description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ResourceFile: type: object description: A single file or multiple files to be downloaded to a Compute Node. properties: autoStorageContainerName: type: string description: The storage container name in the auto storage Account. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. storageContainerUrl: type: string format: uri description: 'The URL of the blob container within Azure Blob Storage. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access.' httpUrl: type: string format: uri description: 'The URL of the file to download. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.' blobPrefix: type: string description: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. filePath: type: string description: The location on the Compute Node to which to download the file(s), relative to the Task's working directory. If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..'). fileMode: type: string description: The file permission mode attribute in octal format. This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file. identityReference: $ref: '#/components/schemas/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. FileProperties: type: object description: The properties of a file on a Compute Node. properties: creationTime: type: string format: date-time description: The file creation time. The creation time is not returned for files on Linux Compute Nodes. lastModified: type: string format: date-time description: The time at which the file was last modified. contentLength: type: string format: int64 description: The length of the file. contentType: type: string description: The content type of the file. fileMode: type: string description: The file mode attribute in octal format. The file mode is returned only for files on Linux Compute Nodes. required: - lastModified - contentLength Azure.Core.ipV6Address: type: string description: 'Represent an IP V6 address serialized as a string. It is formatted as eight hex decimal values(16-bit) between 0 and FFFF separated by colon. (i.e. `y:y:y:y:y:y:y:y`)' BatchNode: type: object description: A Compute Node in the Batch service. properties: id: type: string description: The ID of the Compute Node. Every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute Nodes. readOnly: true url: type: string format: uri description: The URL of the Compute Node. readOnly: true state: $ref: '#/components/schemas/BatchNodeState' description: The current state of the Compute Node. readOnly: true schedulingState: $ref: '#/components/schemas/SchedulingState' description: Whether the Compute Node is available for Task scheduling. readOnly: true stateTransitionTime: type: string format: date-time description: The time at which the Compute Node entered its current state. readOnly: true lastBootTime: type: string format: date-time description: The last time at which the Compute Node was started. This property may not be present if the Compute Node state is unusable. readOnly: true allocationTime: type: string format: date-time description: The time at which this Compute Node was allocated to the Pool. This is the time when the Compute Node was initially allocated and doesn't change once set. It is not updated when the Compute Node is service healed or preempted. readOnly: true ipAddress: $ref: '#/components/schemas/Azure.Core.ipV4Address' description: The IP address that other Nodes can use to communicate with this Compute Node. Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new Compute Nodes. readOnly: true ipv6Address: $ref: '#/components/schemas/Azure.Core.ipV6Address' description: The IPv6 address that other Nodes can use to communicate with this Compute Node. Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new Compute Nodes. This property will not be present if the Pool is not configured for IPv6. readOnly: true affinityId: type: string description: An identifier which can be passed when adding a Task to request that the Task be scheduled on this Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere. readOnly: true vmSize: type: string description: The size of the virtual machine hosting the Compute Node. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). readOnly: true totalTasksRun: type: integer format: int32 description: The total number of Job Tasks completed on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. readOnly: true runningTasksCount: type: integer format: int32 description: The total number of currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. readOnly: true runningTaskSlotsCount: type: integer format: int32 description: The total number of scheduling slots used by currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. readOnly: true totalTasksSucceeded: type: integer format: int32 description: The total number of Job Tasks which completed successfully (with exitCode 0) on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. readOnly: true recentTasks: type: array description: A list of Tasks whose state has recently changed. This property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool. items: $ref: '#/components/schemas/BatchTaskInfo' readOnly: true startTask: $ref: '#/components/schemas/BatchStartTask' description: The Task specified to run on the Compute Node as it joins the Pool. readOnly: true startTaskInfo: $ref: '#/components/schemas/BatchStartTaskInfo' description: Runtime information about the execution of the StartTask on the Compute Node. readOnly: true errors: type: array description: The list of errors that are currently being encountered by the Compute Node. items: $ref: '#/components/schemas/BatchNodeError' readOnly: true isDedicated: type: boolean description: Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a Spot/Low-priority Compute Node. readOnly: true endpointConfiguration: $ref: '#/components/schemas/BatchNodeEndpointConfiguration' description: The endpoint configuration for the Compute Node. readOnly: true nodeAgentInfo: $ref: '#/components/schemas/BatchNodeAgentInfo' description: Information about the Compute Node agent version and the time the Compute Node upgraded to a new version. readOnly: true virtualMachineInfo: $ref: '#/components/schemas/VirtualMachineInfo' description: Info about the current state of the virtual machine. readOnly: true required: - id - url - state - stateTransitionTime - lastBootTime - allocationTime - ipAddress - ipv6Address - affinityId - vmSize - totalTasksRun - virtualMachineInfo AutoUserScope: type: string description: AutoUserScope enums enum: - task - pool x-ms-enum: name: AutoUserScope modelAsString: true values: - name: Task value: task description: Specifies that the service should create a new user for the Task. - name: Pool value: pool description: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. BatchTaskState: type: string description: BatchTaskState enums enum: - active - preparing - running - completed x-ms-enum: name: BatchTaskState modelAsString: true values: - name: Active value: active description: The Task is queued and able to run, but is not currently assigned to a Compute Node. A Task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run. - name: Preparing value: preparing description: The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node. - name: Running value: running description: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing. - name: Completed value: completed description: The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated. BatchTaskInfo: type: object description: Information about a Task running on a Compute Node. properties: taskUrl: type: string format: uri description: The URL of the Task. jobId: type: string description: The ID of the Job to which the Task belongs. taskId: type: string description: The ID of the Task. subtaskId: type: integer format: int32 description: The ID of the subtask if the Task is a multi-instance Task. taskState: $ref: '#/components/schemas/BatchTaskState' description: The current state of the Task. executionInfo: $ref: '#/components/schemas/BatchTaskExecutionInfo' description: Information about the execution of the Task. required: - taskState BatchNodeFile: type: object description: Information about a file or directory on a Compute Node. properties: name: type: string description: The file path. url: type: string format: uri description: The URL of the file. isDirectory: type: boolean description: Whether the object represents a directory. properties: $ref: '#/components/schemas/FileProperties' description: The file properties. StatusLevelTypes: type: string description: Level code. enum: - Error - Info - Warning x-ms-enum: name: StatusLevelTypes modelAsString: true values: - name: Error value: Error description: Error - name: Info value: Info description: Info - name: Warning value: Warning description: Warning BatchNodeEndpointConfiguration: type: object description: The endpoint configuration for the Compute Node. properties: inboundEndpoints: type: array description: The list of inbound endpoints that are accessible on the Compute Node. items: $ref: '#/components/schemas/InboundEndpoint' required: - inboundEndpoints ElevationLevel: type: string description: ElevationLevel enums enum: - nonadmin - admin x-ms-enum: name: ElevationLevel modelAsString: true values: - name: NonAdmin value: nonadmin description: The user is a standard user without elevated access. - name: Admin value: admin description: The user is a user with elevated access and operates with full Administrator permissions. 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' InboundEndpoint: type: object description: An inbound endpoint on a Compute Node. properties: name: type: string description: The name of the endpoint. protocol: $ref: '#/components/schemas/InboundEndpointProtocol' description: The protocol of the endpoint. publicIPAddress: $ref: '#/components/schemas/Azure.Core.ipV4Address' description: The public IP address of the Compute Node. x-ms-client-name: publicIpAddress publicFQDN: type: string description: The public fully qualified domain name for the Compute Node. frontendPort: type: integer format: int32 description: The public port number of the endpoint. backendPort: type: integer format: int32 description: The backend port number of the endpoint. required: - name - protocol - publicIPAddress - publicFQDN - frontendPort - backendPort VirtualMachineInfo: type: object description: Info about the current state of the virtual machine. properties: imageReference: $ref: '#/components/schemas/BatchVmImageReference' description: The reference to the Azure Virtual Machine's Marketplace Image. scaleSetVmResourceId: type: string description: The resource ID of the Compute Node's current Virtual Machine Scale Set VM. Only defined if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'. UploadBatchServiceLogsResult: type: object description: The result of uploading Batch service log files from a specific Compute Node. properties: virtualDirectoryName: type: string description: The virtual directory within Azure Blob Storage container to which the Batch Service log file(s) will be uploaded. The virtual directory name is part of the blob name for each log file uploaded, and it is built based poolId, nodeId and a unique identifier. numberOfFilesUploaded: type: integer format: int32 description: The number of log files which will be uploaded. required: - virtualDirectoryName - numberOfFilesUploaded 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. InboundEndpointProtocol: type: string description: InboundEndpointProtocol enums enum: - tcp - udp x-ms-enum: name: InboundEndpointProtocol modelAsString: true values: - name: Tcp value: tcp description: Use TCP for the endpoint. - name: Udp value: udp description: Use UDP for the endpoint. AutoUserSpecification: type: object description: Specifies the options for the auto user that runs an Azure Batch Task. properties: scope: $ref: '#/components/schemas/AutoUserScope' description: The scope for the auto user. The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. elevationLevel: $ref: '#/components/schemas/ElevationLevel' description: The elevation level of the auto user. The default value is nonAdmin. BatchNodeDeallocateOption: type: string description: BatchNodeDeallocateOption enums enum: - requeue - terminate - taskcompletion - retaineddata x-ms-enum: name: BatchNodeDeallocateOption modelAsString: true values: - name: Requeue value: requeue description: Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Deallocate the Compute Node as soon as Tasks have been terminated. - name: Terminate value: terminate description: Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Deallocate the Compute Node as soon as Tasks have been terminated. - name: TaskCompletion value: taskcompletion description: Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Deallocate the Compute Node when all Tasks have completed. - name: RetainedData value: retaineddata description: Deprecated, we encourage you to upload task data to Azure Storage in your task and use `TaskCompletion` instead. Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Deallocate the Compute Node when all Task retention periods have expired. UploadBatchServiceLogsOptions: type: object description: The Azure Batch service log files upload parameters for a Compute Node. properties: containerUrl: type: string format: uri description: The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If a user assigned managed identity is not being used, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified. startTime: type: string format: date-time description: The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. endTime: type: string format: date-time description: The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime. identityReference: $ref: '#/components/schemas/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container. required: - containerUrl - startTime BatchNodeRemoteLoginSettings: type: object description: The remote login settings for a Compute Node. properties: ipv6RemoteLoginIPAddress: $ref: '#/components/schemas/Azure.Core.ipV6Address' description: The IPv6 address used for remote login to the Compute Node. x-ms-client-name: ipv6RemoteLoginIpAddress ipv6RemoteLoginPort: type: integer format: int32 description: The port used for remote login to the Compute Node. remoteLoginIPAddress: $ref: '#/components/schemas/Azure.Core.ipV4Address' description: The IP address used for remote login to the Compute Node. x-ms-client-name: remoteLoginIpAddress remoteLoginPort: type: integer format: int32 description: The port used for remote login to the Compute Node. required: - remoteLoginIPAddress - remoteLoginPort NameValuePair: type: object description: Represents a name-value pair. properties: name: type: string description: The name in the name-value pair. value: type: string description: The value in the name-value pair. BatchNodeDisableSchedulingOptions: type: object description: Parameters for disabling scheduling on an Azure Batch Compute Node. properties: nodeDisableSchedulingOption: $ref: '#/components/schemas/BatchNodeDisableSchedulingOption' description: What to do with currently running Tasks when disabling Task scheduling on the Compute Node. The default value is requeue. BatchTaskContainerSettings: type: object description: The container settings for a Task. properties: containerRunOptions: type: string description: Additional options to the container create command. These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. imageName: type: string description: The Image to use to create the container in which the Task will run. This is the full Image reference, as would be specified to "docker pull". If no tag is provided as part of the Image name, the tag ":latest" is used as a default. registry: $ref: '#/components/schemas/ContainerRegistryReference' description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. workingDirectory: $ref: '#/components/schemas/ContainerWorkingDirectory' description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. containerHostBatchBindMounts: type: array description: The paths you want to mounted to container task. If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. items: $ref: '#/components/schemas/ContainerHostBatchBindMountEntry' required: - imageName BatchStartTaskState: type: string description: BatchStartTaskState enums enum: - running - completed x-ms-enum: name: BatchStartTaskState modelAsString: true values: - name: Running value: running description: The StartTask is currently running. - name: Completed value: completed description: The StartTask has exited with exit code 0, or the StartTask has failed and the retry limit has reached, or the StartTask process did not run due to Task preparation errors (such as resource file download failures). ContainerRegistryReference: type: object description: A private container registry. properties: username: type: string description: The user name to log into the registry server. password: type: string format: password description: The password to log into the registry server. x-ms-secret: true registryServer: type: string format: uri description: The registry URL. If omitted, the default is "docker.io". identityReference: $ref: '#/components/schemas/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. BatchNodeDeallocateOptions: type: object description: Options for deallocating a Compute Node. properties: nodeDeallocateOption: $ref: '#/components/schemas/BatchNodeDeallocateOption' description: When to deallocate the Compute Node and what to do with currently running Tasks. The default value is requeue. BatchNodeIdentityReference: type: object description: 'The reference to a user assigned identity associated with the Batch pool which a compute node will use.' properties: resourceId: type: string format: arm-id description: The ARM resource id of the user assigned identity. Azure.Core.ipV4Address: type: string description: 'Represent an IP V4 address serialized as a string. It is formatted as four 8-bit fields separated by periods.' BatchNodeVMExtensionListResult: type: object description: The result of listing the Compute Node extensions in a Node. properties: value: type: array description: The list of Compute Node extensions. items: $ref: '#/components/schemas/BatchNodeVMExtension' odata.nextLink: type: string format: uri description: The URL to get the next set of results. BatchTaskFailureInfo: type: object description: Information about a Task failure. properties: category: $ref: '#/components/schemas/BatchErrorSourceCategory' description: The category of the Task error. code: type: string description: An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the Task error, intended to be suitable for display in a user interface. details: type: array description: A list of additional details related to the error. items: $ref: '#/components/schemas/NameValuePair' required: - category BatchNodeUserUpdateOptions: type: object description: Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node. properties: password: type: string format: password description: The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed. x-ms-secret: true expiryTime: type: string format: date-time description: The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day. sshPublicKey: type: string description: The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key is removed. BatchVmImageReference: type: object description: 'A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the '' List Supported Images '' operation.' properties: publisher: type: string description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. offer: type: string description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. sku: type: string description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. version: type: string description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. virtualMachineImageId: type: string format: arm-id description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. exactVersion: type: string description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. readOnly: true sharedGalleryImageId: type: string description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. communityGalleryImageId: type: string description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. BatchNodeAgentInfo: type: object description: 'The Batch Compute Node agent is a program that runs on each Compute Node in the Pool and provides Batch capability on the Compute Node.' properties: version: type: string description: The version of the Batch Compute Node agent running on the Compute Node. This version number can be checked against the Compute Node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. lastUpdateTime: type: string format: date-time description: The time when the Compute Node agent was updated on the Compute Node. This is the most recent time that the Compute Node agent was updated to a new version. required: - version - lastUpdateTime BatchNodeListResult: type: object description: The result of listing the Compute Nodes in a Pool. properties: value: type: array description: The list of Compute Nodes. items: $ref: '#/components/schemas/BatchNode' odata.nextLink: type: string format: uri description: The URL to get the next set of results. BatchErrorSourceCategory: type: string description: BatchErrorSourceCategory enums enum: - usererror - servererror x-ms-enum: name: BatchErrorSourceCategory modelAsString: true values: - name: UserError value: usererror description: The error is due to a user issue, such as misconfiguration. - name: ServerError value: servererror description: The error is due to an internal server issue. BatchNodeDisableSchedulingOption: type: string description: BatchNodeDisableSchedulingOption enums enum: - requeue - terminate - taskcompletion x-ms-enum: name: BatchNodeDisableSchedulingOption modelAsString: true values: - name: Requeue value: requeue description: Terminate running Task processes and requeue the Tasks. The Tasks may run again on other Compute Nodes, or when Task scheduling is re-enabled on this Compute Node. Enter offline state as soon as Tasks have been terminated. - name: Terminate value: terminate description: Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as Tasks have been terminated. - name: TaskCompletion value: taskcompletion description: Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Enter offline state when all Tasks have completed. VMExtension: type: object description: The configuration for virtual machine extensions. properties: name: type: string description: The name of the virtual machine extension. publisher: type: string description: The name of the extension handler publisher. type: type: string description: The type of the extension. typeHandlerVersion: type: string description: The version of script handler. autoUpgradeMinorVersion: type: boolean description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. enableAutomaticUpgrade: type: boolean description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. settings: type: object description: JSON formatted public settings for the extension. additionalProperties: type: string protectedSettings: type: object description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. additionalProperties: type: string provisionAfterExtensions: type: array description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. items: type: string required: - name - publisher - type BatchNodeState: type: string description: BatchNodeState enums enum: - idle - rebooting - reimaging - running - unusable - creating - starting - waitingforstarttask - starttaskfailed - unknown - leavingpool - offline - preempted - upgradingos - deallocated - deallocating x-ms-enum: name: BatchNodeState modelAsString: true values: - name: Idle value: idle description: The Compute Node is not currently running a Task. - name: Rebooting value: rebooting description: The Compute Node is rebooting. - name: Reimaging value: reimaging description: The Compute Node is reimaging. - name: Running value: running description: The Compute Node is running one or more Tasks (other than a StartTask). - name: Unusable value: unusable description: The Compute Node cannot be used for Task execution due to errors. - name: Creating value: creating description: The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the Pool. - name: Starting value: starting description: The Batch service is starting on the underlying virtual machine. - name: WaitingForStartTask value: waitingforstarttask description: The StartTask has started running on the Compute Node, but waitForSuccess is set and the StartTask has not yet completed. - name: StartTaskFailed value: starttaskfailed description: The StartTask has failed on the Compute Node (and exhausted all retries), and waitForSuccess is set. The Compute Node is not usable for running Tasks. - name: Unknown value: unknown description: The Batch service has lost contact with the Compute Node, and does not know its true state. - name: LeavingPool value: leavingpool description: The Compute Node is leaving the Pool, either because the user explicitly removed it or because the Pool is resizing or autoscaling down. - name: Offline value: offline description: The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is disabled. - name: Preempted value: preempted description: The Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available. - name: UpgradingOS value: upgradingos description: The Compute Node is undergoing an OS upgrade operation. - name: Deallocated value: deallocated description: The Compute Node is deallocated. - name: Deallocating value: deallocating description: The Compute Node is deallocating. BatchTaskExecutionInfo: type: object description: Information about the execution of a Task. properties: startTime: type: string format: date-time description: The time at which the Task started running. 'Running' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. If the Task has been restarted or retried, this is the most recent time at which the Task started running. This property is present only for Tasks that are in the running or completed state. endTime: type: string format: date-time description: The time at which the Task completed. This property is set only if the Task is in the Completed state. exitCode: type: integer format: int32 description: The exit code of the program specified on the Task command line. This property is set only if the Task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the Task (due to timeout, or user termination via the API) you may see an operating system-defined exit code. containerInfo: $ref: '#/components/schemas/BatchTaskContainerExecutionInfo' description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. failureInfo: $ref: '#/components/schemas/BatchTaskFailureInfo' description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. retryCount: type: integer format: int32 description: The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. lastRetryTime: type: string format: date-time description: The most recent time at which a retry of the Task started running. This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. requeueCount: type: integer format: int32 description: The number of times the Task has been requeued by the Batch service as the result of a user request. When the user removes Compute Nodes from a Pool (by resizing/shrinking the pool) or when the Job is being disabled, the user can specify that running Tasks on the Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons. lastRequeueTime: type: string format: date-time description: The most recent time at which the Task has been requeued by the Batch service as the result of a user request. This property is set only if the requeueCount is nonzero. result: $ref: '#/components/schemas/BatchTaskExecutionResult' description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. required: - retryCount - requeueCount ContainerHostBatchBindMountEntry: type: object description: The entry of path and mount mode you want to mount into task container. properties: source: $ref: '#/components/schemas/ContainerHostDataPath' description: The path which be mounted to container customer can select. isReadOnly: type: boolean description: Mount this source path as read-only mode or not. Default value is false (read/write mode). For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. BatchNodeRebootKind: type: string description: BatchNodeRebootKind enums enum: - requeue - terminate - taskcompletion - retaineddata x-ms-enum: name: BatchNodeRebootKind modelAsString: true values: - name: Requeue value: requeue description: Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Restart the Compute Node as soon as Tasks have been terminated. - name: Terminate value: terminate description: Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Restart the Compute Node as soon as Tasks have been terminated. - name: TaskCompletion value: taskcompletion description: Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Restart the Compute Node when all Tasks have completed. - name: RetainedData value: retaineddata description: Deprecated, we encourage you to upload task data to Azure Storage in your task and use `TaskCompletion` instead. Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Restart the Compute Node when all Task retention periods have expired. ContainerWorkingDirectory: type: string description: ContainerWorkingDirectory enums enum: - taskWorkingDirectory - containerImageDefault x-ms-enum: name: ContainerWorkingDirectory modelAsString: true values: - name: TaskWorkingDirectory value: taskWorkingDirectory description: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. - name: ContainerImageDefault value: containerImageDefault description: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. BatchStartTaskInfo: type: object description: Information about a StartTask running on a Compute Node. properties: state: $ref: '#/components/schemas/BatchStartTaskState' description: The state of the StartTask on the Compute Node. startTime: type: string format: date-time description: The time at which the StartTask started running. This value is reset every time the Task is restarted or retried (that is, this is the most recent time at which the StartTask started running). endTime: type: string format: date-time description: The time at which the StartTask stopped running. This is the end time of the most recent run of the StartTask, if that run has completed (even if that run failed and a retry is pending). This element is not present if the StartTask is currently running. exitCode: type: integer format: int32 description: The exit code of the program specified on the StartTask command line. This property is set only if the StartTask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the StartTask (due to timeout, or user termination via the API) you may see an operating system-defined exit code. containerInfo: $ref: '#/components/schemas/BatchTaskContainerExecutionInfo' description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. failureInfo: $ref: '#/components/schemas/BatchTaskFailureInfo' description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. retryCount: type: integer format: int32 description: The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. lastRetryTime: type: string format: date-time description: The most recent time at which a retry of the Task started running. This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. result: $ref: '#/components/schemas/BatchTaskExecutionResult' description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. required: - state - startTime - retryCount SchedulingState: type: string description: SchedulingState enums enum: - enabled - disabled x-ms-enum: name: SchedulingState modelAsString: true values: - name: Enabled value: enabled description: Tasks can be scheduled on the Compute Node. - name: Disabled value: disabled description: No new Tasks will be scheduled on the Compute Node. Tasks already running on the Compute Node may still run to completion. All Compute Nodes start with scheduling enabled. BatchNodeUserCreateOptions: type: object description: Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node. properties: name: type: string description: The user name of the Account. isAdmin: type: boolean description: Whether the Account should be an administrator on the Compute Node. The default value is false. expiryTime: type: string format: date-time description: The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day. password: type: string format: password description: The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. x-ms-secret: true sshPublicKey: type: string description: The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). required: - name BatchTaskContainerExecutionInfo: type: object description: Contains information about the container which a Task is executing. properties: containerId: type: string description: The ID of the container. state: type: string description: The state of the container. This is the state of the container according to the Docker service. It is equivalent to the status field returned by "docker inspect". error: type: string description: Detailed error information about the container. This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by "docker inspect". EnvironmentSetting: type: object description: An environment variable to be set on a Task process. properties: name: type: string description: The name of the environment variable. value: type: string description: The value of the environment variable. required: - name InstanceViewStatus: type: object description: The instance view status. properties: code: type: string description: The status code. displayStatus: type: string description: The localized label for the status. level: $ref: '#/components/schemas/StatusLevelTypes' description: Level code. message: type: string description: The detailed status message. time: type: string format: date-time description: The time of the status. BatchNodeFileListResult: type: object description: 'The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node.' properties: value: type: array description: The list of files. items: $ref: '#/components/schemas/BatchNodeFile' odata.nextLink: type: string format: uri description: The URL to get the next set of results. BatchNodeReimageOption: type: string description: BatchNodeReimageOption enums enum: - requeue - terminate - taskcompletion - retaineddata x-ms-enum: name: BatchNodeReimageOption modelAsString: true values: - name: Requeue value: requeue description: Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Reimage the Compute Node as soon as Tasks have been terminated. - name: Terminate value: terminate description: Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Reimage the Compute Node as soon as Tasks have been terminated. - name: TaskCompletion value: taskcompletion description: Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Reimage the Compute Node when all Tasks have completed. - name: RetainedData value: retaineddata description: Deprecated, we encourage you to upload task data to Azure Storage in your task and use `TaskCompletion` instead. Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Reimage the Compute Node when all Task retention periods have expired. BatchTaskExecutionResult: type: string description: BatchTaskExecutionResult enums enum: - success - failure x-ms-enum: name: BatchTaskExecutionResult modelAsString: true values: - name: Success value: success description: The Task ran successfully. - name: Failure value: failure description: There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited. BatchNodeReimageOptions: type: object description: Parameters for reimaging an Azure Batch Compute Node. properties: nodeReimageOption: $ref: '#/components/schemas/BatchNodeReimageOption' description: When to reimage the Compute Node and what to do with currently running Tasks. The default value is requeue. 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