Microsoft.DataShare accounts/shares/dataSets template reference

Template format

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

{
  "name": "string",
  "type": "Microsoft.DataShare/accounts/shares/dataSets",
  "apiVersion": "2019-11-01",
  "kind": "string",
  "properties": {
    "accountName": "string",
    "containerName": "string",
    "databaseName": "string",
    "dataWarehouseName": "string",
    "fileName": "string",
    "filePath": "string",
    "fileSystem": "string",
    "folderPath": "string",
    "kustoClusterResourceId": "string",
    "kustoDatabaseResourceId": "string",
    "prefix": "string",
    "resourceGroup": "string",
    "schemaName": "string",
    "sqlServerResourceId": "string",
    "storageAccountName": "string",
    "subscriptionId": "string",
    "tableName": "string"
  }
}

For Blob, use:

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

For Container, use:

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

For BlobFolder, use:

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

For AdlsGen2FileSystem, use:

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

For AdlsGen2Folder, use:

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

For AdlsGen2File, use:

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

For AdlsGen1Folder, use:

"kind": "AdlsGen1Folder",
"properties": {
  "accountName": "string",
  "folderPath": "string",
  "resourceGroup": "string",
  "subscriptionId": "string"
}

For AdlsGen1File, use:

"kind": "AdlsGen1File",
"properties": {
  "accountName": "string",
  "fileName": "string",
  "folderPath": "string",
  "resourceGroup": "string",
  "subscriptionId": "string"
}

For KustoCluster, use:

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

For KustoDatabase, use:

"kind": "KustoDatabase",
"properties": {
  "kustoDatabaseResourceId": "string"
}

For SqlDBTable, use:

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

For SqlDWTable, use:

"kind": "SqlDWTable",
"properties": {
  "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/shares/dataSets object

Name Type Required Value
name string Yes The name of the dataSet.
type enum Yes dataSets
-or-
Microsoft.DataShare/accounts/shares/dataSets

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, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable
properties object Yes Properties for the data set. - DataSetProperties object

DataSetProperties object

Name Type Required Value
accountName string No The ADLS account name.
containerName string No Container name.
databaseName string No Database name of the source data set
dataWarehouseName string No DataWarehouse name of the source data set
fileName string No File name.
filePath string No File path within the source data set
fileSystem string No File system to which the folder belongs.
folderPath string No Folder path within the file system.
kustoClusterResourceId string No Resource id of the kusto cluster.
kustoDatabaseResourceId string No Resource id of the kusto database.
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.