data_sets

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

Overview

Name	data_sets
Type	Resource
Id	azure.data_share.data_sets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
kind	string	Kind of data set. Required. Known values are: "Blob", "Container", "BlobFolder", "AdlsGen2FileSystem", "AdlsGen2Folder", "AdlsGen2File", "AdlsGen1Folder", "AdlsGen1File", "KustoCluster", "KustoDatabase", "SqlDBTable", "SqlDWTable", and "SynapseWorkspaceSqlPoolTable".
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource.

list_by_share

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
kind	string	Kind of data set. Required. Known values are: "Blob", "Container", "BlobFolder", "AdlsGen2FileSystem", "AdlsGen2Folder", "AdlsGen2File", "AdlsGen1Folder", "AdlsGen1File", "KustoCluster", "KustoDatabase", "SqlDBTable", "SqlDWTable", and "SynapseWorkspaceSqlPoolTable".
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, share_name, data_set_name, subscription_id		Get DataSet in a share. Get a DataSet in a share.
list_by_share	select	resource_group_name, account_name, share_name, subscription_id	$skipToken, $filter, $orderby	List DataSets in a share. List DataSets in a share.
create	insert	resource_group_name, account_name, share_name, data_set_name, subscription_id, kind		Adds a new data set to an existing share. Create a DataSet.
delete	delete	resource_group_name, account_name, share_name, data_set_name, subscription_id		Delete DataSet in a share. Delete a DataSet in a share.

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
account_name	string	The name of the share account. Required.
data_set_name	string	The name of the dataSet. Required.
resource_group_name	string	The resource group name. Required.
share_name	string	The name of the share. Required.
subscription_id	string
$filter	string	Filters the results using OData syntax. Default value is None.
$orderby	string	Sorts the results using OData syntax. Default value is None.
$skipToken	string	continuation token. Default value is None.

SELECT examples

get

Get DataSet in a share. Get a DataSet in a share.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.data_sets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_name = '{{ share_name }}' -- required
AND data_set_name = '{{ data_set_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_share

List DataSets in a share. List DataSets in a share.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.data_sets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_name = '{{ share_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Adds a new data set to an existing share. Create a DataSet.

INSERT INTO azure.data_share.data_sets (
kind,
resource_group_name,
account_name,
share_name,
data_set_name,
subscription_id
)
SELECT 
'{{ kind }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ share_name }}',
'{{ data_set_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_sets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the data_sets resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the data_sets resource.
  - name: share_name
    value: "{{ share_name }}"
    description: Required parameter for the data_sets resource.
  - name: data_set_name
    value: "{{ data_set_name }}"
    description: Required parameter for the data_sets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the data_sets resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of data set. Required. Known values are: "Blob", "Container", "BlobFolder", "AdlsGen2FileSystem", "AdlsGen2Folder", "AdlsGen2File", "AdlsGen1Folder", "AdlsGen1File", "KustoCluster", "KustoDatabase", "SqlDBTable", "SqlDWTable", and "SynapseWorkspaceSqlPoolTable".

DELETE examples

delete

Delete DataSet in a share. Delete a DataSet in a share.

DELETE FROM azure.data_share.data_sets
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND share_name = '{{ share_name }}' --required
AND data_set_name = '{{ data_set_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;