@datafire/windows_batch_batchservice v5.0.0

@datafire/windows_batch_batchservice

Client library for BatchService

Installation and Usage

npm install --save @datafire/windows_batch_batchservice

let windows_batch_batchservice = require('@datafire/windows_batch_batchservice').create();

.then(data => {
  console.log(data);
});

Description

A client for issuing REST requests to the Azure Batch service.

Actions

Application_List

This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.

windows_batch_batchservice.Application_List({
  "api-version": ""
}, context)

Input

• input object
  • maxresults integer: The maximum number of items to return in the response. A maximum of 1000 applications can be returned.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output ApplicationListResult

Application_Get

This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.

windows_batch_batchservice.Application_Get({
  "applicationId": "",
  "api-version": ""
}, context)

Input

• input object
  • applicationId required string: The ID of the application.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output ApplicationSummary

Certificate_List

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

windows_batch_batchservice.Certificate_List({
  "api-version": ""
}, context)

Input

• input object
  • $filter string: 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 string: An OData $select clause.
  • maxresults integer: The maximum number of items to return in the response. A maximum of 1000 certificates can be returned.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output CertificateListResult

Certificate_Add

Adds a certificate to the specified account.

windows_batch_batchservice.Certificate_Add({
  "certificate": null,
  "api-version": ""
}, context)

Input

• input object
  • certificate required CertificateAddParameter
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

Output schema unknown

Certificate_Delete

You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.

windows_batch_batchservice.Certificate_Delete({
  "thumbprintAlgorithm": "",
  "thumbprint": "",
  "api-version": ""
}, context)

Input

• input object
  • thumbprintAlgorithm required string: The algorithm used to derive the thumbprint parameter. This must be sha1.
  • thumbprint required string: The thumbprint of the certificate to be deleted.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

Output schema unknown

Certificate_Get

Gets information about the specified certificate.

windows_batch_batchservice.Certificate_Get({
  "thumbprintAlgorithm": "",
  "thumbprint": "",
  "api-version": ""
}, context)

Input

• input object
  • thumbprintAlgorithm required string: The algorithm used to derive the thumbprint parameter. This must be sha1.
  • thumbprint required string: The thumbprint of the certificate to get.
  • $select string: An OData $select clause.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output Certificate

Certificate_CancelDeletion

If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

windows_batch_batchservice.Certificate_CancelDeletion({
  "thumbprintAlgorithm": "",
  "thumbprint": "",
  "api-version": ""
}, context)

Input

• input object
  • thumbprintAlgorithm required string: The algorithm used to derive the thumbprint parameter. This must be sha1.
  • thumbprint required string: The thumbprint of the certificate being deleted.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

Output schema unknown

Job_List

Lists all of the jobs in the specified account.

windows_batch_batchservice.Job_List({
  "api-version": ""
}, context)

Input

• input object
  • $filter string: 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 string: An OData $select clause.
  • $expand string: An OData $expand clause.
  • maxresults integer: The maximum number of items to return in the response. A maximum of 1000 jobs can be returned.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output CloudJobListResult

Job_Add

The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

windows_batch_batchservice.Job_Add({
  "job": null,
  "api-version": ""
}, context)

Input

• input object
  • job required JobAddParameter
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

Output schema unknown

Job_Delete

Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.

windows_batch_batchservice.Job_Delete({
  "jobId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job to delete.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

Job_Get

Gets information about the specified job.

windows_batch_batchservice.Job_Get({
  "jobId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job.
  • $select string: An OData $select clause.
  • $expand string: An OData $expand clause.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

• output CloudJob

Job_Patch

This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.

windows_batch_batchservice.Job_Patch({
  "jobId": "",
  "jobPatchParameter": null,
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job whose properties you want to update.
  • jobPatchParameter required JobPatchParameter
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

Job_Update

This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

windows_batch_batchservice.Job_Update({
  "jobId": "",
  "jobUpdateParameter": null,
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job whose properties you want to update.
  • jobUpdateParameter required JobUpdateParameter
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

Task_AddCollection

Note that each task must have a unique ID. The Batch service may not return the results for each task in the same order the tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same task IDs during a retry so that if the prior operation succeeded, the retry will not create extra tasks unexpectedly. If the response contains any tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only tasks that failed to add, and to omit tasks that were successfully added on the first attempt. The maximum lifetime of a task from addition to completion is 7 days. If a task has not completed within 7 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

windows_batch_batchservice.Task_AddCollection({
  "jobId": "",
  "taskCollection": null,
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job to which the task collection is to be added.
  • taskCollection required TaskAddCollectionParameter
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output TaskAddCollectionResult

Job_Disable

The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

windows_batch_batchservice.Job_Disable({
  "jobId": "",
  "jobDisableParameter": null,
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job to disable.
  • jobDisableParameter required JobDisableParameter
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

Job_Enable

When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 7 days. Therefore, if you enable a job containing active tasks which were added more than 7 days ago, those tasks will not run.

windows_batch_batchservice.Job_Enable({
  "jobId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job to enable.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

Job_ListPreparationAndReleaseTaskStatus

This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

windows_batch_batchservice.Job_ListPreparationAndReleaseTaskStatus({
  "jobId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job.
  • $filter string: 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 string: An OData $select clause.
  • maxresults integer: The maximum number of items to return in the response. A maximum of 1000 tasks can be returned.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output CloudJobListPreparationAndReleaseTaskStatusResult

Job_GetTaskCounts

Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.

windows_batch_batchservice.Job_GetTaskCounts({
  "jobId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output TaskCounts

Task_List

For multi-instance tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary task. Use the list subtasks API to retrieve information about subtasks.

windows_batch_batchservice.Task_List({
  "jobId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job.
  • $filter string: 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 string: An OData $select clause.
  • $expand string: An OData $expand clause.
  • maxresults integer: The maximum number of items to return in the response. A maximum of 1000 tasks can be returned.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output CloudTaskListResult

Task_Add

The maximum lifetime of a task from addition to completion is 7 days. If a task has not completed within 7 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

windows_batch_batchservice.Task_Add({
  "jobId": "",
  "task": null,
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job to which the task is to be added.
  • task required TaskAddParameter
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

Output schema unknown

Task_Delete

When a task is deleted, all of the files in its directory on the compute node where it ran are also deleted (regardless of the retention time). For multi-instance tasks, the delete task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

windows_batch_batchservice.Task_Delete({
  "jobId": "",
  "taskId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job from which to delete the task.
  • taskId required string: The ID of the task to delete.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

Task_Get

For multi-instance tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary task. Use the list subtasks API to retrieve information about subtasks.

windows_batch_batchservice.Task_Get({
  "jobId": "",
  "taskId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job that contains the task.
  • taskId required string: The ID of the task to get information about.
  • $select string: An OData $select clause.
  • $expand string: An OData $expand clause.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

• output CloudTask

Task_Update

Updates the properties of the specified task.

windows_batch_batchservice.Task_Update({
  "jobId": "",
  "taskId": "",
  "taskUpdateParameter": null,
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job containing the task.
  • taskId required string: The ID of the task to update.
  • taskUpdateParameter required TaskUpdateParameter
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

File_ListFromTask

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

windows_batch_batchservice.File_ListFromTask({
  "jobId": "",
  "taskId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job that contains the task.
  • taskId required string: The ID of the task whose files you want to list.
  • $filter string: 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 boolean: 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 integer: The maximum number of items to return in the response. A maximum of 1000 files can be returned.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output NodeFileListResult

File_DeleteFromTask

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

windows_batch_batchservice.File_DeleteFromTask({
  "jobId": "",
  "taskId": "",
  "filePath": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job that contains the task.
  • taskId required string: The ID of the task whose file you want to delete.
  • filePath required string: The path to the task file or directory that you want to delete.
  • recursive boolean: 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 integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

Output schema unknown

File_GetFromTask

Returns the content of the specified task file.

windows_batch_batchservice.File_GetFromTask({
  "jobId": "",
  "taskId": "",
  "filePath": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job that contains the task.
  • taskId required string: The ID of the task whose file you want to retrieve.
  • filePath required string: The path to the task file that you want to get the content of.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
  • If-Modified-Since string: 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 string: 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 required string: Client API Version.

Output

• output object

File_GetPropertiesFromTask

Gets the properties of the specified task file.

windows_batch_batchservice.File_GetPropertiesFromTask({
  "jobId": "",
  "taskId": "",
  "filePath": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job that contains the task.
  • taskId required string: The ID of the task whose file you want to get the properties of.
  • filePath required string: The path to the task file that you want to get the properties of.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

Task_Reactivate

Reactivation makes a task eligible to be retried again up to its maximum retry count. The task's state is changed to active. As the task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a task is reactivated, its retry count is reset to 0. Reactivation will fail for tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the job has completed (or is terminating or deleting).

windows_batch_batchservice.Task_Reactivate({
  "jobId": "",
  "taskId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job containing the task.
  • taskId required string: The ID of the task to reactivate.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

Task_ListSubtasks

If the task is not a multi-instance task then this returns an empty collection.

windows_batch_batchservice.Task_ListSubtasks({
  "jobId": "",
  "taskId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job.
  • taskId required string: The ID of the task.
  • $select string: An OData $select clause.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output CloudTaskListSubtasksResult

Task_Terminate

When the task has been terminated, it moves to the completed state. For multi-instance tasks, the terminate task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

windows_batch_batchservice.Task_Terminate({
  "jobId": "",
  "taskId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job containing the task.
  • taskId required string: The ID of the task to terminate.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

Job_Terminate

When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.

windows_batch_batchservice.Job_Terminate({
  "jobId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobId required string: The ID of the job to terminate.
  • jobTerminateParameter JobTerminateParameter
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

JobSchedule_List

Lists all of the job schedules in the specified account.

windows_batch_batchservice.JobSchedule_List({
  "api-version": ""
}, context)

Input

• input object
  • $filter string: 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 string: An OData $select clause.
  • $expand string: An OData $expand clause.
  • maxresults integer: The maximum number of items to return in the response. A maximum of 1000 job schedules can be returned.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

• output CloudJobScheduleListResult

JobSchedule_Add

Adds a job schedule to the specified account.

windows_batch_batchservice.JobSchedule_Add({
  "cloudJobSchedule": null,
  "api-version": ""
}, context)

Input

• input object
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • cloudJobSchedule required JobScheduleAddParameter
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 required string: Client API Version.

Output

Output schema unknown

JobSchedule_Delete

When you delete a job schedule, this also deletes all jobs and tasks under that schedule. When tasks are deleted, all the files in their working directories on the compute nodes are also deleted (the retention period is ignored). The job schedule statistics are no longer accessible once the job schedule is deleted, though they are still counted towards account lifetime statistics.

windows_batch_batchservice.JobSchedule_Delete({
  "jobScheduleId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobScheduleId required string: The ID of the job schedule to delete.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

JobSchedule_Get

Gets information about the specified job schedule.

windows_batch_batchservice.JobSchedule_Get({
  "jobScheduleId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobScheduleId required string: The ID of the job schedule to get.
  • $select string: An OData $select clause.
  • $expand string: An OData $expand clause.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

• output CloudJobSchedule

JobSchedule_Exists

Checks the specified job schedule exists.

windows_batch_batchservice.JobSchedule_Exists({
  "jobScheduleId": "",
  "api-version": ""
}, context)

Input

• input object
  • jobScheduleId required string: The ID of the job schedule which you want to check.
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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 string: 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 string: 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 string: 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 string: 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 required string: Client API Version.

Output

Output schema unknown

JobSchedule_Patch

This replaces only the job schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.

windows_batch_batchservice.JobSchedule_Patch({
  "jobScheduleId": "",
  "jobSchedulePatchParameter": null,
  "api-version": ""
}, context)

Input

• input object

  • jobScheduleId required string: The ID of the job schedule to update.
  • jobSchedulePatchParameter required JobSchedulePatchParameter
  • timeout integer: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • client-request-id string: 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 boolean: Whether the server should return the client-request-id in the response.
  • ocp-date string: 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.