Sign in

v10

latestSwagger 2.0raw.githubusercontent.com2019-06-25133266.6 KB
Job

Updates the job information for the specified job ID. (Only for use internally with Scope job type.)

patch/jobs/{jobIdentity}

Path parameters

jobIdentitystring uuid required

Job identifier. Uniquely identifies the job across all jobs submitted to the service.

Query parameters

api-versionstring required

Client Api Version.

Request body

degreeOfParallelisminteger

The degree of parallelism used for this job.

degreeOfParallelismPercentnumber double

the degree of parallelism in percentage used for this job.

priorityinteger

The priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0.

tagsobject

The key-value pairs used to add additional metadata to the job information.

Response

Successfully updated the details of the specified job.

jobIdstring uuid

The job's unique identifier (a GUID).

namestring required

The friendly name of the job.

type'USql' | 'Hive' | 'Scope' required

The job type of the current job (Hive, USql, or Scope (for internal use only)).

submitterstring

The user or account that submitted the job.

degreeOfParallelisminteger

The degree of parallelism used for this job.

degreeOfParallelismPercentnumber double

the degree of parallelism in percentage used for this job.

priorityinteger

The priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0.

submitTimestring date-time

The time the job was submitted to the service.

startTimestring date-time

The start time of the job.

endTimestring date-time

The completion time of the job.

state'Accepted' | 'Compiling' | 'Ended' | 'New' | 'Queued' | 'Running' | 'Scheduling' | 'Starting' | 'Paused' | 'WaitingForCapacity' | 'Yielded' | 'Finalizing'

The job state. When the job is in the Ended state, refer to Result and ErrorMessage for details.

result'None' | 'Succeeded' | 'Cancelled' | 'Failed'

The result of job execution or the current result of the running job.

logFolderstring

The log folder path to use in the following format: adl://<accountName>.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/.

logFilePatternsstring[]

The list of log file name patterns to find in the logFolder. '' is the only matching character allowed. Example format: jobExecution.log or mylog.txt

tagsobject

The key-value pairs used to add additional metadata to the job information. (Only for use internally with Scope job type.)

hierarchyQueueNodestring

the name of hierarchy queue node this job is assigned to, Null if job has not been assigned yet or the account doesn't have hierarchy queue.