/applications

Lists all of the applications available in the specified account.

• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 applications can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/applications/{applicationId}

Gets information about the specified application.

• applicationId (path, required) — The ID of the application.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/certificates

Lists all of the certificates that have been added to the specified account.

• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.
• $select (query) — An OData $select clause.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 certificates can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/certificates

Adds a certificate to the specified account.

• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})

Deletes a certificate from the specified account.

• thumbprintAlgorithm (path, required) — The algorithm used to derive the thumbprint parameter. This must be sha1.
• thumbprint (path, required) — The thumbprint of the certificate to be deleted.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})

Gets information about the specified certificate.

• thumbprintAlgorithm (path, required) — The algorithm used to derive the thumbprint parameter. This must be sha1.
• thumbprint (path, required) — The thumbprint of the certificate to get.
• $select (query) — An OData $select clause.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete

Cancels a failed deletion of a certificate from the specified account.

• thumbprintAlgorithm (path, required) — The algorithm used to derive the thumbprint parameter. This must be sha1.
• thumbprint (path, required) — The thumbprint of the certificate being deleted.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs

Lists all of the jobs in the specified account.

• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.
• $select (query) — An OData $select clause.
• $expand (query) — An OData $expand clause.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 jobs can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs

Adds a job to the specified account.

• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs/{jobId}

Deletes a job.

• jobId (path, required) — The ID of the job to delete.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}

Gets information about the specified job.

• jobId (path, required) — The ID of the job.
• $select (query) — An OData $select clause.
• $expand (query) — An OData $expand clause.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}

Updates the properties of the specified job.

• jobId (path, required) — The ID of the job whose properties you want to update.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}

Updates the properties of the specified job.

• jobId (path, required) — The ID of the job whose properties you want to update.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/addtaskcollection

Adds a collection of tasks to the specified job.

• jobId (path, required) — The ID of the job to which the task collection is to be added.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/disable

Disables the specified job, preventing new tasks from running.

• jobId (path, required) — The ID of the job to disable.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/enable

Enables the specified job, allowing new tasks to run.

• jobId (path, required) — The ID of the job to enable.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/jobpreparationandreleasetaskstatus

Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run.

• jobId (path, required) — The ID of the job.
• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
• $select (query) — An OData $select clause.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 tasks can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/taskcounts

Gets the task counts for the specified job.

• jobId (path, required) — The ID of the job.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks

Lists all of the tasks that are associated with the specified job.

• jobId (path, required) — The ID of the job.
• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.
• $select (query) — An OData $select clause.
• $expand (query) — An OData $expand clause.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 tasks can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks

Adds a task to the specified job.

• jobId (path, required) — The ID of the job to which the task is to be added.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks/{taskId}

Deletes a task from the specified job.

• jobId (path, required) — The ID of the job from which to delete the task.
• taskId (path, required) — The ID of the task to delete.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks/{taskId}

Gets information about the specified task.

• jobId (path, required) — The ID of the job that contains the task.
• taskId (path, required) — The ID of the task to get information about.
• $select (query) — An OData $select clause.
• $expand (query) — An OData $expand clause.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks/{taskId}

Updates the properties of the specified task.

• jobId (path, required) — The ID of the job containing the task.
• taskId (path, required) — The ID of the task to update.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks/{taskId}/files

Lists the files in a task's directory on its compute node.

• jobId (path, required) — The ID of the job that contains the task.
• taskId (path, required) — The ID of the task whose files you want to list.
• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.
• recursive (query) — Whether to list children of the task directory. This parameter can be used in combination with the filter parameter to list specific type of files.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 files can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks/{taskId}/files/{filePath}

Deletes the specified task file from the compute node where the task ran.

• jobId (path, required) — The ID of the job that contains the task.
• taskId (path, required) — The ID of the task whose file you want to delete.
• filePath (path, required) — The path to the task file or directory that you want to delete.
• recursive (query) — Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks/{taskId}/files/{filePath}

Returns the content of the specified task file.

• jobId (path, required) — The ID of the job that contains the task.
• taskId (path, required) — The ID of the task whose file you want to retrieve.
• filePath (path, required) — The path to the task file that you want to get the content of.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• ocp-range (header) — The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks/{taskId}/files/{filePath}

Gets the properties of the specified task file.

• jobId (path, required) — The ID of the job that contains the task.
• taskId (path, required) — The ID of the task whose file you want to get the properties of.
• filePath (path, required) — The path to the task file that you want to get the properties of.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks/{taskId}/reactivate

Reactivates a task, allowing it to run again even if its retry count has been exhausted.

• jobId (path, required) — The ID of the job containing the task.
• taskId (path, required) — The ID of the task to reactivate.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks/{taskId}/subtasksinfo

Lists all of the subtasks that are associated with the specified multi-instance task.

• jobId (path, required) — The ID of the job.
• taskId (path, required) — The ID of the task.
• $select (query) — An OData $select clause.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/tasks/{taskId}/terminate

Terminates the specified task.

• jobId (path, required) — The ID of the job containing the task.
• taskId (path, required) — The ID of the task to terminate.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobs/{jobId}/terminate

Terminates the specified job, marking it as completed.

• jobId (path, required) — The ID of the job to terminate.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobschedules

Lists all of the job schedules in the specified account.

• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.
• $select (query) — An OData $select clause.
• $expand (query) — An OData $expand clause.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 job schedules can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobschedules

Adds a job schedule to the specified account.

• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobschedules/{jobScheduleId}

Deletes a job schedule from the specified account.

• jobScheduleId (path, required) — The ID of the job schedule to delete.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobschedules/{jobScheduleId}

Gets information about the specified job schedule.

• jobScheduleId (path, required) — The ID of the job schedule to get.
• $select (query) — An OData $select clause.
• $expand (query) — An OData $expand clause.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobschedules/{jobScheduleId}

Checks the specified job schedule exists.

• jobScheduleId (path, required) — The ID of the job schedule which you want to check.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobschedules/{jobScheduleId}

Updates the properties of the specified job schedule.

• jobScheduleId (path, required) — The ID of the job schedule to update.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobschedules/{jobScheduleId}

Updates the properties of the specified job schedule.

• jobScheduleId (path, required) — The ID of the job schedule to update.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobschedules/{jobScheduleId}/disable

Disables a job schedule.

• jobScheduleId (path, required) — The ID of the job schedule to disable.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobschedules/{jobScheduleId}/enable

Enables a job schedule.

• jobScheduleId (path, required) — The ID of the job schedule to enable.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/jobschedules/{jobScheduleId}/jobs

Lists the jobs that have been created under the specified job schedule.

• jobScheduleId (path, required) — The ID of the job schedule from which you want to get a list of jobs.
• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.
• $select (query) — An OData $select clause.
• $expand (query) — An OData $expand clause.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 jobs can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/jobschedules/{jobScheduleId}/terminate

Terminates a job schedule.

• jobScheduleId (path, required) — The ID of the job schedule to terminates.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/lifetimejobstats

Gets lifetime summary statistics for all of the jobs in the specified account.

• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/lifetimepoolstats

Gets lifetime summary statistics for all of the pools in the specified account.

• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}

Gets information about the specified pool.

• poolId (path, required) — The ID of the pool to get.
• $select (query) — An OData $select clause.
• $expand (query) — An OData $expand clause.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/nodeagentskus

Lists all node agent SKUs supported by the Azure Batch service.

• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-node-agent-skus.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 results will be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/nodecounts

Gets the number of nodes in each state, grouped by pool.

• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.
• maxresults (query, limit) — The maximum number of items to return in the response.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools

Lists all of the pools in the specified account.

• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools.
• $select (query) — An OData $select clause.
• $expand (query) — An OData $expand clause.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 pools can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools

Adds a pool to the specified account.

• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}

Deletes a pool from the specified account.

• poolId (path, required) — The ID of the pool to delete.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/pools/{poolId}

Gets basic properties of a pool.

• poolId (path, required) — The ID of the pool to get.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/pools/{poolId}

Updates the properties of the specified pool.

• poolId (path, required) — The ID of the pool to update.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/pools/{poolId}/disableautoscale

Disables automatic scaling for a pool.

• poolId (path, required) — The ID of the pool on which to disable automatic scaling.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/enableautoscale

Enables automatic scaling for a pool.

• poolId (path, required) — The ID of the pool on which to enable automatic scaling.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/pools/{poolId}/evaluateautoscale

Gets the result of evaluating an automatic scaling formula on the pool.

• poolId (path, required) — The ID of the pool on which to evaluate the automatic scaling formula.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes

Lists the compute nodes in the specified pool.

• poolId (path, required) — The ID of the pool from which you want to list nodes.
• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.
• $select (query) — An OData $select clause.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 nodes can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}

Gets information about the specified compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node that you want to get information about.
• $select (query) — An OData $select clause.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/disablescheduling

Disables task scheduling on the specified compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node on which you want to disable task scheduling.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/enablescheduling

Enables task scheduling on the specified compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node on which you want to enable task scheduling.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/files

Lists all of the files in task directories on the specified compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node whose files you want to list.
• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.
• recursive (query) — Whether to list children of a directory.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 files can be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/reimage

Reinstalls the operating system on the specified compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node that you want to restart.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/files/{filePath}

Deletes the specified file from the compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node from which you want to delete the file.
• filePath (path, required) — The path to the file or directory that you want to delete.
• recursive (query) — Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/files/{filePath}

Returns the content of the specified compute node file.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node that contains the file.
• filePath (path, required) — The path to the compute node file that you want to get the content of.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• ocp-range (header) — The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/files/{filePath}

Gets the properties of the specified compute node file.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node that contains the file.
• filePath (path, required) — The path to the compute node file that you want to get the properties of.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/rdp

Gets the Remote Desktop Protocol file for the specified compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node for which you want to get the Remote Desktop Protocol file.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/reboot

Restarts the specified compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node that you want to restart.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/remoteloginsettings

Gets the settings required for remote login to a compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node for which to obtain the remote login settings.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs

Upload Azure Batch service log files from the specified compute node to Azure Blob Storage.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the compute node from which you want to upload the Azure Batch service log files.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/users

Adds a user account to the specified compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the machine on which you want to create a user account.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/users/{userName}

Deletes a user account from the specified compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the machine on which you want to delete a user account.
• userName (path, required) — The name of the user account to delete.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/nodes/{nodeId}/users/{userName}

Updates the password and expiration time of a user account on the specified compute node.

• poolId (path, required) — The ID of the pool that contains the compute node.
• nodeId (path, required) — The ID of the machine on which you want to update a user account.
• userName (path, required) — The name of the user account to update.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/removenodes

Removes compute nodes from the specified pool.

• poolId (path, required) — The ID of the pool from which you want to remove nodes.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/pools/{poolId}/resize

Changes the number of compute nodes that are assigned to a pool.

• poolId (path, required) — The ID of the pool to resize.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/pools/{poolId}/stopresize

Stops an ongoing resize operation on the pool.

• poolId (path, required) — The ID of the pool whose resizing you want to stop.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/pools/{poolId}/updateproperties

Updates the properties of the specified pool.

• poolId (path, required) — The ID of the pool to update.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.

/pools/{poolId}/upgradeos

Upgrades the operating system of the specified pool.

• poolId (path, required) — The ID of the pool to upgrade.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• If-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
• If-None-Match (header) — An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
• If-Modified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
• If-Unmodified-Since (header) — A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
• api-version (query, required) — Client API Version.

/poolusagemetrics

Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account.

• starttime (query) — The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.
• endtime (query) — The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.
• $filter (query) — An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
• maxresults (query, limit) — The maximum number of items to return in the response. A maximum of 1000 results will be returned.
• timeout (query) — The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
• client-request-id (header) — The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
• return-client-request-id (header) — Whether the server should return the client-request-id in the response.
• ocp-date (header) — The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
• api-version (query, required) — Client API Version.