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.
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.
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, shareSubscriptionName, dataSetMappingName	api-version	Get a DataSetMapping in a shareSubscription
list_by_share_subscription	select	subscriptionId, resourceGroupName, accountName, shareSubscriptionName	api-version, $skipToken, $filter, $orderby	List DataSetMappings in a share subscription
create	insert	subscriptionId, resourceGroupName, accountName, shareSubscriptionName, dataSetMappingName, data__kind	api-version	Create a DataSetMapping
delete	delete	subscriptionId, resourceGroupName, accountName, shareSubscriptionName, dataSetMappingName	api-version	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
accountName	string	The name of the share account.
dataSetMappingName	string	The name of the dataSetMapping.
resourceGroupName	string	The resource group name.
shareSubscriptionName	string	The name of the shareSubscription.
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 DataSetMapping in a shareSubscription

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

list_by_share_subscription

List DataSetMappings in a share subscription

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

INSERT examples

create

Create a DataSetMapping

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

Manifest

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

DELETE examples

delete

Delete a DataSetMapping in a shareSubscription

DELETE FROM azure.data_share.data_set_mappings
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND shareSubscriptionName = '{{ shareSubscriptionName }}' --required
AND dataSetMappingName = '{{ dataSetMappingName }}' --required
AND api-version = '{{ api-version }}'
;