data_transfer_jobs

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

Overview

Name	data_transfer_jobs
Type	Resource
Id	azure.cosmos_db.data_transfer_jobs

Fields

The following fields are returned by SELECT queries:

get

The Data Transfer Job Properties retrieved successfully

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	The properties of a DataTransfer Job
type	string	The type of Azure resource.

list_by_database_account

All Data Transfer Jobs retrieved successfully

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	The properties of a DataTransfer Job
type	string	The type of Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, jobName		Get a Data Transfer Job.
list_by_database_account	select	subscriptionId, resourceGroupName, accountName		Get a list of Data Transfer jobs.
create	insert	subscriptionId, resourceGroupName, accountName, jobName, data__properties		Creates a Data Transfer Job.
pause	exec	subscriptionId, resourceGroupName, accountName, jobName		Pause a Data Transfer Job.
resume	exec	subscriptionId, resourceGroupName, accountName, jobName		Resumes a Data Transfer Job.
cancel	exec	subscriptionId, resourceGroupName, accountName, jobName		Cancels a Data Transfer Job.
complete	exec	subscriptionId, resourceGroupName, accountName, jobName		Completes a Data Transfer Online 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
accountName	string	Cosmos DB database account name.
jobName	string	Name of the Data Transfer Job
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get a Data Transfer Job.

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.data_transfer_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND jobName = '{{ jobName }}' -- required
;

list_by_database_account

Get a list of Data Transfer jobs.

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.data_transfer_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

INSERT examples

create

Creates a Data Transfer Job.

INSERT INTO azure.cosmos_db.data_transfer_jobs (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
jobName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ jobName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_transfer_jobs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the data_transfer_jobs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_transfer_jobs resource.
    - name: accountName
      value: string
      description: Required parameter for the data_transfer_jobs resource.
    - name: jobName
      value: string
      description: Required parameter for the data_transfer_jobs resource.
    - name: properties
      value: object
      description: |
        Data Transfer Create Job Properties

Lifecycle Methods

pause

Pause a Data Transfer Job.

EXEC azure.cosmos_db.data_transfer_jobs.pause 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@jobName='{{ jobName }}' --required
;

resume

Resumes a Data Transfer Job.

EXEC azure.cosmos_db.data_transfer_jobs.resume 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@jobName='{{ jobName }}' --required
;

cancel

Cancels a Data Transfer Job.

EXEC azure.cosmos_db.data_transfer_jobs.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@jobName='{{ jobName }}' --required
;

complete

Completes a Data Transfer Online Job.

EXEC azure.cosmos_db.data_transfer_jobs.complete 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@jobName='{{ jobName }}' --required
;