data_set_mappings

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

Overview

Name	data_set_mappings
Type	Resource
Id	azure.data_share.data_set_mappings

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 mapping. Required. Known values are: "Blob", "Container", "BlobFolder", "AdlsGen2FileSystem", "AdlsGen2Folder", "AdlsGen2File", "KustoCluster", "KustoDatabase", "SqlDBTable", "SqlDWTable", and "SynapseWorkspaceSqlPoolTable".
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource.

list_by_share_subscription

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 mapping. Required. Known values are: "Blob", "Container", "BlobFolder", "AdlsGen2FileSystem", "AdlsGen2Folder", "AdlsGen2File", "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_subscription_name, data_set_mapping_name, subscription_id		Get DataSetMapping in a shareSubscription. Get a DataSetMapping in a shareSubscription.
list_by_share_subscription	select	resource_group_name, account_name, share_subscription_name, subscription_id	$skipToken, $filter, $orderby	List DataSetMappings in a share subscription. List DataSetMappings in a share subscription.
create	insert	resource_group_name, account_name, share_subscription_name, data_set_mapping_name, subscription_id, kind		Maps a source data set in the source share to a sink data set in the share subscription. Enables copying the data set from source to destination. Create a DataSetMapping.
delete	delete	resource_group_name, account_name, share_subscription_name, data_set_mapping_name, subscription_id		Delete DataSetMapping in a shareSubscription. Delete a DataSetMapping in a shareSubscription.

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_mapping_name	string	The name of the dataSetMapping. Required.
resource_group_name	string	The resource group name. Required.
share_subscription_name	string	The name of the shareSubscription. 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 DataSetMapping in a shareSubscription. Get a DataSetMapping in a shareSubscription.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.data_set_mappings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_subscription_name = '{{ share_subscription_name }}' -- required
AND data_set_mapping_name = '{{ data_set_mapping_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_share_subscription

List DataSetMappings in a share subscription. List DataSetMappings in a share subscription.

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

INSERT examples

create

Maps a source data set in the source share to a sink data set in the share subscription. Enables copying the data set from source to destination. Create a DataSetMapping.

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

Manifest

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

DELETE examples

delete

Delete DataSetMapping in a shareSubscription. Delete a DataSetMapping in a shareSubscription.

DELETE FROM azure.data_share.data_set_mappings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND share_subscription_name = '{{ share_subscription_name }}' --required
AND data_set_mapping_name = '{{ data_set_mapping_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;