# Azure Batch API

> Azure Batch API on Apizie: 68 endpoints (Lists all of the applications available in the specified Account., Gets information about the specified Application., Lists all of the Jobs in the specified Account., Creates a Job to the specified Account., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:azure-batch-batch/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-batch-batch`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://www.apizie.tech/api/cloud/azure-batch-batch
- OpenAPI: https://www.apizie.tech/api/cloud/azure-batch-batch/openapi.json

Azure Batch provides Cloud-scale job scheduling and compute management.

## Endpoints

### Lists all of the applications available in the specified Account.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/applications-list-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |

### Gets information about the specified Application.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/applications-get-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| applicationId | string | yes | The ID of the Application |

### Lists all of the Jobs in the specified Account.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-list-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |
| $select | array | no | An OData $select clause. |
| $expand | array | no | An OData $expand clause. |

### Creates a Job to the specified Account.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-create-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| body | object | yes | JSON request body |

### Gets information about the specified Job.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-get-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job. |
| $select | array | no | An OData $select clause. |
| $expand | array | no | An OData $expand clause. |

### Updates the properties of the specified Job.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-replace-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job whose properties you want to update. |
| body | object | yes | JSON request body |

### Updates the properties of the specified Job.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-update-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job whose properties you want to update. |
| body | object | yes | JSON request body |

### Deletes a Job.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-delete-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job to delete. |
| force | boolean | no | If true, the server will delete the Job even if the corresponding nodes have not fully processed the deletion. The default value is false. |

### Adds a collection of Tasks to the specified Job.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-create-task-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| jobId | string | yes | The ID of the Job to which the Task collection is to be added. |
| body | object | yes | JSON request body |

### Disables the specified Job, preventing new Tasks from running.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-disable-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job to disable. |
| body | object | yes | JSON request body |

### Enables the specified Job, allowing new Tasks to run.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-enable-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job to enable. |

### Lists the execution status of the Job Preparation and Job Release Task for the specified Job across the…
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-list-job-preparation-and-release-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| jobId | string | yes | The ID of the Job. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |
| $select | array | no | An OData $select clause. |

### Gets the Task counts for the specified Job.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-get-job-task-counts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| jobId | string | yes | The ID of the Job. |

### Lists all of the Tasks that are associated with the specified Job.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-list-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| jobId | string | yes | The ID of the Job. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |
| $select | array | no | An OData $select clause. |
| $expand | array | no | An OData $expand clause. |

### Creates a Task to the specified Job.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-create-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| jobId | string | yes | The ID of the Job to which the Task is to be created. |
| body | object | yes | JSON request body |

### Gets information about the specified Task.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-get-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job that contains the Task. |
| taskId | string | yes | The ID of the Task to get information about. |
| $select | array | no | An OData $select clause. |
| $expand | array | no | An OData $expand clause. |

### Updates the properties of the specified Task.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-replace-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job containing the Task. |
| taskId | string | yes | The ID of the Task to update. |
| body | object | yes | JSON request body |

### Deletes a Task from the specified Job.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-delete-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job from which to delete the Task. |
| taskId | string | yes | The ID of the Task to delete. |

### Lists the files in a Task's directory on its Compute Node.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-list-task-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| jobId | string | yes | The ID of the Job that contains the Task. |
| taskId | string | yes | The ID of the Task whose files you want to list. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |
| recursive | boolean | no | Whether to list children of the Task directory. This parameter can be used in combination with the filter parameter to list specific type… |

### Returns the content of the specified Task file.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-get-task-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| jobId | string | yes | The ID of the Job that contains the Task. |
| taskId | string | yes | The ID of the Task whose file you want to retrieve. |
| filePath | string | yes | The path to the Task file that you want to get the content of. |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| ocp-range | string | no | The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. |

### Deletes the specified Task file from the Compute Node where the Task ran.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-delete-task-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| jobId | string | yes | The ID of the Job that contains the Task. |
| taskId | string | yes | The ID of the Task whose file you want to retrieve. |
| filePath | string | yes | The path to the Task file that you want to get the content of. |
| recursive | boolean | no | Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to… |

### Reactivates a Task, allowing it to run again even if its retry count has been exhausted.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-reactivate-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job containing the Task. |
| taskId | string | yes | The ID of the Task to reactivate. |

### Lists all of the subtasks that are associated with the specified multi-instance Task.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-list-sub-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| jobId | string | yes | The ID of the Job. |
| taskId | string | yes | The ID of the Task. |
| $select | array | no | An OData $select clause. |

### Terminates the specified Task.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/tasks-terminate-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job containing the Task. |
| taskId | string | yes | The ID of the Task to terminate. |

### Terminates the specified Job, marking it as completed.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-terminate-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobId | string | yes | The ID of the Job to terminate. |
| force | boolean | no | If true, the server will terminate the Job even if the corresponding nodes have not fully processed the termination. The default value is… |
| body | object | no | JSON request body |

### Lists all of the Job Schedules in the specified Account.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/job-schedules-list-job-schedules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |
| $select | array | no | An OData $select clause. |
| $expand | array | no | An OData $expand clause. |

### Creates a Job Schedule to the specified Account.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/job-schedules-create-job-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| body | object | yes | JSON request body |

### Gets information about the specified Job Schedule.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/job-schedules-get-job-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobScheduleId | string | yes | The ID of the Job Schedule to get. |
| $select | array | no | An OData $select clause. |
| $expand | array | no | An OData $expand clause. |

### Updates the properties of the specified Job Schedule.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/job-schedules-replace-job-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobScheduleId | string | yes | The ID of the Job Schedule to update. |
| body | object | yes | JSON request body |

### Updates the properties of the specified Job Schedule.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/job-schedules-update-job-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobScheduleId | string | yes | The ID of the Job Schedule to update. |
| body | object | yes | JSON request body |

### Deletes a Job Schedule from the specified Account.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/job-schedules-delete-job-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobScheduleId | string | yes | The ID of the Job Schedule to delete. |
| force | boolean | no | If true, the server will delete the JobSchedule even if the corresponding nodes have not fully processed the deletion. The default value… |

### Disables a Job Schedule.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/job-schedules-disable-job-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobScheduleId | string | yes | The ID of the Job Schedule to disable. |

### Enables a Job Schedule.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/job-schedules-enable-job-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobScheduleId | string | yes | The ID of the Job Schedule to enable. |

### Lists the Jobs that have been created under the specified Job Schedule.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/jobs-list-jobs-from-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| jobScheduleId | string | yes | The ID of the Job Schedule from which you want to get a list of Jobs. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |
| $select | array | no | An OData $select clause. |
| $expand | array | no | An OData $expand clause. |

### Terminates a Job Schedule.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/job-schedules-terminate-job-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| jobScheduleId | string | yes | The ID of the Job Schedule to terminates. |
| force | boolean | no | If true, the server will terminate the JobSchedule even if the corresponding nodes have not fully processed the termination. The default… |

### Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not…
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-list-pool-node-counts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |

### Lists all of the Pools in the specified Account.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-list-pools` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |
| $select | array | no | An OData $select clause. |
| $expand | array | no | An OData $expand clause. |

### Creates a Pool to the specified Account.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-create-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| body | object | yes | JSON request body |

### Gets information about the specified Pool.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-get-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| poolId | string | yes | The ID of the Pool to get. |
| $select | array | no | An OData $select clause. |
| $expand | array | no | An OData $expand clause. |

### Updates the properties of the specified Pool.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-update-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| poolId | string | yes | The ID of the Pool to get. |
| body | object | yes | JSON request body |

### Deletes a Pool from the specified Account.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-delete-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| poolId | string | yes | The ID of the Pool to get. |

### Disables automatic scaling for a Pool.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-disable-pool-auto-scale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool on which to disable automatic scaling. |

### Enables automatic scaling for a Pool.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-enable-pool-auto-scale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| poolId | string | yes | The ID of the Pool to get. |
| body | object | yes | JSON request body |

### Gets the result of evaluating an automatic scaling formula on the Pool.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-evaluate-pool-auto-scale` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool on which to evaluate the automatic scaling formula. |
| body | object | yes | JSON request body |

### Lists the Compute Nodes in the specified Pool.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-list-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| poolId | string | yes | The ID of the Pool from which you want to list Compute Nodes. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |
| $select | array | no | An OData $select clause. |

### Gets information about the specified Compute Node.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-get-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node that you want to get information about. |
| $select | array | no | An OData $select clause. |

### Deallocates the specified Compute Node.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-deallocate-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node that you want to restart. |
| body | object | no | JSON request body |

### Disables Task scheduling on the specified Compute Node.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-disable-node-scheduling` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node on which you want to disable Task scheduling. |
| body | object | no | JSON request body |

### Enables Task scheduling on the specified Compute Node.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-enable-node-scheduling` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node on which you want to enable Task scheduling. |

### Lists the Compute Nodes Extensions in the specified Pool.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-list-node-extensions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| poolId | string | yes | The ID of the Pool that contains Compute Node. |
| nodeId | string | yes | The ID of the Compute Node that you want to list extensions. |
| $select | array | no | An OData $select clause. |

### Gets information about the specified Compute Node Extension.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-get-node-extension` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node that contains the extensions. |
| extensionName | string | yes | The name of the Compute Node Extension that you want to get information about. |
| $select | array | no | An OData $select clause. |

### Lists all of the files in Task directories on the specified Compute Node.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-list-node-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node whose files you want to list. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |
| recursive | boolean | no | Whether to list children of a directory. |

### Returns the content of the specified Compute Node file.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-get-node-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node. |
| filePath | string | yes | The path to the file or directory. |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| ocp-range | string | no | The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. |

### Deletes the specified file from the Compute Node.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-delete-node-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node. |
| filePath | string | yes | The path to the file or directory. |
| recursive | boolean | no | Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to… |

### Restarts the specified Compute Node.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-reboot-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node that you want to restart. |
| body | object | no | JSON request body |

### Reinstalls the operating system on the specified Compute Node.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-reimage-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node that you want to restart. |
| body | object | no | JSON request body |

### Gets the settings required for remote login to a Compute Node.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-get-node-remote-login-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node for which to obtain the remote login settings. |

### Starts the specified Compute Node.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-start-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node that you want to restart. |

### Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-upload-node-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the Compute Node for which you want to get the Remote Desktop Protocol file. |
| body | object | yes | JSON request body |

### Adds a user Account to the specified Compute Node.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-create-node-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the machine on which you want to create a user Account. |
| body | object | yes | JSON request body |

### Updates the password and expiration time of a user Account on the specified Compute Node.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-replace-node-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the machine on which you want to update a user Account. |
| userName | string | yes | The name of the user Account to update. |
| body | object | yes | JSON request body |

### Deletes a user Account from the specified Compute Node.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/nodes-delete-node-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool that contains the Compute Node. |
| nodeId | string | yes | The ID of the machine on which you want to delete a user Account. |
| userName | string | yes | The name of the user Account to delete. |

### Removes Compute Nodes from the specified Pool.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-remove-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| poolId | string | yes | The ID of the Pool to get. |
| body | object | yes | JSON request body |

### Changes the number of Compute Nodes that are assigned to a Pool.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-resize-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| poolId | string | yes | The ID of the Pool to get. |
| body | object | yes | JSON request body |

### Stops an ongoing resize operation on the Pool.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-stop-pool-resize` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| If-Modified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Unmodified-Since | string | no | A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on… |
| If-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| If-None-Match | string | no | An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's… |
| poolId | string | yes | The ID of the Pool to get. |

### Updates the properties of the specified Pool.
`POST https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-replace-pool-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| poolId | string | yes | The ID of the Pool to update. |
| body | object | yes | JSON request body |

### Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-list-pool-usage-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| startTime | string | no | The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this… |
| endtime | string | no | The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to… |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |

### Lists all Virtual Machine Images supported by the Azure Batch service.
`GET https://www.apizie.tech/v1/cloud:azure-batch-batch/pools-list-supported-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com). |
| api-version | string | no | The API version to use for this operation. |
| timeOut | integer | no | 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,… |
| client-request-id | string | no | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.… |
| return-client-request-id | boolean | no | Whether the server should return the client-request-id in the response. |
| ocp-date | string | no | The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are… |
| maxresults | integer | no | The maximum number of items to return in the response. A maximum of 1000 applications can be returned. |
| $filter | string | no | An OData $filter clause. For more information on constructing this filter, see… |

## Example
```
curl "https://www.apizie.tech/v1/cloud:azure-batch-batch/applications-list-applications" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure Batch API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/cloud:azure-batch-batch/applications-list-applications with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure Batch API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure Batch itself also needs your own key from azure.com.

### Can AI agents use the Azure Batch API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-batch-batch.

### What is the status of the Azure Batch API?
Needs your own provider key (bring your own key)