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.
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.
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	subscriptionId, resourceGroupName, accountName, shareName, dataSetName	api-version	Get a DataSet in a share
list_by_share	select	subscriptionId, resourceGroupName, accountName, shareName	api-version, $skipToken, $filter, $orderby	List DataSets in a share
create	insert	subscriptionId, resourceGroupName, accountName, shareName, dataSetName, data__kind	api-version	Create a DataSet
delete	delete	subscriptionId, resourceGroupName, accountName, shareName, dataSetName	api-version	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
accountName	string	The name of the share account.
dataSetName	string	The name of the dataSet.
resourceGroupName	string	The resource group name.
shareName	string	The name of the share.
subscriptionId	string	The subscription identifier
$filter	string	Filters the results using OData syntax.
$orderby	string	Sorts the results using OData syntax.
$skipToken	string	continuation token
api-version	string	The api version to use.

SELECT examples

get

Get a DataSet in a share

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.data_sets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND shareName = '{{ shareName }}' -- required
AND dataSetName = '{{ dataSetName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_share

List DataSets in a share

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.data_sets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND shareName = '{{ shareName }}' -- required
AND api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Create a DataSet

INSERT INTO azure.data_share.data_sets (
data__kind,
subscriptionId,
resourceGroupName,
accountName,
shareName,
dataSetName,
api-version
)
SELECT 
'{{ kind }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ shareName }}',
'{{ dataSetName }}',
'{{ api-version }}'
RETURNING
id,
name,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_sets
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the data_sets resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_sets resource.
    - name: accountName
      value: string
      description: Required parameter for the data_sets resource.
    - name: shareName
      value: string
      description: Required parameter for the data_sets resource.
    - name: dataSetName
      value: string
      description: Required parameter for the data_sets resource.
    - name: kind
      value: string
      description: |
        Kind of data set.
      valid_values: ['Blob', 'Container', 'BlobFolder', 'AdlsGen2FileSystem', 'AdlsGen2Folder', 'AdlsGen2File', 'AdlsGen1Folder', 'AdlsGen1File', 'KustoCluster', 'KustoDatabase', 'SqlDBTable', 'SqlDWTable', 'SynapseWorkspaceSqlPoolTable']
    - name: api-version
      value: string
      description: The api version to use.

DELETE examples

delete

Delete a DataSet in a share

DELETE FROM azure.data_share.data_sets
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND shareName = '{{ shareName }}' --required
AND dataSetName = '{{ dataSetName }}' --required
AND api-version = '{{ api-version }}'
;