jobs

Creates, updates, deletes, gets or lists a jobs resource.

Overview

Name	jobs
Type	Resource
Id	azure.hybrid_data_manager.jobs

Fields

The following fields are returned by SELECT queries:

get

The job that matches the given criteria.

Name	Datatype	Description
id	string	Id of the object.
name	string	Name of the object.
endTime	string (date-time)	Time at which the job ended in UTC ISO 8601 format.
error	object	Top level error for the job.
properties	object	Job properties.
startTime	string (date-time)	Time at which the job was started in UTC ISO 8601 format.
status	string	Status of the job.
type	string	Type of the object.

list_by_job_definition

The list of jobs.

Name	Datatype	Description
id	string	Id of the object.
name	string	Name of the object.
endTime	string (date-time)	Time at which the job ended in UTC ISO 8601 format.
error	object	Top level error for the job.
properties	object	Job properties.
startTime	string (date-time)	Time at which the job was started in UTC ISO 8601 format.
status	string	Status of the job.
type	string	Type of the object.

list_by_data_service

The list of jobs that match the service and resource.

Name	Datatype	Description
id	string	Id of the object.
name	string	Name of the object.
endTime	string (date-time)	Time at which the job ended in UTC ISO 8601 format.
error	object	Top level error for the job.
properties	object	Job properties.
startTime	string (date-time)	Time at which the job was started in UTC ISO 8601 format.
status	string	Status of the job.
type	string	Type of the object.

list_by_data_manager

The list of jobs in the resource specified.

Name	Datatype	Description
id	string	Id of the object.
name	string	Name of the object.
endTime	string (date-time)	Time at which the job ended in UTC ISO 8601 format.
error	object	Top level error for the job.
properties	object	Job properties.
startTime	string (date-time)	Time at which the job was started in UTC ISO 8601 format.
status	string	Status of the job.
type	string	Type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	dataServiceName, jobDefinitionName, jobId, subscriptionId, resourceGroupName, dataManagerName	$expand	This method gets a data manager job given the jobId.
list_by_job_definition	select	dataServiceName, jobDefinitionName, subscriptionId, resourceGroupName, dataManagerName	$filter	This method gets all the jobs of a given job definition.
list_by_data_service	select	dataServiceName, subscriptionId, resourceGroupName, dataManagerName	$filter	This method gets all the jobs of a data service type in a given resource.
list_by_data_manager	select	subscriptionId, resourceGroupName, dataManagerName	$filter	This method gets all the jobs at the data manager resource level.
cancel	exec	dataServiceName, jobDefinitionName, jobId, subscriptionId, resourceGroupName, dataManagerName		Cancels the given job.
resume	exec	dataServiceName, jobDefinitionName, jobId, subscriptionId, resourceGroupName, dataManagerName		Resumes the given job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dataManagerName	string	The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
dataServiceName	string	The name of the data service of the job definition.
jobDefinitionName	string	The name of the job definition of the job.
jobId	string	The job id of the job queried.
resourceGroupName	string	The Resource Group Name
subscriptionId	string	The Subscription Id
$expand	string	$expand is supported on details parameter for job, which provides details on the job stages.
$filter	string	OData Filter options

SELECT examples

get

This method gets a data manager job given the jobId.

SELECT
id,
name,
endTime,
error,
properties,
startTime,
status,
type
FROM azure.hybrid_data_manager.jobs
WHERE dataServiceName = '{{ dataServiceName }}' -- required
AND jobDefinitionName = '{{ jobDefinitionName }}' -- required
AND jobId = '{{ jobId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerName = '{{ dataManagerName }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_job_definition

This method gets all the jobs of a given job definition.

SELECT
id,
name,
endTime,
error,
properties,
startTime,
status,
type
FROM azure.hybrid_data_manager.jobs
WHERE dataServiceName = '{{ dataServiceName }}' -- required
AND jobDefinitionName = '{{ jobDefinitionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerName = '{{ dataManagerName }}' -- required
AND $filter = '{{ $filter }}'
;

list_by_data_service

This method gets all the jobs of a data service type in a given resource.

SELECT
id,
name,
endTime,
error,
properties,
startTime,
status,
type
FROM azure.hybrid_data_manager.jobs
WHERE dataServiceName = '{{ dataServiceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerName = '{{ dataManagerName }}' -- required
AND $filter = '{{ $filter }}'
;

list_by_data_manager

This method gets all the jobs at the data manager resource level.

SELECT
id,
name,
endTime,
error,
properties,
startTime,
status,
type
FROM azure.hybrid_data_manager.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerName = '{{ dataManagerName }}' -- required
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

cancel

Cancels the given job.

EXEC azure.hybrid_data_manager.jobs.cancel 
@dataServiceName='{{ dataServiceName }}' --required, 
@jobDefinitionName='{{ jobDefinitionName }}' --required, 
@jobId='{{ jobId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@dataManagerName='{{ dataManagerName }}' --required
;

resume

Resumes the given job.

EXEC azure.hybrid_data_manager.jobs.resume 
@dataServiceName='{{ dataServiceName }}' --required, 
@jobDefinitionName='{{ jobDefinitionName }}' --required, 
@jobId='{{ jobId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@dataManagerName='{{ dataManagerName }}' --required
;