Microsoft.DataShare accounts/shareSubscriptions/dataSetMappings template reference

Template format

To create a Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings",
  "apiVersion": "2019-11-01",
  "kind": "string",
  "properties": {
    "containerName": "string",
    "databaseName": "string",
    "dataSetId": "string",
    "dataWarehouseName": "string",
    "filePath": "string",
    "fileSystem": "string",
    "folderPath": "string",
    "kustoClusterResourceId": "string",
    "outputType": "string",
    "prefix": "string",
    "resourceGroup": "string",
    "schemaName": "string",
    "sqlServerResourceId": "string",
    "storageAccountName": "string",
    "subscriptionId": "string",
    "tableName": "string"
  }
}

For Blob, use:

"kind": "Blob",
"properties": {
  "containerName": "string",
  "dataSetId": "string",
  "filePath": "string",
  "outputType": "string",
  "resourceGroup": "string",
  "storageAccountName": "string",
  "subscriptionId": "string"
}

For Container, use:

"kind": "Container",
"properties": {
  "containerName": "string",
  "dataSetId": "string",
  "resourceGroup": "string",
  "storageAccountName": "string",
  "subscriptionId": "string"
}

For BlobFolder, use:

"kind": "BlobFolder",
"properties": {
  "containerName": "string",
  "dataSetId": "string",
  "prefix": "string",
  "resourceGroup": "string",
  "storageAccountName": "string",
  "subscriptionId": "string"
}

For AdlsGen2FileSystem, use:

"kind": "AdlsGen2FileSystem",
"properties": {
  "dataSetId": "string",
  "fileSystem": "string",
  "resourceGroup": "string",
  "storageAccountName": "string",
  "subscriptionId": "string"
}

For AdlsGen2Folder, use:

"kind": "AdlsGen2Folder",
"properties": {
  "dataSetId": "string",
  "fileSystem": "string",
  "folderPath": "string",
  "resourceGroup": "string",
  "storageAccountName": "string",
  "subscriptionId": "string"
}

For AdlsGen2File, use:

"kind": "AdlsGen2File",
"properties": {
  "dataSetId": "string",
  "filePath": "string",
  "fileSystem": "string",
  "outputType": "string",
  "resourceGroup": "string",
  "storageAccountName": "string",
  "subscriptionId": "string"
}

For KustoCluster, use:

"kind": "KustoCluster",
"properties": {
  "dataSetId": "string",
  "kustoClusterResourceId": "string"
}

For KustoDatabase, use:

"kind": "KustoDatabase",
"properties": {
  "dataSetId": "string",
  "kustoClusterResourceId": "string"
}

For SqlDBTable, use:

"kind": "SqlDBTable",
"properties": {
  "databaseName": "string",
  "dataSetId": "string",
  "schemaName": "string",
  "sqlServerResourceId": "string",
  "tableName": "string"
}

For SqlDWTable, use:

"kind": "SqlDWTable",
"properties": {
  "dataSetId": "string",
  "dataWarehouseName": "string",
  "schemaName": "string",
  "sqlServerResourceId": "string",
  "tableName": "string"
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings object

Name Type Required Value
name string Yes The name of the data set mapping to be created.
type enum Yes dataSetMappings
-or-
Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings

See Set name and type for child resources.
apiVersion enum Yes 2019-11-01
kind enum Yes Kind of data set. - Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable
properties object Yes Properties for the data set mappings. - DataSetMappingsProperties object

DataSetMappingsProperties object

Name Type Required Value
containerName string No BLOB Container name.
databaseName string No DatabaseName name of the sink data set
dataSetId string No The id of the source data set.
dataWarehouseName string No DataWarehouse name of the source data set
filePath string No File path within the file system.
fileSystem string No File system to which the file belongs.
folderPath string No Folder path within the file system.
kustoClusterResourceId string No Resource id of the sink kusto cluster.
outputType enum No Type of output file - Csv, Parquet
prefix string No Prefix for blob folder
resourceGroup string No Resource group of storage account
schemaName string No Schema of the table. Default value is dbo.
sqlServerResourceId string No Resource id of SQL server
storageAccountName string No Storage account name of the source data set
subscriptionId string No Subscription id of storage account
tableName string No SQL table name.