3.0.0 • Published 7 years ago

@datafire/windows_batch v3.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@datafire/windows_batch

Client library for BatchService

Installation and Usage

npm install --save datafire @datafire/windows_batch
let datafire = require('datafire');
let windows_batch = require('@datafire/windows_batch').create();

windows_batch.Application_List({}).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.Application_List({
  "api-version": ""
}, context)

Parameters

  • 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 (string) required - Client API Version.

Application_Get

Gets information about the specified application.

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

Parameters

  • applicationId (string) required - 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 (string) required - Client API Version.

Certificate_List

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

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

Parameters

  • $filter (string) - An OData $filter clause.
  • $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 (string) required - Client API Version.

Certificate_Add

Adds a certificate to the specified account.

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

Parameters

  • certificate (undefined) required
  • 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 (string) required - Client API Version.

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.Certificate_Delete({
  "thumbprintAlgorithm": "",
  "thumbprint": "",
  "api-version": ""
}, context)

Parameters

  • thumbprintAlgorithm (string) required - The algorithm used to derive the thumbprint parameter. This must be sha1.
  • thumbprint (string) required - 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 (string) required - Client API Version.

Certificate_Get

Gets information about the specified certificate.

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

Parameters

  • thumbprintAlgorithm (string) required - The algorithm used to derive the thumbprint parameter. This must be sha1.
  • thumbprint (string) required - 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 (string) required - Client API Version.

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.Certificate_CancelDeletion({
  "thumbprintAlgorithm": "",
  "thumbprint": "",
  "api-version": ""
}, context)

Parameters

  • thumbprintAlgorithm (string) required - The algorithm used to derive the thumbprint parameter. This must be sha1.
  • thumbprint (string) required - 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 (string) required - Client API Version.

Job_List

Lists all of the jobs in the specified account.

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

Parameters

  • $filter (string) - An OData $filter clause.
  • $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 (string) required - Client API Version.

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.Job_Add({
  "job": null,
  "api-version": ""
}, context)

Parameters

  • job (undefined) required
  • 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 (string) required - Client API Version.

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.

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

Parameters

  • jobId (string) required - 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 (string) required - Client API Version.

Job_Get

Gets information about the specified job.

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

Parameters

  • jobId (string) required - 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 (string) required - Client API Version.

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.Job_Patch({
  "jobId": "",
  "jobPatchParameter": null,
  "api-version": ""
}, context)

Parameters

  • jobId (string) required - The ID of the job whose properties you want to update.
  • jobPatchParameter (undefined) required
  • 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 (string) required - Client API Version.

Job_Update

This fully replaces all the updateable 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.Job_Update({
  "jobId": "",
  "jobUpdateParameter": null,
  "api-version": ""
}, context)

Parameters

  • jobId (string) required - The ID of the job whose properties you want to update.
  • jobUpdateParameter (undefined) required
  • 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 (string) required - Client API Version.

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.

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

Parameters

  • jobId (string) required - The ID of the job to which the task collection is to be added.
  • taskCollection (undefined) required
  • 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 (string) required - Client API Version.

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.Job_Disable({
  "jobId": "",
  "jobDisableParameter": null,
  "api-version": ""
}, context)

Parameters

  • jobId (string) required - The ID of the job to disable.
  • jobDisableParameter (undefined) required
  • 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 (string) required - Client API Version.

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.Job_Enable({
  "jobId": "",
  "api-version": ""
}, context)

Parameters

  • jobId (string) required - 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 (string) required - Client API Version.

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. 

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

Parameters

  • jobId (string) required - The ID of the job.
  • $filter (string) - An OData $filter clause.
  • $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 (string) required - Client API Version.

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.Task_List({
  "jobId": "",
  "api-version": ""
}, context)

Parameters

  • jobId (string) required - The ID of the job.
  • $filter (string) - An OData $filter clause.
  • $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 (string) required - Client API Version.

Task_Add

Adds a task to the specified job.

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

Parameters

  • jobId (string) required - The ID of the job to which the task is to be added.
  • task (undefined) required
  • 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 (string) required - Client API Version.

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.Task_Delete({
  "jobId": "",
  "taskId": "",
  "api-version": ""
}, context)

Parameters

  • jobId (string) required - The ID of the job from which to delete the task.
  • taskId (string) required - 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 (string) required - Client API Version.

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.Task_Get({
  "jobId": "",
  "taskId": "",
  "api-version": ""
}, context)

Parameters

  • jobId (string) required - The ID of the job that contains the task.
  • taskId (string) required - 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 (string) required - Client API Version.

Task_Update

Updates the properties of the specified task.

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

Parameters

  • jobId (string) required - The ID of the job containing the task.
  • taskId (string) required - The ID of the task to update.
  • taskUpdateParameter (undefined) required
  • 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 (string) required - Client API Version.

File_ListFromTask

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

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

Parameters

  • jobId (string) required - The ID of the job that contains the task.
  • taskId (string) required - The ID of the task whose files you want to list.
  • $filter (string) - An OData $filter clause.
  • recursive (boolean) - Whether to list children of a 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 (string) required - Client API Version.

File_DeleteFromTask

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

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

Parameters

  • jobId (string) required - The ID of the job that contains the task.
  • taskId (string) required - The ID of the task whose file you want to delete.
  • filePath (string) required - The path to the task file 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 (string) required - Client API Version.

File_GetFromTask

Returns the content of the specified task file.

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

Parameters

  • jobId (string) required - The ID of the job that contains the task.
  • taskId (string) required - The ID of the task whose file you want to retrieve.
  • filePath (string) required - 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 (string) required - Client API Version.

File_GetPropertiesFromTask

Gets the properties of the specified task file.

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

Parameters

  • jobId (string) required - The ID of the job that contains the task.
  • taskId (string) required - The ID of the task whose file you want to get the properties of.
  • filePath (string) required - 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 (string) required - Client API Version.

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 scheduling error is no longer available after reactivation. This will fail for tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, this will fail if the job has completed (or is terminating or deleting).

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

Parameters

  • jobId (string) required - The ID of the job containing the task.
  • taskId (string) required - 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 (string) required - Client API Version.

Task_ListSubtasks

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

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

Parameters

  • jobId (string) required - The ID of the job.
  • taskId (string) required - 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 (string) required - Client API Version.

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.Task_Terminate({
  "jobId": "",
  "taskId": "",
  "api-version": ""
}, context)

Parameters

  • jobId (string) required - The ID of the job containing the task.
  • taskId (string) required - 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 (string) required - Client API Version.

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 active or running tasks associated with the job, and runs any required Job Release tasks. The job then moves into the completed state.

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

Parameters

  • jobId (string) required - The ID of the job to terminate.
  • jobTerminateParameter (undefined)
  • 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 (string) required - Client API Version.

JobSchedule_List

Lists all of the job schedules in the specified account.

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

Parameters

  • $filter (string) - An OData $filter clause.
  • $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 (string) required - Client API Version.

JobSchedule_Add

Adds a job schedule to the specified account.

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

Parameters

  • timeout (integer) - The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
  • cloudJobSchedule (undefined) required
  • 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 (string) required - Client API Version.

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.JobSchedule_Delete({
  "jobScheduleId": "",
  "api-version": ""
}, context)

Parameters

  • jobScheduleId (string) required - 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 (string) required - Client API Version.

JobSchedule_Get

Gets information about the specified job schedule.

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

Parameters

  • jobScheduleId (string) required - 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 (string) required - Client API Version.

JobSchedule_Exists

Checks the specified job schedule exists.

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

Parameters

  • jobScheduleId (string) required - 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 (string) required - Client API Version.

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.JobSchedule_Patch({
  "jobScheduleId": "",
  "jobSchedulePatchParameter": null,
  "api-version": ""
}, context)

Parameters

  • jobScheduleId (string) required - The ID of the job schedule to update.
  • jobSchedulePatchParameter (undefined) required
  • 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 (string) required - Client API Version.

JobSchedule_Update

This fully replaces all the updateable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove 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.JobSchedule_Update({
  "jobScheduleId": "",
  "jobScheduleUpdateParameter": null,
  "api-version": ""
}, context)

Parameters

  • jobScheduleId (string) required - The ID of the job schedule to update.
  • jobScheduleUpdateParameter (undefined) required
  • 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 (string) required - Client API Version.

JobSchedule_Disable

No new jobs will be created until the job schedule is enabled again.

windows_batch.JobSchedule_Disable({
  "jobScheduleId": "",
  "api-version": ""
}, context)

Parameters

  • jobScheduleId (string) required - The ID of the job schedule to disable.
  • 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 (string) required - Client API Version.

JobSchedule_Enable

Enables a job schedule.

windows_batch.JobSchedule_Enable({
  "jobScheduleId": "",
  "api-version": ""
}, context)

Parameters

  • jobScheduleId (string) required - The ID of the job schedule 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 (string) required - Client API Version.

Job_ListFromJobSchedule

Lists the jobs th

datafire
@infinitebrahmanuniverse/nolb-_datafire_w@everything-registry/sub-chunk-223@zalastax/nolb-_datafire_w
3.0.0

7 years ago

2.0.3

7 years ago

2.0.2

7 years ago

2.0.1

7 years ago

2.0.0

7 years ago