datasets

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

Overview

Name	datasets
Type	Resource
Id	azure.data_factory.datasets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotations	array	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
folder	object	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	object	Linked service reference. Required.
parameters	object	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_factory

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotations	array	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
folder	object	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	object	Linked service reference. Required.
parameters	object	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, factory_name, dataset_name, subscription_id		Gets a dataset.
list_by_factory	select	resource_group_name, factory_name, subscription_id		Lists datasets.
create_or_update	insert	resource_group_name, factory_name, dataset_name, subscription_id, properties		Creates or updates a dataset.
create_or_update	replace	resource_group_name, factory_name, dataset_name, subscription_id, properties		Creates or updates a dataset.
delete	delete	resource_group_name, factory_name, dataset_name, subscription_id		Deletes a dataset.

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
dataset_name	string	The dataset name. Required.
factory_name	string	The factory name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a dataset.

SELECT
id,
name,
annotations,
description,
etag,
folder,
linkedServiceName,
parameters,
schema,
structure,
systemData,
type
FROM azure.data_factory.datasets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND dataset_name = '{{ dataset_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_factory

Lists datasets.

SELECT
id,
name,
annotations,
description,
etag,
folder,
linkedServiceName,
parameters,
schema,
structure,
systemData,
type
FROM azure.data_factory.datasets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a dataset.

INSERT INTO azure.data_factory.datasets (
properties,
resource_group_name,
factory_name,
dataset_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ factory_name }}',
'{{ dataset_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: datasets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the datasets resource.
  - name: factory_name
    value: "{{ factory_name }}"
    description: Required parameter for the datasets resource.
  - name: dataset_name
    value: "{{ dataset_name }}"
    description: Required parameter for the datasets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the datasets resource.
  - name: properties
    description: |
      Dataset properties. Required.
    value:
      type: "{{ type }}"
      description: "{{ description }}"
      structure: "{{ structure }}"
      schema: "{{ schema }}"
      linkedServiceName:
        type: "{{ type }}"
        referenceName: "{{ referenceName }}"
        parameters: "{{ parameters }}"
      parameters: "{{ parameters }}"
      annotations: "{{ annotations }}"
      folder:
        name: "{{ name }}"

REPLACE examples

create_or_update

Creates or updates a dataset.

REPLACE azure.data_factory.datasets
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND dataset_name = '{{ dataset_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a dataset.

DELETE FROM azure.data_factory.datasets
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND dataset_name = '{{ dataset_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;