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

vw_job_definitions

Name	Datatype	Description
id	text	Id of the object.
name	text	Name of the object.
customer_secrets	text	field from the properties object
dataManagerName	text	field from the properties object
dataServiceName	text	field from the properties object
data_service_input	text	field from the properties object
data_sink_id	text	field from the properties object
data_source_id	text	field from the properties object
jobDefinitionName	text	field from the properties object
last_modified_time	text	field from the properties object
resourceGroupName	text	field from the properties object
run_location	text	field from the properties object
schedules	text	field from the properties object
state	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	Type of the object.
user_confirmation	text	field from the properties object

job_definitions

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	dataManagerName, dataServiceName, jobDefinitionName, resourceGroupName, subscriptionId	This method gets job definition object by name.
list_by_data_manager	SELECT	dataManagerName, resourceGroupName, subscriptionId	This method gets all the job definitions of the given data manager resource.
list_by_data_service	SELECT	dataManagerName, dataServiceName, resourceGroupName, subscriptionId	This method gets all the job definitions of the given data service name.
create_or_update	INSERT	dataManagerName, dataServiceName, jobDefinitionName, resourceGroupName, subscriptionId, data__properties	Creates or updates a job definition.
delete	DELETE	dataManagerName, dataServiceName, jobDefinitionName, resourceGroupName, subscriptionId	This method deletes the given job definition.
run	EXEC	dataManagerName, dataServiceName, jobDefinitionName, resourceGroupName, subscriptionId	This method runs a job instance of the given job definition.

SELECT examples

This method gets all the job definitions of the given data manager resource.

vw_job_definitions

SELECT
id,
name,
customer_secrets,
dataManagerName,
dataServiceName,
data_service_input,
data_sink_id,
data_source_id,
jobDefinitionName,
last_modified_time,
resourceGroupName,
run_location,
schedules,
state,
subscriptionId,
type,
user_confirmation
FROM azure.hybrid_data_manager.vw_job_definitions
WHERE dataManagerName = '{{ dataManagerName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

job_definitions

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

INSERT example

Use the following StackQL query and manifest file to create a new job_definitions resource.

All Properties

/*+ create */
INSERT INTO azure.hybrid_data_manager.job_definitions (
dataManagerName,
dataServiceName,
jobDefinitionName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ dataManagerName }}',
'{{ dataServiceName }}',
'{{ jobDefinitionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: id
      value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: dataSourceId
          value: string
        - name: dataSinkId
          value: string
        - name: schedules
          value:
            - - name: name
                value: string
              - name: policyList
                value:
                  - string
        - name: state
          value: string
        - name: lastModifiedTime
          value: string
        - name: runLocation
          value: string
        - name: userConfirmation
          value: string
        - name: dataServiceInput
          value: object
        - name: customerSecrets
          value:
            - - name: keyIdentifier
                value: string
              - name: keyValue
                value: string
              - name: algorithm
                value: string

DELETE example

Deletes the specified job_definitions resource.

/*+ delete */
DELETE FROM azure.hybrid_data_manager.job_definitions
WHERE dataManagerName = '{{ dataManagerName }}'
AND dataServiceName = '{{ dataServiceName }}'
AND jobDefinitionName = '{{ jobDefinitionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';