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

vw_data_transfer_jobs

Name	Datatype	Description
id	text	The unique resource identifier of the database account.
name	text	The name of the database account.
accountName	text	field from the properties object
destination	text	field from the properties object
duration	text	field from the properties object
error	text	field from the properties object
jobName	text	field from the properties object
job_name	text	field from the properties object
last_updated_utc_time	text	field from the properties object
mode	text	field from the properties object
processed_count	text	field from the properties object
resourceGroupName	text	field from the properties object
source	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object
total_count	text	field from the properties object
type	text	The type of Azure resource.
worker_count	text	field from the properties object

data_transfer_jobs

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

Name	Accessible by	Required Params	Description
get	SELECT	accountName, jobName, resourceGroupName, subscriptionId	Get a Data Transfer Job.
list_by_database_account	SELECT	accountName, resourceGroupName, subscriptionId	Get a list of Data Transfer jobs.
create	INSERT	accountName, jobName, resourceGroupName, subscriptionId, data__properties	Creates a Data Transfer Job.
cancel	EXEC	accountName, jobName, resourceGroupName, subscriptionId	Cancels a Data Transfer Job.
complete	EXEC	accountName, jobName, resourceGroupName, subscriptionId	Completes a Data Transfer Online Job.
pause	EXEC	accountName, jobName, resourceGroupName, subscriptionId	Pause a Data Transfer Job.
resume	EXEC	accountName, jobName, resourceGroupName, subscriptionId	Resumes a Data Transfer Job.

SELECT examples

Get a list of Data Transfer jobs.

vw_data_transfer_jobs

SELECT
id,
name,
accountName,
destination,
duration,
error,
jobName,
job_name,
last_updated_utc_time,
mode,
processed_count,
resourceGroupName,
source,
status,
subscriptionId,
total_count,
type,
worker_count
FROM azure.cosmos_db.vw_data_transfer_jobs
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

data_transfer_jobs

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.cosmos_db.data_transfer_jobs (
accountName,
jobName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ accountName }}',
'{{ jobName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: jobName
          value: string
        - name: source
          value:
            - name: component
              value: string
        - name: status
          value: string
        - name: processedCount
          value: integer
        - name: totalCount
          value: integer
        - name: lastUpdatedUtcTime
          value: string
        - name: workerCount
          value: integer
        - name: error
          value:
            - name: code
              value: string
            - name: message
              value: string
        - name: duration
          value: string
        - name: mode
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string