job_definitions

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

Overview

Name	job_definitions
Type	Resource
Id	azure.hybrid_data_manager.job_definitions

Fields

The following fields are returned by SELECT queries:

get

The job definition that matches the criteria.

Name	Datatype	Description
id	string	Id of the object.
name	string	Name of the object.
properties	object	JobDefinition properties.
type	string	Type of the object.

list_by_data_service

The list of job definitions of the given data service type.

Name	Datatype	Description
id	string	Id of the object.
name	string	Name of the object.
properties	object	JobDefinition properties.
type	string	Type of the object.

list_by_data_manager

The list of job definitions in that resource.

Name	Datatype	Description
id	string	Id of the object.
name	string	Name of the object.
properties	object	JobDefinition properties.
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, subscriptionId, resourceGroupName, dataManagerName		This method gets job definition object by name.
list_by_data_service	select	dataServiceName, subscriptionId, resourceGroupName, dataManagerName	$filter	This method gets all the job definitions of the given data service name.
list_by_data_manager	select	subscriptionId, resourceGroupName, dataManagerName	$filter	This method gets all the job definitions of the given data manager resource.
create_or_update	insert	dataServiceName, jobDefinitionName, subscriptionId, resourceGroupName, dataManagerName, data__properties		Creates or updates a job definition.
delete	delete	dataServiceName, jobDefinitionName, subscriptionId, resourceGroupName, dataManagerName		This method deletes the given job definition.
run	exec	dataServiceName, jobDefinitionName, subscriptionId, resourceGroupName, dataManagerName		This method runs a job instance of the given job definition.

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 data service type of the job definition.
jobDefinitionName	string	Name of the job definition.
resourceGroupName	string	The Resource Group Name
subscriptionId	string	The Subscription Id
$filter	string	OData Filter options

SELECT examples

get

This method gets job definition object by name.

SELECT
id,
name,
properties,
type
FROM azure.hybrid_data_manager.job_definitions
WHERE dataServiceName = '{{ dataServiceName }}' -- required
AND jobDefinitionName = '{{ jobDefinitionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerName = '{{ dataManagerName }}' -- required
;

list_by_data_service

This method gets all the job definitions of the given data service name.

SELECT
id,
name,
properties,
type
FROM azure.hybrid_data_manager.job_definitions
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 job definitions of the given data manager resource.

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

INSERT examples

create_or_update

Creates or updates a job definition.

INSERT INTO azure.hybrid_data_manager.job_definitions (
data__properties,
dataServiceName,
jobDefinitionName,
subscriptionId,
resourceGroupName,
dataManagerName
)
SELECT 
'{{ properties }}' /* required */,
'{{ dataServiceName }}',
'{{ jobDefinitionName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dataManagerName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: job_definitions
  props:
    - name: dataServiceName
      value: string
      description: Required parameter for the job_definitions resource.
    - name: jobDefinitionName
      value: string
      description: Required parameter for the job_definitions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the job_definitions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the job_definitions resource.
    - name: dataManagerName
      value: string
      description: Required parameter for the job_definitions resource.
    - name: properties
      value: object
      description: |
        JobDefinition properties.

DELETE examples

delete

This method deletes the given job definition.

DELETE FROM azure.hybrid_data_manager.job_definitions
WHERE dataServiceName = '{{ dataServiceName }}' --required
AND jobDefinitionName = '{{ jobDefinitionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataManagerName = '{{ dataManagerName }}' --required
;

Lifecycle Methods

run

This method runs a job instance of the given job definition.

EXEC azure.hybrid_data_manager.job_definitions.run 
@dataServiceName='{{ dataServiceName }}' --required, 
@jobDefinitionName='{{ jobDefinitionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@dataManagerName='{{ dataManagerName }}' --required 
@@json=
'{
"userConfirmation": "{{ userConfirmation }}", 
"dataServiceInput": "{{ dataServiceInput }}", 
"customerSecrets": "{{ customerSecrets }}"
}'
;