jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.hybrid_data_manager.jobs

Fields

vw_jobs

Name	Datatype	Description
id	text	Id of the object.
name	text	Name of the object.
bytes_processed	text	field from the properties object
dataManagerName	text	field from the properties object
dataServiceName	text	field from the properties object
data_sink_name	text	field from the properties object
data_source_name	text	field from the properties object
details	text	field from the properties object
end_time	text	field from the properties object
error	text	Top level error for the job.
is_cancellable	text	field from the properties object
items_processed	text	field from the properties object
jobDefinitionName	text	field from the properties object
jobId	text	field from the properties object
resourceGroupName	text	field from the properties object
start_time	text	field from the properties object
status	text	Status of the job.
subscriptionId	text	field from the properties object
total_bytes_to_process	text	field from the properties object
total_items_to_process	text	field from the properties object
type	text	Type of the object.

jobs

Name	Datatype	Description
id	string	Id of the object.
name	string	Name of the object.
endTime	string	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	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

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

SELECT examples

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

vw_jobs

SELECT
id,
name,
bytes_processed,
dataManagerName,
dataServiceName,
data_sink_name,
data_source_name,
details,
end_time,
error,
is_cancellable,
items_processed,
jobDefinitionName,
jobId,
resourceGroupName,
start_time,
status,
subscriptionId,
total_bytes_to_process,
total_items_to_process,
type
FROM azure.hybrid_data_manager.vw_jobs
WHERE dataManagerName = '{{ dataManagerName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

jobs

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