job_definitions

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

Overview

Name	job_definitions
Type	Resource
Id	azure.storage_mover.job_definitions

Fields

The following fields are returned by SELECT queries:

get

The Job Definition resource.

Name	Datatype	Description
properties	object	Job definition properties.
systemData	object	Resource system metadata.

list

The list of Job Definitions.

Name	Datatype	Description
properties	object	Job definition properties.
systemData	object	Resource system metadata.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, storageMoverName, projectName, jobDefinitionName		Gets a Job Definition resource.
list	select	subscriptionId, resourceGroupName, storageMoverName, projectName		Lists all Job Definitions in a Project.
create_or_update	insert	subscriptionId, resourceGroupName, storageMoverName, projectName, jobDefinitionName, data__properties		Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.
update	update	subscriptionId, resourceGroupName, storageMoverName, projectName, jobDefinitionName		Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.
delete	delete	subscriptionId, resourceGroupName, storageMoverName, projectName, jobDefinitionName		Deletes a Job Definition resource.
start_job	exec	subscriptionId, resourceGroupName, storageMoverName, projectName, jobDefinitionName		Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.
stop_job	exec	subscriptionId, resourceGroupName, storageMoverName, projectName, jobDefinitionName		Requests the Agent of any active instance of this Job Definition to stop.

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
jobDefinitionName	string	The name of the Job Definition resource.
projectName	string	The name of the Project resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
storageMoverName	string	The name of the Storage Mover resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a Job Definition resource.

SELECT
properties,
systemData
FROM azure.storage_mover.job_definitions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageMoverName = '{{ storageMoverName }}' -- required
AND projectName = '{{ projectName }}' -- required
AND jobDefinitionName = '{{ jobDefinitionName }}' -- required
;

list

Lists all Job Definitions in a Project.

SELECT
properties,
systemData
FROM azure.storage_mover.job_definitions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageMoverName = '{{ storageMoverName }}' -- required
AND projectName = '{{ projectName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.

INSERT INTO azure.storage_mover.job_definitions (
data__properties,
subscriptionId,
resourceGroupName,
storageMoverName,
projectName,
jobDefinitionName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ storageMoverName }}',
'{{ projectName }}',
'{{ jobDefinitionName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: job_definitions
  props:
    - 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: storageMoverName
      value: string
      description: Required parameter for the job_definitions resource.
    - name: projectName
      value: string
      description: Required parameter for the job_definitions resource.
    - name: jobDefinitionName
      value: string
      description: Required parameter for the job_definitions resource.
    - name: properties
      value: object
      description: |
        Job definition properties.

UPDATE examples

update

Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.

UPDATE azure.storage_mover.job_definitions
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageMoverName = '{{ storageMoverName }}' --required
AND projectName = '{{ projectName }}' --required
AND jobDefinitionName = '{{ jobDefinitionName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Deletes a Job Definition resource.

DELETE FROM azure.storage_mover.job_definitions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageMoverName = '{{ storageMoverName }}' --required
AND projectName = '{{ projectName }}' --required
AND jobDefinitionName = '{{ jobDefinitionName }}' --required
;

Lifecycle Methods

start_job

Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.

EXEC azure.storage_mover.job_definitions.start_job 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageMoverName='{{ storageMoverName }}' --required, 
@projectName='{{ projectName }}' --required, 
@jobDefinitionName='{{ jobDefinitionName }}' --required
;

stop_job

Requests the Agent of any active instance of this Job Definition to stop.

EXEC azure.storage_mover.job_definitions.stop_job 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageMoverName='{{ storageMoverName }}' --required, 
@projectName='{{ projectName }}' --required, 
@jobDefinitionName='{{ jobDefinitionName }}' --required
;