datasets

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

Overview

Name	datasets
Type	Resource
Id	azure.data_factory.datasets

Fields

vw_datasets

Name	Datatype	Description
id	text	The resource identifier.
name	text	The resource name.
description	text	field from the properties object
annotations	text	field from the properties object
datasetName	text	field from the properties object
etag	text	Etag identifies change in the resource.
factoryName	text	field from the properties object
folder	text	field from the properties object
linked_service_name	text	field from the properties object
parameters	text	field from the properties object
resourceGroupName	text	field from the properties object
schema	text	field from the properties object
structure	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The resource type.

datasets

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.
type	string	The resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	datasetName, factoryName, resourceGroupName, subscriptionId	Gets a dataset.
list_by_factory	SELECT	factoryName, resourceGroupName, subscriptionId	Lists datasets.
create_or_update	INSERT	datasetName, factoryName, resourceGroupName, subscriptionId, data__properties	Creates or updates a dataset.
delete	DELETE	datasetName, factoryName, resourceGroupName, subscriptionId	Deletes a dataset.

SELECT examples

Lists datasets.

vw_datasets

SELECT
id,
name,
description,
annotations,
datasetName,
etag,
factoryName,
folder,
linked_service_name,
parameters,
resourceGroupName,
schema,
structure,
subscriptionId,
type
FROM azure.data_factory.vw_datasets
WHERE factoryName = '{{ factoryName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

datasets

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.datasets
WHERE factoryName = '{{ factoryName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.data_factory.datasets (
datasetName,
factoryName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ datasetName }}',
'{{ factoryName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: etag
      value: string
    - name: properties
      value:
        - name: type
          value: string
        - name: description
          value: string
        - name: structure
          value: object
        - name: schema
          value: object
        - name: linkedServiceName
          value:
            - name: type
              value: string
            - name: referenceName
              value: string
            - name: parameters
              value: []
        - name: parameters
          value: []
        - name: annotations
          value:
            - object
        - name: folder
          value:
            - name: name
              value: string

DELETE example

Deletes the specified datasets resource.

/*+ delete */
DELETE FROM azure.data_factory.datasets
WHERE datasetName = '{{ datasetName }}'
AND factoryName = '{{ factoryName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';