Microsoft.DataFactory factories/datasets

Bicep resource definition

The factories/datasets resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/datasets resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataFactory/factories/datasets@2018-06-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    annotations: [
      any
    ]
    description: 'string'
    folder: {
      name: 'string'
    }
    linkedServiceName: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    parameters: {
      {customized property}: {
        defaultValue: any()
        type: 'string'
      }
    }
    schema: any()
    structure: any()
    type: 'string'
    // For remaining properties, see Dataset objects
  }
}

Dataset objects

Set the type property to specify the type of object.

For AmazonMWSObject, use:

  type: 'AmazonMWSObject'
  typeProperties: {
    tableName: any()
  }

For AmazonRdsForOracleTable, use:

  type: 'AmazonRdsForOracleTable'
  typeProperties: {
    schema: any()
    table: any()
  }

For AmazonRdsForSqlServerTable, use:

  type: 'AmazonRdsForSqlServerTable'
  typeProperties: {
    schema: any()
    table: any()
  }

For AmazonRedshiftTable, use:

  type: 'AmazonRedshiftTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For AmazonS3Object, use:

  type: 'AmazonS3Object'
  typeProperties: {
    bucketName: any()
    compression: {
      level: any()
      type: any()
      {customized property}: any()
    }
    format: {
      deserializer: any()
      serializer: any()
      type: 'string'
      // For remaining properties, see DatasetStorageFormat objects
    }
    key: any()
    modifiedDatetimeEnd: any()
    modifiedDatetimeStart: any()
    prefix: any()
    version: any()
  }

For Avro, use:

  type: 'Avro'
  typeProperties: {
    avroCompressionCodec: any()
    avroCompressionLevel: int
    location: {
      fileName: any()
      folderPath: any()
      type: 'string'
      // For remaining properties, see DatasetLocation objects
    }
  }

For AzureBlob, use:

  type: 'AzureBlob'
  typeProperties: {
    compression: {
      level: any()
      type: any()
      {customized property}: any()
    }
    fileName: any()
    folderPath: any()
    format: {
      deserializer: any()
      serializer: any()
      type: 'string'
      // For remaining properties, see DatasetStorageFormat objects
    }
    modifiedDatetimeEnd: any()
    modifiedDatetimeStart: any()
    tableRootLocation: any()
  }

For AzureBlobFSFile, use:

  type: 'AzureBlobFSFile'
  typeProperties: {
    compression: {
      level: any()
      type: any()
      {customized property}: any()
    }
    fileName: any()
    folderPath: any()
    format: {
      deserializer: any()
      serializer: any()
      type: 'string'
      // For remaining properties, see DatasetStorageFormat objects
    }
  }

For AzureDatabricksDeltaLakeDataset, use:

  type: 'AzureDatabricksDeltaLakeDataset'
  typeProperties: {
    database: any()
    table: any()
  }

For AzureDataExplorerTable, use:

  type: 'AzureDataExplorerTable'
  typeProperties: {
    table: any()
  }

For AzureDataLakeStoreFile, use:

  type: 'AzureDataLakeStoreFile'
  typeProperties: {
    compression: {
      level: any()
      type: any()
      {customized property}: any()
    }
    fileName: any()
    folderPath: any()
    format: {
      deserializer: any()
      serializer: any()
      type: 'string'
      // For remaining properties, see DatasetStorageFormat objects
    }
  }

For AzureMariaDBTable, use:

  type: 'AzureMariaDBTable'
  typeProperties: {
    tableName: any()
  }

For AzureMySqlTable, use:

  type: 'AzureMySqlTable'
  typeProperties: {
    table: any()
    tableName: any()
  }

For AzurePostgreSqlTable, use:

  type: 'AzurePostgreSqlTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For AzureSearchIndex, use:

  type: 'AzureSearchIndex'
  typeProperties: {
    indexName: any()
  }

For AzureSqlDWTable, use:

  type: 'AzureSqlDWTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For AzureSqlMITable, use:

  type: 'AzureSqlMITable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For AzureSqlTable, use:

  type: 'AzureSqlTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For AzureTable, use:

  type: 'AzureTable'
  typeProperties: {
    tableName: any()
  }

For Binary, use:

  type: 'Binary'
  typeProperties: {
    compression: {
      level: any()
      type: any()
      {customized property}: any()
    }
    location: {
      fileName: any()
      folderPath: any()
      type: 'string'
      // For remaining properties, see DatasetLocation objects
    }
  }

For CassandraTable, use:

  type: 'CassandraTable'
  typeProperties: {
    keyspace: any()
    tableName: any()
  }

For CommonDataServiceForAppsEntity, use:

  type: 'CommonDataServiceForAppsEntity'
  typeProperties: {
    entityName: any()
  }

For ConcurObject, use:

  type: 'ConcurObject'
  typeProperties: {
    tableName: any()
  }

For CosmosDbMongoDbApiCollection, use:

  type: 'CosmosDbMongoDbApiCollection'
  typeProperties: {
    collection: any()
  }

For CosmosDbSqlApiCollection, use:

  type: 'CosmosDbSqlApiCollection'
  typeProperties: {
    collectionName: any()
  }

For CouchbaseTable, use:

  type: 'CouchbaseTable'
  typeProperties: {
    tableName: any()
  }

For CustomDataset, use:

  type: 'CustomDataset'
  typeProperties: any()

For Db2Table, use:

  type: 'Db2Table'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For DelimitedText, use:

  type: 'DelimitedText'
  typeProperties: {
    columnDelimiter: any()
    compressionCodec: any()
    compressionLevel: any()
    encodingName: any()
    escapeChar: any()
    firstRowAsHeader: any()
    location: {
      fileName: any()
      folderPath: any()
      type: 'string'
      // For remaining properties, see DatasetLocation objects
    }
    nullValue: any()
    quoteChar: any()
    rowDelimiter: any()
  }

For DocumentDbCollection, use:

  type: 'DocumentDbCollection'
  typeProperties: {
    collectionName: any()
  }

For DrillTable, use:

  type: 'DrillTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For DynamicsAXResource, use:

  type: 'DynamicsAXResource'
  typeProperties: {
    path: any()
  }

For DynamicsCrmEntity, use:

  type: 'DynamicsCrmEntity'
  typeProperties: {
    entityName: any()
  }

For DynamicsEntity, use:

  type: 'DynamicsEntity'
  typeProperties: {
    entityName: any()
  }

For EloquaObject, use:

  type: 'EloquaObject'
  typeProperties: {
    tableName: any()
  }

For Excel, use:

  type: 'Excel'
  typeProperties: {
    compression: {
      level: any()
      type: any()
      {customized property}: any()
    }
    firstRowAsHeader: any()
    location: {
      fileName: any()
      folderPath: any()
      type: 'string'
      // For remaining properties, see DatasetLocation objects
    }
    nullValue: any()
    range: any()
    sheetIndex: any()
    sheetName: any()
  }

For FileShare, use:

  type: 'FileShare'
  typeProperties: {
    compression: {
      level: any()
      type: any()
      {customized property}: any()
    }
    fileFilter: any()
    fileName: any()
    folderPath: any()
    format: {
      deserializer: any()
      serializer: any()
      type: 'string'
      // For remaining properties, see DatasetStorageFormat objects
    }
    modifiedDatetimeEnd: any()
    modifiedDatetimeStart: any()
  }

For GoogleAdWordsObject, use:

  type: 'GoogleAdWordsObject'
  typeProperties: {
    tableName: any()
  }

For GoogleBigQueryObject, use:

  type: 'GoogleBigQueryObject'
  typeProperties: {
    dataset: any()
    table: any()
    tableName: any()
  }

For GoogleBigQueryV2Object, use:

  type: 'GoogleBigQueryV2Object'
  typeProperties: {
    dataset: any()
    table: any()
  }

For GreenplumTable, use:

  type: 'GreenplumTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For HBaseObject, use:

  type: 'HBaseObject'
  typeProperties: {
    tableName: any()
  }

For HiveObject, use:

  type: 'HiveObject'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For HttpFile, use:

  type: 'HttpFile'
  typeProperties: {
    additionalHeaders: any()
    compression: {
      level: any()
      type: any()
      {customized property}: any()
    }
    format: {
      deserializer: any()
      serializer: any()
      type: 'string'
      // For remaining properties, see DatasetStorageFormat objects
    }
    relativeUrl: any()
    requestBody: any()
    requestMethod: any()
  }

For HubspotObject, use:

  type: 'HubspotObject'
  typeProperties: {
    tableName: any()
  }

For ImpalaObject, use:

  type: 'ImpalaObject'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For InformixTable, use:

  type: 'InformixTable'
  typeProperties: {
    tableName: any()
  }

For JiraObject, use:

  type: 'JiraObject'
  typeProperties: {
    tableName: any()
  }

For Json, use:

  type: 'Json'
  typeProperties: {
    compression: {
      level: any()
      type: any()
      {customized property}: any()
    }
    encodingName: any()
    location: {
      fileName: any()
      folderPath: any()
      type: 'string'
      // For remaining properties, see DatasetLocation objects
    }
  }

For LakeHouseTable, use:

  type: 'LakeHouseTable'
  typeProperties: {
    table: any()
  }

For MagentoObject, use:

  type: 'MagentoObject'
  typeProperties: {
    tableName: any()
  }

For MariaDBTable, use:

  type: 'MariaDBTable'
  typeProperties: {
    tableName: any()
  }

For MarketoObject, use:

  type: 'MarketoObject'
  typeProperties: {
    tableName: any()
  }

For MicrosoftAccessTable, use:

  type: 'MicrosoftAccessTable'
  typeProperties: {
    tableName: any()
  }

For MongoDbAtlasCollection, use:

  type: 'MongoDbAtlasCollection'
  typeProperties: {
    collection: any()
  }

For MongoDbCollection, use:

  type: 'MongoDbCollection'
  typeProperties: {
    collectionName: any()
  }

For MongoDbV2Collection, use:

  type: 'MongoDbV2Collection'
  typeProperties: {
    collection: any()
  }

For MySqlTable, use:

  type: 'MySqlTable'
  typeProperties: {
    tableName: any()
  }

For NetezzaTable, use:

  type: 'NetezzaTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For ODataResource, use:

  type: 'ODataResource'
  typeProperties: {
    path: any()
  }

For OdbcTable, use:

  type: 'OdbcTable'
  typeProperties: {
    tableName: any()
  }

For Office365Table, use:

  type: 'Office365Table'
  typeProperties: {
    predicate: any()
    tableName: any()
  }

For OracleServiceCloudObject, use:

  type: 'OracleServiceCloudObject'
  typeProperties: {
    tableName: any()
  }

For OracleTable, use:

  type: 'OracleTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For Orc, use:

  type: 'Orc'
  typeProperties: {
    location: {
      fileName: any()
      folderPath: any()
      type: 'string'
      // For remaining properties, see DatasetLocation objects
    }
    orcCompressionCodec: any()
  }

For Parquet, use:

  type: 'Parquet'
  typeProperties: {
    compressionCodec: any()
    location: {
      fileName: any()
      folderPath: any()
      type: 'string'
      // For remaining properties, see DatasetLocation objects
    }
  }

For PaypalObject, use:

  type: 'PaypalObject'
  typeProperties: {
    tableName: any()
  }

For PhoenixObject, use:

  type: 'PhoenixObject'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For PostgreSqlTable, use:

  type: 'PostgreSqlTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For PostgreSqlV2Table, use:

  type: 'PostgreSqlV2Table'
  typeProperties: {
    schema: any()
    table: any()
  }

For PrestoObject, use:

  type: 'PrestoObject'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For QuickBooksObject, use:

  type: 'QuickBooksObject'
  typeProperties: {
    tableName: any()
  }

For RelationalTable, use:

  type: 'RelationalTable'
  typeProperties: {
    tableName: any()
  }

For ResponsysObject, use:

  type: 'ResponsysObject'
  typeProperties: {
    tableName: any()
  }

For RestResource, use:

  type: 'RestResource'
  typeProperties: {
    additionalHeaders: {
      {customized property}: any()
    }
    paginationRules: {
      {customized property}: any()
    }
    relativeUrl: any()
    requestBody: any()
    requestMethod: any()
  }

For SalesforceMarketingCloudObject, use:

  type: 'SalesforceMarketingCloudObject'
  typeProperties: {
    tableName: any()
  }

For SalesforceObject, use:

  type: 'SalesforceObject'
  typeProperties: {
    objectApiName: any()
  }

For SalesforceServiceCloudObject, use:

  type: 'SalesforceServiceCloudObject'
  typeProperties: {
    objectApiName: any()
  }

For SalesforceServiceCloudV2Object, use:

  type: 'SalesforceServiceCloudV2Object'
  typeProperties: {
    objectApiName: any()
    reportId: any()
  }

For SalesforceV2Object, use:

  type: 'SalesforceV2Object'
  typeProperties: {
    objectApiName: any()
    reportId: any()
  }

For SapBwCube, use:

  type: 'SapBwCube'

For SapCloudForCustomerResource, use:

  type: 'SapCloudForCustomerResource'
  typeProperties: {
    path: any()
  }

For SapEccResource, use:

  type: 'SapEccResource'
  typeProperties: {
    path: any()
  }

For SapHanaTable, use:

  type: 'SapHanaTable'
  typeProperties: {
    schema: any()
    table: any()
  }

For SapOdpResource, use:

  type: 'SapOdpResource'
  typeProperties: {
    context: any()
    objectName: any()
  }

For SapOpenHubTable, use:

  type: 'SapOpenHubTable'
  typeProperties: {
    baseRequestId: any()
    excludeLastRequest: any()
    openHubDestinationName: any()
  }

For SapTableResource, use:

  type: 'SapTableResource'
  typeProperties: {
    tableName: any()
  }

For ServiceNowObject, use:

  type: 'ServiceNowObject'
  typeProperties: {
    tableName: any()
  }

For ServiceNowV2Object, use:

  type: 'ServiceNowV2Object'
  typeProperties: {
    tableName: any()
  }

For SharePointOnlineListResource, use:

  type: 'SharePointOnlineListResource'
  typeProperties: {
    listName: any()
  }

For ShopifyObject, use:

  type: 'ShopifyObject'
  typeProperties: {
    tableName: any()
  }

For SnowflakeTable, use:

  type: 'SnowflakeTable'
  typeProperties: {
    schema: any()
    table: any()
  }

For SnowflakeV2Table, use:

  type: 'SnowflakeV2Table'
  typeProperties: {
    schema: any()
    table: any()
  }

For SparkObject, use:

  type: 'SparkObject'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For SqlServerTable, use:

  type: 'SqlServerTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For SquareObject, use:

  type: 'SquareObject'
  typeProperties: {
    tableName: any()
  }

For SybaseTable, use:

  type: 'SybaseTable'
  typeProperties: {
    tableName: any()
  }

For TeradataTable, use:

  type: 'TeradataTable'
  typeProperties: {
    database: any()
    table: any()
  }

For VerticaTable, use:

  type: 'VerticaTable'
  typeProperties: {
    schema: any()
    table: any()
    tableName: any()
  }

For WarehouseTable, use:

  type: 'WarehouseTable'
  typeProperties: {
    schema: any()
    table: any()
  }

For WebTable, use:

  type: 'WebTable'
  typeProperties: {
    index: any()
    path: any()
  }

For XeroObject, use:

  type: 'XeroObject'
  typeProperties: {
    tableName: any()
  }

For Xml, use:

  type: 'Xml'
  typeProperties: {
    compression: {
      level: any()
      type: any()
      {customized property}: any()
    }
    encodingName: any()
    location: {
      fileName: any()
      folderPath: any()
      type: 'string'
      // For remaining properties, see DatasetLocation objects
    }
    nullValue: any()
  }

For ZohoObject, use:

  type: 'ZohoObject'
  typeProperties: {
    tableName: any()
  }

DatasetStorageFormat objects

Set the type property to specify the type of object.

For AvroFormat, use:

  type: 'AvroFormat'

For JsonFormat, use:

  type: 'JsonFormat'
  encodingName: any()
  filePattern: any()
  jsonNodeReference: any()
  jsonPathDefinition: any()
  nestingSeparator: any()

For OrcFormat, use:

  type: 'OrcFormat'

For ParquetFormat, use:

  type: 'ParquetFormat'

For TextFormat, use:

  type: 'TextFormat'
  columnDelimiter: any()
  encodingName: any()
  escapeChar: any()
  firstRowAsHeader: any()
  nullValue: any()
  quoteChar: any()
  rowDelimiter: any()
  skipLineCount: any()
  treatEmptyAsNull: any()

DatasetLocation objects

Set the type property to specify the type of object.

For AmazonS3CompatibleLocation, use:

  type: 'AmazonS3CompatibleLocation'
  bucketName: any()
  version: any()

For AmazonS3Location, use:

  type: 'AmazonS3Location'
  bucketName: any()
  version: any()

For AzureBlobFSLocation, use:

  type: 'AzureBlobFSLocation'
  fileSystem: any()

For AzureBlobStorageLocation, use:

  type: 'AzureBlobStorageLocation'
  container: any()

For AzureDataLakeStoreLocation, use:

  type: 'AzureDataLakeStoreLocation'

For AzureFileStorageLocation, use:

  type: 'AzureFileStorageLocation'

For FileServerLocation, use:

  type: 'FileServerLocation'

For FtpServerLocation, use:

  type: 'FtpServerLocation'

For GoogleCloudStorageLocation, use:

  type: 'GoogleCloudStorageLocation'
  bucketName: any()
  version: any()

For HdfsLocation, use:

  type: 'HdfsLocation'

For HttpServerLocation, use:

  type: 'HttpServerLocation'
  relativeUrl: any()

For LakeHouseLocation, use:

  type: 'LakeHouseLocation'

For OracleCloudStorageLocation, use:

  type: 'OracleCloudStorageLocation'
  bucketName: any()
  version: any()

For SftpLocation, use:

  type: 'SftpLocation'

Property values

factories/datasets

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)

Character limit: 1-260

Valid characters:
Can't use:
<>*#.%&:\\+?/- or control characters

Start with alphanumeric.
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: factories
properties Dataset properties. Dataset (required)

Dataset

Name Description Value
annotations List of tags that can be used for describing the Dataset. any[]
description Dataset description. string
folder The folder that this Dataset is in. If not specified, Dataset will appear at the root level. DatasetFolder
linkedServiceName Linked service reference. LinkedServiceReference (required)
parameters Parameters for dataset. ParameterDefinitionSpecification
schema Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. For Bicep, you can use the any() function.
structure Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. For Bicep, you can use the any() function.
type Set the object type AmazonMWSObject
AmazonRdsForOracleTable
AmazonRdsForSqlServerTable
AmazonRedshiftTable
AmazonS3Object
Avro
AzureBlob
AzureBlobFSFile
AzureDatabricksDeltaLakeDataset
AzureDataExplorerTable
AzureDataLakeStoreFile
AzureMariaDBTable
AzureMySqlTable
AzurePostgreSqlTable
AzureSearchIndex
AzureSqlDWTable
AzureSqlMITable
AzureSqlTable
AzureTable
Binary
CassandraTable
CommonDataServiceForAppsEntity
ConcurObject
CosmosDbMongoDbApiCollection
CosmosDbSqlApiCollection
CouchbaseTable
CustomDataset
Db2Table
DelimitedText
DocumentDbCollection
DrillTable
DynamicsAXResource
DynamicsCrmEntity
DynamicsEntity
EloquaObject
Excel
FileShare
GoogleAdWordsObject
GoogleBigQueryObject
GoogleBigQueryV2Object
GreenplumTable
HBaseObject
HiveObject
HttpFile
HubspotObject
ImpalaObject
InformixTable
JiraObject
Json
LakeHouseTable
MagentoObject
MariaDBTable
MarketoObject
MicrosoftAccessTable
MongoDbAtlasCollection
MongoDbCollection
MongoDbV2Collection
MySqlTable
NetezzaTable
ODataResource
OdbcTable
Office365Table
OracleServiceCloudObject
OracleTable
Orc
Parquet
PaypalObject
PhoenixObject
PostgreSqlTable
PostgreSqlV2Table
PrestoObject
QuickBooksObject
RelationalTable
ResponsysObject
RestResource
SalesforceMarketingCloudObject
SalesforceObject
SalesforceServiceCloudObject
SalesforceServiceCloudV2Object
SalesforceV2Object
SapBwCube
SapCloudForCustomerResource
SapEccResource
SapHanaTable
SapOdpResource
SapOpenHubTable
SapTableResource
ServiceNowObject
ServiceNowV2Object
SharePointOnlineListResource
ShopifyObject
SnowflakeTable
SnowflakeV2Table
SparkObject
SqlServerTable
SquareObject
SybaseTable
TeradataTable
VerticaTable
WarehouseTable
WebTable
XeroObject
Xml
ZohoObject (required)

DatasetFolder

Name Description Value
name The name of the folder that this Dataset is in. string

LinkedServiceReference

Name Description Value
parameters Arguments for LinkedService. ParameterValueSpecification
referenceName Reference LinkedService name. string (required)
type Linked service reference type. 'LinkedServiceReference' (required)

ParameterValueSpecification

Name Description Value
{customized property} For Bicep, you can use the any() function.

ParameterDefinitionSpecification

Name Description Value
{customized property} ParameterSpecification

ParameterSpecification

Name Description Value
defaultValue Default value of parameter. For Bicep, you can use the any() function.
type Parameter type. 'Array'
'Bool'
'Float'
'Int'
'Object'
'SecureString'
'String' (required)

AmazonMWSObjectDataset

Name Description Value
type Type of dataset. 'AmazonMWSObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

GenericDatasetTypeProperties

Name Description Value
tableName The table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AmazonRdsForOracleTableDataset

Name Description Value
type Type of dataset. 'AmazonRdsForOracleTable' (required)
typeProperties AmazonRdsForOracle dataset properties. AmazonRdsForOracleTableDatasetTypeProperties

AmazonRdsForOracleTableDatasetTypeProperties

Name Description Value
schema The schema name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AmazonRdsForSqlServerTableDataset

Name Description Value
type Type of dataset. 'AmazonRdsForSqlServerTable' (required)
typeProperties The Amazon RDS for SQL Server dataset properties. AmazonRdsForSqlServerTableDatasetTypeProperties

AmazonRdsForSqlServerTableDatasetTypeProperties

Name Description Value
schema The schema name of the SQL Server dataset. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the SQL Server dataset. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AmazonRedshiftTableDataset

Name Description Value
type Type of dataset. 'AmazonRedshiftTable' (required)
typeProperties Amazon Redshift table dataset properties. AmazonRedshiftTableDatasetTypeProperties

AmazonRedshiftTableDatasetTypeProperties

Name Description Value
schema The Amazon Redshift schema name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The Amazon Redshift table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

AmazonS3Dataset

Name Description Value
type Type of dataset. 'AmazonS3Object' (required)
typeProperties Amazon S3 dataset properties. AmazonS3DatasetTypeProperties (required)

AmazonS3DatasetTypeProperties

Name Description Value
bucketName The name of the Amazon S3 bucket. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
compression The data compression method used for the Amazon S3 object. DatasetCompression
format The format of files. DatasetStorageFormat
key The key of the Amazon S3 object. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
modifiedDatetimeEnd The end of S3 object's modified datetime. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
modifiedDatetimeStart The start of S3 object's modified datetime. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
prefix The prefix filter for the S3 object name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
version The version for the S3 object. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

DatasetCompression

Name Description Value
level The dataset compression level. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
type Type of dataset compression. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
{customized property} For Bicep, you can use the any() function.

DatasetStorageFormat

Name Description Value
deserializer Deserializer. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
serializer Serializer. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
type Set the object type AvroFormat
JsonFormat
OrcFormat
ParquetFormat
TextFormat (required)

AvroFormat

Name Description Value
type Type of dataset storage format. 'AvroFormat' (required)

JsonFormat

Name Description Value
type Type of dataset storage format. 'JsonFormat' (required)
encodingName The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
filePattern File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive. For Bicep, you can use the any() function.
jsonNodeReference The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
jsonPathDefinition The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object). For Bicep, you can use the any() function.
nestingSeparator The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

OrcFormat

Name Description Value
type Type of dataset storage format. 'OrcFormat' (required)

ParquetFormat

Name Description Value
type Type of dataset storage format. 'ParquetFormat' (required)

TextFormat

Name Description Value
type Type of dataset storage format. 'TextFormat' (required)
columnDelimiter The column delimiter. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
encodingName The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
escapeChar The escape character. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
firstRowAsHeader When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
nullValue The null value string. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
quoteChar The quote character. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
rowDelimiter The row delimiter. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
skipLineCount The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer). For Bicep, you can use the any() function.
treatEmptyAsNull Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.

AvroDataset

Name Description Value
type Type of dataset. 'Avro' (required)
typeProperties Avro dataset properties. AvroDatasetTypeProperties

AvroDatasetTypeProperties

Name Description Value
avroCompressionCodec The data avroCompressionCodec. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
avroCompressionLevel int

Constraints:
Min value = 1
Max value = 9
location The location of the avro storage. DatasetLocation (required)

DatasetLocation

Name Description Value
fileName Specify the file name of dataset. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
folderPath Specify the folder path of dataset. Type: string (or Expression with resultType string) For Bicep, you can use the any() function.
type Set the object type AmazonS3CompatibleLocation
AmazonS3Location
AzureBlobFSLocation
AzureBlobStorageLocation
AzureDataLakeStoreLocation
AzureFileStorageLocation
FileServerLocation
FtpServerLocation
GoogleCloudStorageLocation
HdfsLocation
HttpServerLocation
LakeHouseLocation
OracleCloudStorageLocation
SftpLocation (required)

AmazonS3CompatibleLocation

Name Description Value
type Type of dataset storage location. 'AmazonS3CompatibleLocation' (required)
bucketName Specify the bucketName of Amazon S3 Compatible. Type: string (or Expression with resultType string) For Bicep, you can use the any() function.
version Specify the version of Amazon S3 Compatible. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AmazonS3Location

Name Description Value
type Type of dataset storage location. 'AmazonS3Location' (required)
bucketName Specify the bucketName of amazon S3. Type: string (or Expression with resultType string) For Bicep, you can use the any() function.
version Specify the version of amazon S3. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureBlobFSLocation

Name Description Value
type Type of dataset storage location. 'AzureBlobFSLocation' (required)
fileSystem Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureBlobStorageLocation

Name Description Value
type Type of dataset storage location. 'AzureBlobStorageLocation' (required)
container Specify the container of azure blob. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureDataLakeStoreLocation

Name Description Value
type Type of dataset storage location. 'AzureDataLakeStoreLocation' (required)

AzureFileStorageLocation

Name Description Value
type Type of dataset storage location. 'AzureFileStorageLocation' (required)

FileServerLocation

Name Description Value
type Type of dataset storage location. 'FileServerLocation' (required)

FtpServerLocation

Name Description Value
type Type of dataset storage location. 'FtpServerLocation' (required)

GoogleCloudStorageLocation

Name Description Value
type Type of dataset storage location. 'GoogleCloudStorageLocation' (required)
bucketName Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string) For Bicep, you can use the any() function.
version Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

HdfsLocation

Name Description Value
type Type of dataset storage location. 'HdfsLocation' (required)

HttpServerLocation

Name Description Value
type Type of dataset storage location. 'HttpServerLocation' (required)
relativeUrl Specify the relativeUrl of http server. Type: string (or Expression with resultType string) For Bicep, you can use the any() function.

LakeHouseLocation

Name Description Value
type Type of dataset storage location. 'LakeHouseLocation' (required)

OracleCloudStorageLocation

Name Description Value
type Type of dataset storage location. 'OracleCloudStorageLocation' (required)
bucketName Specify the bucketName of Oracle Cloud Storage. Type: string (or Expression with resultType string) For Bicep, you can use the any() function.
version Specify the version of Oracle Cloud Storage. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SftpLocation

Name Description Value
type Type of dataset storage location. 'SftpLocation' (required)

AzureBlobDataset

Name Description Value
type Type of dataset. 'AzureBlob' (required)
typeProperties Azure Blob dataset properties. AzureBlobDatasetTypeProperties

AzureBlobDatasetTypeProperties

Name Description Value
compression The data compression method used for the blob storage. DatasetCompression
fileName The name of the Azure Blob. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
folderPath The path of the Azure Blob storage. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
format The format of the Azure Blob storage. DatasetStorageFormat
modifiedDatetimeEnd The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
modifiedDatetimeStart The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableRootLocation The root of blob path. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureBlobFSDataset

Name Description Value
type Type of dataset. 'AzureBlobFSFile' (required)
typeProperties Azure Data Lake Storage Gen2 dataset properties. AzureBlobFSDatasetTypeProperties

AzureBlobFSDatasetTypeProperties

Name Description Value
compression The data compression method used for the blob storage. DatasetCompression
fileName The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
folderPath The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
format The format of the Azure Data Lake Storage Gen2 storage. DatasetStorageFormat

AzureDatabricksDeltaLakeDataset

Name Description Value
type Type of dataset. 'AzureDatabricksDeltaLakeDataset' (required)
typeProperties Properties specific to this dataset type. AzureDatabricksDeltaLakeDatasetTypeProperties

AzureDatabricksDeltaLakeDatasetTypeProperties

Name Description Value
database The database name of delta table. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The name of delta table. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureDataExplorerTableDataset

Name Description Value
type Type of dataset. 'AzureDataExplorerTable' (required)
typeProperties Azure Data Explorer (Kusto) dataset properties. AzureDataExplorerDatasetTypeProperties (required)

AzureDataExplorerDatasetTypeProperties

Name Description Value
table The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureDataLakeStoreDataset

Name Description Value
type Type of dataset. 'AzureDataLakeStoreFile' (required)
typeProperties Azure Data Lake Store dataset properties. AzureDataLakeStoreDatasetTypeProperties

AzureDataLakeStoreDatasetTypeProperties

Name Description Value
compression The data compression method used for the item(s) in the Azure Data Lake Store. DatasetCompression
fileName The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
folderPath Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
format The format of the Data Lake Store. DatasetStorageFormat

AzureMariaDBTableDataset

Name Description Value
type Type of dataset. 'AzureMariaDBTable' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

AzureMySqlTableDataset

Name Description Value
type Type of dataset. 'AzureMySqlTable' (required)
typeProperties Azure MySQL database dataset properties. AzureMySqlTableDatasetTypeProperties (required)

AzureMySqlTableDatasetTypeProperties

Name Description Value
table The name of Azure MySQL database table. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName The Azure MySQL database table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzurePostgreSqlTableDataset

Name Description Value
type Type of dataset. 'AzurePostgreSqlTable' (required)
typeProperties Properties specific to this dataset type. AzurePostgreSqlTableDatasetTypeProperties

AzurePostgreSqlTableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

AzureSearchIndexDataset

Name Description Value
type Type of dataset. 'AzureSearchIndex' (required)
typeProperties Properties specific to this dataset type. AzureSearchIndexDatasetTypeProperties (required)

AzureSearchIndexDatasetTypeProperties

Name Description Value
indexName The name of the Azure Search Index. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

AzureSqlDWTableDataset

Name Description Value
type Type of dataset. 'AzureSqlDWTable' (required)
typeProperties Azure SQL Data Warehouse dataset properties. AzureSqlDWTableDatasetTypeProperties

AzureSqlDWTableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

AzureSqlMITableDataset

Name Description Value
type Type of dataset. 'AzureSqlMITable' (required)
typeProperties Azure SQL Managed Instance dataset properties. AzureSqlMITableDatasetTypeProperties

AzureSqlMITableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

AzureSqlTableDataset

Name Description Value
type Type of dataset. 'AzureSqlTable' (required)
typeProperties Azure SQL dataset properties. AzureSqlTableDatasetTypeProperties

AzureSqlTableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure SQL database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Azure SQL database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

AzureTableDataset

Name Description Value
type Type of dataset. 'AzureTable' (required)
typeProperties Azure Table dataset properties. AzureTableDatasetTypeProperties (required)

AzureTableDatasetTypeProperties

Name Description Value
tableName The table name of the Azure Table storage. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

BinaryDataset

Name Description Value
type Type of dataset. 'Binary' (required)
typeProperties Binary dataset properties. BinaryDatasetTypeProperties

BinaryDatasetTypeProperties

Name Description Value
compression The data compression method used for the binary dataset. DatasetCompression
location The location of the Binary storage. DatasetLocation (required)

CassandraTableDataset

Name Description Value
type Type of dataset. 'CassandraTable' (required)
typeProperties Cassandra dataset properties. CassandraTableDatasetTypeProperties

CassandraTableDatasetTypeProperties

Name Description Value
keyspace The keyspace of the Cassandra database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName The table name of the Cassandra database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

CommonDataServiceForAppsEntityDataset

Name Description Value
type Type of dataset. 'CommonDataServiceForAppsEntity' (required)
typeProperties Common Data Service for Apps entity dataset properties. CommonDataServiceForAppsEntityDatasetTypeProperties

CommonDataServiceForAppsEntityDatasetTypeProperties

Name Description Value
entityName The logical name of the entity. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

ConcurObjectDataset

Name Description Value
type Type of dataset. 'ConcurObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

CosmosDbMongoDbApiCollectionDataset

Name Description Value
type Type of dataset. 'CosmosDbMongoDbApiCollection' (required)
typeProperties CosmosDB (MongoDB API) database dataset properties. CosmosDbMongoDbApiCollectionDatasetTypeProperties (required)

CosmosDbMongoDbApiCollectionDatasetTypeProperties

Name Description Value
collection The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

CosmosDbSqlApiCollectionDataset

Name Description Value
type Type of dataset. 'CosmosDbSqlApiCollection' (required)
typeProperties CosmosDB (SQL API) Collection dataset properties. CosmosDbSqlApiCollectionDatasetTypeProperties (required)

CosmosDbSqlApiCollectionDatasetTypeProperties

Name Description Value
collectionName CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

CouchbaseTableDataset

Name Description Value
type Type of dataset. 'CouchbaseTable' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

CustomDataset

Name Description Value
type Type of dataset. 'CustomDataset' (required)
typeProperties Custom dataset properties. For Bicep, you can use the any() function.

Db2TableDataset

Name Description Value
type Type of dataset. 'Db2Table' (required)
typeProperties Db2 table dataset properties. Db2TableDatasetTypeProperties

Db2TableDatasetTypeProperties

Name Description Value
schema The Db2 schema name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The Db2 table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

DelimitedTextDataset

Name Description Value
type Type of dataset. 'DelimitedText' (required)
typeProperties Delimited text dataset properties. DelimitedTextDatasetTypeProperties

DelimitedTextDatasetTypeProperties

Name Description Value
columnDelimiter The column delimiter. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
compressionCodec The data compressionCodec. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
compressionLevel The data compression method used for DelimitedText. For Bicep, you can use the any() function.
encodingName The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
escapeChar The escape character. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
firstRowAsHeader When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
location The location of the delimited text storage. DatasetLocation (required)
nullValue The null value string. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
quoteChar The quote character. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
rowDelimiter The row delimiter. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

DocumentDbCollectionDataset

Name Description Value
type Type of dataset. 'DocumentDbCollection' (required)
typeProperties DocumentDB Collection dataset properties. DocumentDbCollectionDatasetTypeProperties (required)

DocumentDbCollectionDatasetTypeProperties

Name Description Value
collectionName Document Database collection name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

DrillTableDataset

Name Description Value
type Type of dataset. 'DrillTable' (required)
typeProperties Properties specific to this dataset type. DrillDatasetTypeProperties

DrillDatasetTypeProperties

Name Description Value
schema The schema name of the Drill. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Drill. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

DynamicsAXResourceDataset

Name Description Value
type Type of dataset. 'DynamicsAXResource' (required)
typeProperties Dynamics AX OData resource dataset properties. DynamicsAXResourceDatasetTypeProperties (required)

DynamicsAXResourceDatasetTypeProperties

Name Description Value
path The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

DynamicsCrmEntityDataset

Name Description Value
type Type of dataset. 'DynamicsCrmEntity' (required)
typeProperties Dynamics CRM entity dataset properties. DynamicsCrmEntityDatasetTypeProperties

DynamicsCrmEntityDatasetTypeProperties

Name Description Value
entityName The logical name of the entity. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

DynamicsEntityDataset

Name Description Value
type Type of dataset. 'DynamicsEntity' (required)
typeProperties Dynamics entity dataset properties. DynamicsEntityDatasetTypeProperties

DynamicsEntityDatasetTypeProperties

Name Description Value
entityName The logical name of the entity. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

EloquaObjectDataset

Name Description Value
type Type of dataset. 'EloquaObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

ExcelDataset

Name Description Value
type Type of dataset. 'Excel' (required)
typeProperties Excel dataset properties. ExcelDatasetTypeProperties

ExcelDatasetTypeProperties

Name Description Value
compression The data compression method used for the json dataset. DatasetCompression
firstRowAsHeader When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
location The location of the excel storage. DatasetLocation (required)
nullValue The null value string. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
range The partial data of one sheet. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
sheetIndex The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer) For Bicep, you can use the any() function.
sheetName The sheet name of excel file. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

FileShareDataset

Name Description Value
type Type of dataset. 'FileShare' (required)
typeProperties On-premises file system dataset properties. FileShareDatasetTypeProperties

FileShareDatasetTypeProperties

Name Description Value
compression The data compression method used for the file system. DatasetCompression
fileFilter Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
fileName The name of the on-premises file system. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
folderPath The path of the on-premises file system. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
format The format of the files. DatasetStorageFormat
modifiedDatetimeEnd The end of file's modified datetime. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
modifiedDatetimeStart The start of file's modified datetime. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

GoogleAdWordsObjectDataset

Name Description Value
type Type of dataset. 'GoogleAdWordsObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

GoogleBigQueryObjectDataset

Name Description Value
type Type of dataset. 'GoogleBigQueryObject' (required)
typeProperties Properties specific to this dataset type. GoogleBigQueryDatasetTypeProperties

GoogleBigQueryDatasetTypeProperties

Name Description Value
dataset The database name of the Google BigQuery. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Google BigQuery. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using database + table properties instead. For Bicep, you can use the any() function.

GoogleBigQueryV2ObjectDataset

Name Description Value
type Type of dataset. 'GoogleBigQueryV2Object' (required)
typeProperties Properties specific to this dataset type. GoogleBigQueryV2DatasetTypeProperties

GoogleBigQueryV2DatasetTypeProperties

Name Description Value
dataset The database name of the Google BigQuery. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Google BigQuery. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

GreenplumTableDataset

Name Description Value
type Type of dataset. 'GreenplumTable' (required)
typeProperties Properties specific to this dataset type. GreenplumDatasetTypeProperties

GreenplumDatasetTypeProperties

Name Description Value
schema The schema name of Greenplum. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of Greenplum. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

HBaseObjectDataset

Name Description Value
type Type of dataset. 'HBaseObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

HiveObjectDataset

Name Description Value
type Type of dataset. 'HiveObject' (required)
typeProperties Properties specific to this dataset type. HiveDatasetTypeProperties

HiveDatasetTypeProperties

Name Description Value
schema The schema name of the Hive. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Hive. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

HttpDataset

Name Description Value
type Type of dataset. 'HttpFile' (required)
typeProperties Properties specific to this dataset type. HttpDatasetTypeProperties

HttpDatasetTypeProperties

Name Description Value
additionalHeaders The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1
...
request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).
For Bicep, you can use the any() function.
compression The data compression method used on files. DatasetCompression
format The format of files. DatasetStorageFormat
relativeUrl The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
requestBody The body for the HTTP request. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
requestMethod The HTTP method for the HTTP request. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

HubspotObjectDataset

Name Description Value
type Type of dataset. 'HubspotObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

ImpalaObjectDataset

Name Description Value
type Type of dataset. 'ImpalaObject' (required)
typeProperties Properties specific to this dataset type. ImpalaDatasetTypeProperties

ImpalaDatasetTypeProperties

Name Description Value
schema The schema name of the Impala. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Impala. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

InformixTableDataset

Name Description Value
type Type of dataset. 'InformixTable' (required)
typeProperties Informix table dataset properties. InformixTableDatasetTypeProperties

InformixTableDatasetTypeProperties

Name Description Value
tableName The Informix table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

JiraObjectDataset

Name Description Value
type Type of dataset. 'JiraObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

JsonDataset

Name Description Value
type Type of dataset. 'Json' (required)
typeProperties Json dataset properties. JsonDatasetTypeProperties

JsonDatasetTypeProperties

Name Description Value
compression The data compression method used for the json dataset. DatasetCompression
encodingName The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
location The location of the json data storage. DatasetLocation (required)

LakeHouseTableDataset

Name Description Value
type Type of dataset. 'LakeHouseTable' (required)
typeProperties Microsoft Fabric LakeHouse Table dataset properties. LakeHouseTableDatasetTypeProperties

LakeHouseTableDatasetTypeProperties

Name Description Value
table The name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

MagentoObjectDataset

Name Description Value
type Type of dataset. 'MagentoObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

MariaDBTableDataset

Name Description Value
type Type of dataset. 'MariaDBTable' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

MarketoObjectDataset

Name Description Value
type Type of dataset. 'MarketoObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

MicrosoftAccessTableDataset

Name Description Value
type Type of dataset. 'MicrosoftAccessTable' (required)
typeProperties Microsoft Access table dataset properties. MicrosoftAccessTableDatasetTypeProperties

MicrosoftAccessTableDatasetTypeProperties

Name Description Value
tableName The Microsoft Access table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

MongoDbAtlasCollectionDataset

Name Description Value
type Type of dataset. 'MongoDbAtlasCollection' (required)
typeProperties MongoDB Atlas database dataset properties. MongoDbAtlasCollectionDatasetTypeProperties (required)

MongoDbAtlasCollectionDatasetTypeProperties

Name Description Value
collection The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

MongoDbCollectionDataset

Name Description Value
type Type of dataset. 'MongoDbCollection' (required)
typeProperties MongoDB database dataset properties. MongoDbCollectionDatasetTypeProperties (required)

MongoDbCollectionDatasetTypeProperties

Name Description Value
collectionName The table name of the MongoDB database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

MongoDbV2CollectionDataset

Name Description Value
type Type of dataset. 'MongoDbV2Collection' (required)
typeProperties MongoDB database dataset properties. MongoDbV2CollectionDatasetTypeProperties (required)

MongoDbV2CollectionDatasetTypeProperties

Name Description Value
collection The collection name of the MongoDB database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

MySqlTableDataset

Name Description Value
type Type of dataset. 'MySqlTable' (required)
typeProperties MySQL table dataset properties. MySqlTableDatasetTypeProperties

MySqlTableDatasetTypeProperties

Name Description Value
tableName The MySQL table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

NetezzaTableDataset

Name Description Value
type Type of dataset. 'NetezzaTable' (required)
typeProperties Properties specific to this dataset type. NetezzaTableDatasetTypeProperties

NetezzaTableDatasetTypeProperties

Name Description Value
schema The schema name of the Netezza. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Netezza. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

ODataResourceDataset

Name Description Value
type Type of dataset. 'ODataResource' (required)
typeProperties OData dataset properties. ODataResourceDatasetTypeProperties

ODataResourceDatasetTypeProperties

Name Description Value
path The OData resource path. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

OdbcTableDataset

Name Description Value
type Type of dataset. 'OdbcTable' (required)
typeProperties ODBC table dataset properties. OdbcTableDatasetTypeProperties

OdbcTableDatasetTypeProperties

Name Description Value
tableName The ODBC table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

Office365Dataset

Name Description Value
type Type of dataset. 'Office365Table' (required)
typeProperties Office365 dataset properties. Office365DatasetTypeProperties (required)

Office365DatasetTypeProperties

Name Description Value
predicate A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

OracleServiceCloudObjectDataset

Name Description Value
type Type of dataset. 'OracleServiceCloudObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

OracleTableDataset

Name Description Value
type Type of dataset. 'OracleTable' (required)
typeProperties On-premises Oracle dataset properties. OracleTableDatasetTypeProperties

OracleTableDatasetTypeProperties

Name Description Value
schema The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the on-premises Oracle database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

OrcDataset

Name Description Value
type Type of dataset. 'Orc' (required)
typeProperties ORC dataset properties. OrcDatasetTypeProperties

OrcDatasetTypeProperties

Name Description Value
location The location of the ORC data storage. DatasetLocation (required)
orcCompressionCodec The data orcCompressionCodec. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

ParquetDataset

Name Description Value
type Type of dataset. 'Parquet' (required)
typeProperties Parquet dataset properties. ParquetDatasetTypeProperties

ParquetDatasetTypeProperties

Name Description Value
compressionCodec The data compressionCodec. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
location The location of the parquet storage. DatasetLocation (required)

PaypalObjectDataset

Name Description Value
type Type of dataset. 'PaypalObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

PhoenixObjectDataset

Name Description Value
type Type of dataset. 'PhoenixObject' (required)
typeProperties Properties specific to this dataset type. PhoenixDatasetTypeProperties

PhoenixDatasetTypeProperties

Name Description Value
schema The schema name of the Phoenix. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Phoenix. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

PostgreSqlTableDataset

Name Description Value
type Type of dataset. 'PostgreSqlTable' (required)
typeProperties PostgreSQL table dataset properties. PostgreSqlTableDatasetTypeProperties

PostgreSqlTableDatasetTypeProperties

Name Description Value
schema The PostgreSQL schema name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The PostgreSQL table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

PostgreSqlV2TableDataset

Name Description Value
type Type of dataset. 'PostgreSqlV2Table' (required)
typeProperties PostgreSQLV2 table dataset properties. PostgreSqlV2TableDatasetTypeProperties

PostgreSqlV2TableDatasetTypeProperties

Name Description Value
schema The PostgreSQL schema name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The PostgreSQL table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

PrestoObjectDataset

Name Description Value
type Type of dataset. 'PrestoObject' (required)
typeProperties Properties specific to this dataset type. PrestoDatasetTypeProperties

PrestoDatasetTypeProperties

Name Description Value
schema The schema name of the Presto. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Presto. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

QuickBooksObjectDataset

Name Description Value
type Type of dataset. 'QuickBooksObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

RelationalTableDataset

Name Description Value
type Type of dataset. 'RelationalTable' (required)
typeProperties Relational table dataset properties. RelationalTableDatasetTypeProperties

RelationalTableDatasetTypeProperties

Name Description Value
tableName The relational table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

ResponsysObjectDataset

Name Description Value
type Type of dataset. 'ResponsysObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

RestResourceDataset

Name Description Value
type Type of dataset. 'RestResource' (required)
typeProperties Properties specific to this dataset type. RestResourceDatasetTypeProperties

RestResourceDatasetTypeProperties

Name Description Value
additionalHeaders The additional HTTP headers in the request to the RESTful API. RestResourceDatasetTypePropertiesAdditionalHeaders
paginationRules The pagination rules to compose next page requests. RestResourceDatasetTypePropertiesPaginationRules
relativeUrl The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
requestBody The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
requestMethod The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

RestResourceDatasetTypePropertiesAdditionalHeaders

Name Description Value
{customized property} For Bicep, you can use the any() function.

RestResourceDatasetTypePropertiesPaginationRules

Name Description Value
{customized property} For Bicep, you can use the any() function.

SalesforceMarketingCloudObjectDataset

Name Description Value
type Type of dataset. 'SalesforceMarketingCloudObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SalesforceObjectDataset

Name Description Value
type Type of dataset. 'SalesforceObject' (required)
typeProperties Salesforce object dataset properties. SalesforceObjectDatasetTypeProperties

SalesforceObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce object API name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SalesforceServiceCloudObjectDataset

Name Description Value
type Type of dataset. 'SalesforceServiceCloudObject' (required)
typeProperties Salesforce Service Cloud object dataset properties. SalesforceServiceCloudObjectDatasetTypeProperties

SalesforceServiceCloudObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SalesforceServiceCloudV2ObjectDataset

Name Description Value
type Type of dataset. 'SalesforceServiceCloudV2Object' (required)
typeProperties Salesforce Service Cloud V2 object dataset properties. SalesforceServiceCloudV2ObjectDatasetTypeProperties

SalesforceServiceCloudV2ObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce Service Cloud V2 object API name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
reportId The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SalesforceV2ObjectDataset

Name Description Value
type Type of dataset. 'SalesforceV2Object' (required)
typeProperties Salesforce V2 object dataset properties. SalesforceV2ObjectDatasetTypeProperties

SalesforceV2ObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce V2 object API name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
reportId The Salesforce V2 report Id. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SapBwCubeDataset

Name Description Value
type Type of dataset. 'SapBwCube' (required)

SapCloudForCustomerResourceDataset

Name Description Value
type Type of dataset. 'SapCloudForCustomerResource' (required)
typeProperties SAP Cloud For Customer OData resource dataset properties. SapCloudForCustomerResourceDatasetTypeProperties (required)

SapCloudForCustomerResourceDatasetTypeProperties

Name Description Value
path The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

SapEccResourceDataset

Name Description Value
type Type of dataset. 'SapEccResource' (required)
typeProperties SAP ECC OData resource dataset properties. SapEccResourceDatasetTypeProperties (required)

SapEccResourceDatasetTypeProperties

Name Description Value
path The path of the SAP ECC OData entity. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

SapHanaTableDataset

Name Description Value
type Type of dataset. 'SapHanaTable' (required)
typeProperties SAP HANA Table properties. SapHanaTableDatasetTypeProperties

SapHanaTableDatasetTypeProperties

Name Description Value
schema The schema name of SAP HANA. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of SAP HANA. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SapOdpResourceDataset

Name Description Value
type Type of dataset. 'SapOdpResource' (required)
typeProperties SAP ODP Resource properties. SapOdpResourceDatasetTypeProperties (required)

SapOdpResourceDatasetTypeProperties

Name Description Value
context The context of the SAP ODP Object. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)
objectName The name of the SAP ODP Object. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

SapOpenHubTableDataset

Name Description Value
type Type of dataset. 'SapOpenHubTable' (required)
typeProperties Sap Business Warehouse Open Hub Destination Table properties. SapOpenHubTableDatasetTypeProperties (required)

SapOpenHubTableDatasetTypeProperties

Name Description Value
baseRequestId The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ). For Bicep, you can use the any() function.
excludeLastRequest Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean). For Bicep, you can use the any() function.
openHubDestinationName The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

SapTableResourceDataset

Name Description Value
type Type of dataset. 'SapTableResource' (required)
typeProperties SAP Table Resource properties. SapTableResourceDatasetTypeProperties (required)

SapTableResourceDatasetTypeProperties

Name Description Value
tableName The name of the SAP Table. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.(required)

ServiceNowObjectDataset

Name Description Value
type Type of dataset. 'ServiceNowObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

ServiceNowV2ObjectDataset

Name Description Value
type Type of dataset. 'ServiceNowV2Object' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SharePointOnlineListResourceDataset

Name Description Value
type Type of dataset. 'SharePointOnlineListResource' (required)
typeProperties Sharepoint online list dataset properties. SharePointOnlineListDatasetTypeProperties

SharePointOnlineListDatasetTypeProperties

Name Description Value
listName The name of the SharePoint Online list. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

ShopifyObjectDataset

Name Description Value
type Type of dataset. 'ShopifyObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SnowflakeDataset

Name Description Value
type Type of dataset. 'SnowflakeTable' (required)
typeProperties Snowflake dataset properties. SnowflakeDatasetTypeProperties (required)

SnowflakeDatasetTypeProperties

Name Description Value
schema The schema name of the Snowflake database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Snowflake database. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

SnowflakeV2Dataset

Name Description Value
type Type of dataset. 'SnowflakeV2Table' (required)
typeProperties Snowflake dataset properties. SnowflakeDatasetTypeProperties (required)

SparkObjectDataset

Name Description Value
type Type of dataset. 'SparkObject' (required)
typeProperties Properties specific to this dataset type. SparkDatasetTypeProperties

SparkDatasetTypeProperties

Name Description Value
schema The schema name of the Spark. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Spark. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

SqlServerTableDataset

Name Description Value
type Type of dataset. 'SqlServerTable' (required)
typeProperties On-premises SQL Server dataset properties. SqlServerTableDatasetTypeProperties

SqlServerTableDatasetTypeProperties

Name Description Value
schema The schema name of the SQL Server dataset. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the SQL Server dataset. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

SquareObjectDataset

Name Description Value
type Type of dataset. 'SquareObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SybaseTableDataset

Name Description Value
type Type of dataset. 'SybaseTable' (required)
typeProperties Sybase table dataset properties. SybaseTableDatasetTypeProperties

SybaseTableDatasetTypeProperties

Name Description Value
tableName The Sybase table name. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

TeradataTableDataset

Name Description Value
type Type of dataset. 'TeradataTable' (required)
typeProperties Teradata dataset properties. TeradataTableDatasetTypeProperties

TeradataTableDatasetTypeProperties

Name Description Value
database The database name of Teradata. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of Teradata. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

VerticaTableDataset

Name Description Value
type Type of dataset. 'VerticaTable' (required)
typeProperties Properties specific to this dataset type. VerticaDatasetTypeProperties

VerticaDatasetTypeProperties

Name Description Value
schema The schema name of the Vertica. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Vertica. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
tableName This property will be retired. Please consider using schema + table properties instead. For Bicep, you can use the any() function.

WarehouseTableDataset

Name Description Value
type Type of dataset. 'WarehouseTable' (required)
typeProperties Microsoft Fabric Warehouse dataset properties. WarehouseTableDatasetTypeProperties

WarehouseTableDatasetTypeProperties

Name Description Value
schema The schema name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
table The table name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

WebTableDataset

Name Description Value
type Type of dataset. 'WebTable' (required)
typeProperties Web table dataset properties. WebTableDatasetTypeProperties (required)

WebTableDatasetTypeProperties

Name Description Value
index The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0. For Bicep, you can use the any() function.(required)
path The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

XeroObjectDataset

Name Description Value
type Type of dataset. 'XeroObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

XmlDataset

Name Description Value
type Type of dataset. 'Xml' (required)
typeProperties Xml dataset properties. XmlDatasetTypeProperties

XmlDatasetTypeProperties

Name Description Value
compression The data compression method used for the json dataset. DatasetCompression
encodingName The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.
location The location of the json data storage. DatasetLocation (required)
nullValue The null value string. Type: string (or Expression with resultType string). For Bicep, you can use the any() function.

ZohoObjectDataset

Name Description Value
type Type of dataset. 'ZohoObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
More is possible with Azure Data Factory - One click to try Azure Data Factory

Deploy to Azure
This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob
Create a Data Factory, copy from Salesforce to Blob

Deploy to Azure
This template uses Azure Data Factory to perform data movement from Salesforce to Azure Blobs
Bulk copy using Azure Data Factory

Deploy to Azure
This template creates a V2 data factory that copies data in bulk an Azure SQL database to an Azure SQL data warehouse.
Create a V2 data factory

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage.
Create a V2 data factory (MySQL)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for MySQL.
Create a V2 data factory (PostGre)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for PostgreSQL.
Create a V2 data factory (SQL)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure SQL database.
Create a V2 data factory (SQL On-prem)

Deploy to Azure
This template creates a V2 data factory that copies data from an on-premises SQL Server to an Azure blob storage

ARM template resource definition

The factories/datasets resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/datasets resource, add the following JSON to your template.

{
  "type": "Microsoft.DataFactory/factories/datasets",
  "apiVersion": "2018-06-01",
  "name": "string",
  "properties": {
    "annotations": [ object ],
    "description": "string",
    "folder": {
      "name": "string"
    },
    "linkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "parameters": {
      "{customized property}": {
        "defaultValue": {},
        "type": "string"
      }
    },
    "schema": {},
    "structure": {},
    "type": "string"
    // For remaining properties, see Dataset objects
  }
}

Dataset objects

Set the type property to specify the type of object.

For AmazonMWSObject, use:

  "type": "AmazonMWSObject",
  "typeProperties": {
    "tableName": {}
  }

For AmazonRdsForOracleTable, use:

  "type": "AmazonRdsForOracleTable",
  "typeProperties": {
    "schema": {},
    "table": {}
  }

For AmazonRdsForSqlServerTable, use:

  "type": "AmazonRdsForSqlServerTable",
  "typeProperties": {
    "schema": {},
    "table": {}
  }

For AmazonRedshiftTable, use:

  "type": "AmazonRedshiftTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For AmazonS3Object, use:

  "type": "AmazonS3Object",
  "typeProperties": {
    "bucketName": {},
    "compression": {
      "level": {},
      "type": {},
      "{customized property}": {}
    },
    "format": {
      "deserializer": {},
      "serializer": {},
      "type": "string"
      // For remaining properties, see DatasetStorageFormat objects
    },
    "key": {},
    "modifiedDatetimeEnd": {},
    "modifiedDatetimeStart": {},
    "prefix": {},
    "version": {}
  }

For Avro, use:

  "type": "Avro",
  "typeProperties": {
    "avroCompressionCodec": {},
    "avroCompressionLevel": "int",
    "location": {
      "fileName": {},
      "folderPath": {},
      "type": "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For AzureBlob, use:

  "type": "AzureBlob",
  "typeProperties": {
    "compression": {
      "level": {},
      "type": {},
      "{customized property}": {}
    },
    "fileName": {},
    "folderPath": {},
    "format": {
      "deserializer": {},
      "serializer": {},
      "type": "string"
      // For remaining properties, see DatasetStorageFormat objects
    },
    "modifiedDatetimeEnd": {},
    "modifiedDatetimeStart": {},
    "tableRootLocation": {}
  }

For AzureBlobFSFile, use:

  "type": "AzureBlobFSFile",
  "typeProperties": {
    "compression": {
      "level": {},
      "type": {},
      "{customized property}": {}
    },
    "fileName": {},
    "folderPath": {},
    "format": {
      "deserializer": {},
      "serializer": {},
      "type": "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }

For AzureDatabricksDeltaLakeDataset, use:

  "type": "AzureDatabricksDeltaLakeDataset",
  "typeProperties": {
    "database": {},
    "table": {}
  }

For AzureDataExplorerTable, use:

  "type": "AzureDataExplorerTable",
  "typeProperties": {
    "table": {}
  }

For AzureDataLakeStoreFile, use:

  "type": "AzureDataLakeStoreFile",
  "typeProperties": {
    "compression": {
      "level": {},
      "type": {},
      "{customized property}": {}
    },
    "fileName": {},
    "folderPath": {},
    "format": {
      "deserializer": {},
      "serializer": {},
      "type": "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }

For AzureMariaDBTable, use:

  "type": "AzureMariaDBTable",
  "typeProperties": {
    "tableName": {}
  }

For AzureMySqlTable, use:

  "type": "AzureMySqlTable",
  "typeProperties": {
    "table": {},
    "tableName": {}
  }

For AzurePostgreSqlTable, use:

  "type": "AzurePostgreSqlTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For AzureSearchIndex, use:

  "type": "AzureSearchIndex",
  "typeProperties": {
    "indexName": {}
  }

For AzureSqlDWTable, use:

  "type": "AzureSqlDWTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For AzureSqlMITable, use:

  "type": "AzureSqlMITable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For AzureSqlTable, use:

  "type": "AzureSqlTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For AzureTable, use:

  "type": "AzureTable",
  "typeProperties": {
    "tableName": {}
  }

For Binary, use:

  "type": "Binary",
  "typeProperties": {
    "compression": {
      "level": {},
      "type": {},
      "{customized property}": {}
    },
    "location": {
      "fileName": {},
      "folderPath": {},
      "type": "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For CassandraTable, use:

  "type": "CassandraTable",
  "typeProperties": {
    "keyspace": {},
    "tableName": {}
  }

For CommonDataServiceForAppsEntity, use:

  "type": "CommonDataServiceForAppsEntity",
  "typeProperties": {
    "entityName": {}
  }

For ConcurObject, use:

  "type": "ConcurObject",
  "typeProperties": {
    "tableName": {}
  }

For CosmosDbMongoDbApiCollection, use:

  "type": "CosmosDbMongoDbApiCollection",
  "typeProperties": {
    "collection": {}
  }

For CosmosDbSqlApiCollection, use:

  "type": "CosmosDbSqlApiCollection",
  "typeProperties": {
    "collectionName": {}
  }

For CouchbaseTable, use:

  "type": "CouchbaseTable",
  "typeProperties": {
    "tableName": {}
  }

For CustomDataset, use:

  "type": "CustomDataset",
  "typeProperties": {}

For Db2Table, use:

  "type": "Db2Table",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For DelimitedText, use:

  "type": "DelimitedText",
  "typeProperties": {
    "columnDelimiter": {},
    "compressionCodec": {},
    "compressionLevel": {},
    "encodingName": {},
    "escapeChar": {},
    "firstRowAsHeader": {},
    "location": {
      "fileName": {},
      "folderPath": {},
      "type": "string"
      // For remaining properties, see DatasetLocation objects
    },
    "nullValue": {},
    "quoteChar": {},
    "rowDelimiter": {}
  }

For DocumentDbCollection, use:

  "type": "DocumentDbCollection",
  "typeProperties": {
    "collectionName": {}
  }

For DrillTable, use:

  "type": "DrillTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For DynamicsAXResource, use:

  "type": "DynamicsAXResource",
  "typeProperties": {
    "path": {}
  }

For DynamicsCrmEntity, use:

  "type": "DynamicsCrmEntity",
  "typeProperties": {
    "entityName": {}
  }

For DynamicsEntity, use:

  "type": "DynamicsEntity",
  "typeProperties": {
    "entityName": {}
  }

For EloquaObject, use:

  "type": "EloquaObject",
  "typeProperties": {
    "tableName": {}
  }

For Excel, use:

  "type": "Excel",
  "typeProperties": {
    "compression": {
      "level": {},
      "type": {},
      "{customized property}": {}
    },
    "firstRowAsHeader": {},
    "location": {
      "fileName": {},
      "folderPath": {},
      "type": "string"
      // For remaining properties, see DatasetLocation objects
    },
    "nullValue": {},
    "range": {},
    "sheetIndex": {},
    "sheetName": {}
  }

For FileShare, use:

  "type": "FileShare",
  "typeProperties": {
    "compression": {
      "level": {},
      "type": {},
      "{customized property}": {}
    },
    "fileFilter": {},
    "fileName": {},
    "folderPath": {},
    "format": {
      "deserializer": {},
      "serializer": {},
      "type": "string"
      // For remaining properties, see DatasetStorageFormat objects
    },
    "modifiedDatetimeEnd": {},
    "modifiedDatetimeStart": {}
  }

For GoogleAdWordsObject, use:

  "type": "GoogleAdWordsObject",
  "typeProperties": {
    "tableName": {}
  }

For GoogleBigQueryObject, use:

  "type": "GoogleBigQueryObject",
  "typeProperties": {
    "dataset": {},
    "table": {},
    "tableName": {}
  }

For GoogleBigQueryV2Object, use:

  "type": "GoogleBigQueryV2Object",
  "typeProperties": {
    "dataset": {},
    "table": {}
  }

For GreenplumTable, use:

  "type": "GreenplumTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For HBaseObject, use:

  "type": "HBaseObject",
  "typeProperties": {
    "tableName": {}
  }

For HiveObject, use:

  "type": "HiveObject",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For HttpFile, use:

  "type": "HttpFile",
  "typeProperties": {
    "additionalHeaders": {},
    "compression": {
      "level": {},
      "type": {},
      "{customized property}": {}
    },
    "format": {
      "deserializer": {},
      "serializer": {},
      "type": "string"
      // For remaining properties, see DatasetStorageFormat objects
    },
    "relativeUrl": {},
    "requestBody": {},
    "requestMethod": {}
  }

For HubspotObject, use:

  "type": "HubspotObject",
  "typeProperties": {
    "tableName": {}
  }

For ImpalaObject, use:

  "type": "ImpalaObject",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For InformixTable, use:

  "type": "InformixTable",
  "typeProperties": {
    "tableName": {}
  }

For JiraObject, use:

  "type": "JiraObject",
  "typeProperties": {
    "tableName": {}
  }

For Json, use:

  "type": "Json",
  "typeProperties": {
    "compression": {
      "level": {},
      "type": {},
      "{customized property}": {}
    },
    "encodingName": {},
    "location": {
      "fileName": {},
      "folderPath": {},
      "type": "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For LakeHouseTable, use:

  "type": "LakeHouseTable",
  "typeProperties": {
    "table": {}
  }

For MagentoObject, use:

  "type": "MagentoObject",
  "typeProperties": {
    "tableName": {}
  }

For MariaDBTable, use:

  "type": "MariaDBTable",
  "typeProperties": {
    "tableName": {}
  }

For MarketoObject, use:

  "type": "MarketoObject",
  "typeProperties": {
    "tableName": {}
  }

For MicrosoftAccessTable, use:

  "type": "MicrosoftAccessTable",
  "typeProperties": {
    "tableName": {}
  }

For MongoDbAtlasCollection, use:

  "type": "MongoDbAtlasCollection",
  "typeProperties": {
    "collection": {}
  }

For MongoDbCollection, use:

  "type": "MongoDbCollection",
  "typeProperties": {
    "collectionName": {}
  }

For MongoDbV2Collection, use:

  "type": "MongoDbV2Collection",
  "typeProperties": {
    "collection": {}
  }

For MySqlTable, use:

  "type": "MySqlTable",
  "typeProperties": {
    "tableName": {}
  }

For NetezzaTable, use:

  "type": "NetezzaTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For ODataResource, use:

  "type": "ODataResource",
  "typeProperties": {
    "path": {}
  }

For OdbcTable, use:

  "type": "OdbcTable",
  "typeProperties": {
    "tableName": {}
  }

For Office365Table, use:

  "type": "Office365Table",
  "typeProperties": {
    "predicate": {},
    "tableName": {}
  }

For OracleServiceCloudObject, use:

  "type": "OracleServiceCloudObject",
  "typeProperties": {
    "tableName": {}
  }

For OracleTable, use:

  "type": "OracleTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For Orc, use:

  "type": "Orc",
  "typeProperties": {
    "location": {
      "fileName": {},
      "folderPath": {},
      "type": "string"
      // For remaining properties, see DatasetLocation objects
    },
    "orcCompressionCodec": {}
  }

For Parquet, use:

  "type": "Parquet",
  "typeProperties": {
    "compressionCodec": {},
    "location": {
      "fileName": {},
      "folderPath": {},
      "type": "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For PaypalObject, use:

  "type": "PaypalObject",
  "typeProperties": {
    "tableName": {}
  }

For PhoenixObject, use:

  "type": "PhoenixObject",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For PostgreSqlTable, use:

  "type": "PostgreSqlTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For PostgreSqlV2Table, use:

  "type": "PostgreSqlV2Table",
  "typeProperties": {
    "schema": {},
    "table": {}
  }

For PrestoObject, use:

  "type": "PrestoObject",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For QuickBooksObject, use:

  "type": "QuickBooksObject",
  "typeProperties": {
    "tableName": {}
  }

For RelationalTable, use:

  "type": "RelationalTable",
  "typeProperties": {
    "tableName": {}
  }

For ResponsysObject, use:

  "type": "ResponsysObject",
  "typeProperties": {
    "tableName": {}
  }

For RestResource, use:

  "type": "RestResource",
  "typeProperties": {
    "additionalHeaders": {
      "{customized property}": {}
    },
    "paginationRules": {
      "{customized property}": {}
    },
    "relativeUrl": {},
    "requestBody": {},
    "requestMethod": {}
  }

For SalesforceMarketingCloudObject, use:

  "type": "SalesforceMarketingCloudObject",
  "typeProperties": {
    "tableName": {}
  }

For SalesforceObject, use:

  "type": "SalesforceObject",
  "typeProperties": {
    "objectApiName": {}
  }

For SalesforceServiceCloudObject, use:

  "type": "SalesforceServiceCloudObject",
  "typeProperties": {
    "objectApiName": {}
  }

For SalesforceServiceCloudV2Object, use:

  "type": "SalesforceServiceCloudV2Object",
  "typeProperties": {
    "objectApiName": {},
    "reportId": {}
  }

For SalesforceV2Object, use:

  "type": "SalesforceV2Object",
  "typeProperties": {
    "objectApiName": {},
    "reportId": {}
  }

For SapBwCube, use:

  "type": "SapBwCube"

For SapCloudForCustomerResource, use:

  "type": "SapCloudForCustomerResource",
  "typeProperties": {
    "path": {}
  }

For SapEccResource, use:

  "type": "SapEccResource",
  "typeProperties": {
    "path": {}
  }

For SapHanaTable, use:

  "type": "SapHanaTable",
  "typeProperties": {
    "schema": {},
    "table": {}
  }

For SapOdpResource, use:

  "type": "SapOdpResource",
  "typeProperties": {
    "context": {},
    "objectName": {}
  }

For SapOpenHubTable, use:

  "type": "SapOpenHubTable",
  "typeProperties": {
    "baseRequestId": {},
    "excludeLastRequest": {},
    "openHubDestinationName": {}
  }

For SapTableResource, use:

  "type": "SapTableResource",
  "typeProperties": {
    "tableName": {}
  }

For ServiceNowObject, use:

  "type": "ServiceNowObject",
  "typeProperties": {
    "tableName": {}
  }

For ServiceNowV2Object, use:

  "type": "ServiceNowV2Object",
  "typeProperties": {
    "tableName": {}
  }

For SharePointOnlineListResource, use:

  "type": "SharePointOnlineListResource",
  "typeProperties": {
    "listName": {}
  }

For ShopifyObject, use:

  "type": "ShopifyObject",
  "typeProperties": {
    "tableName": {}
  }

For SnowflakeTable, use:

  "type": "SnowflakeTable",
  "typeProperties": {
    "schema": {},
    "table": {}
  }

For SnowflakeV2Table, use:

  "type": "SnowflakeV2Table",
  "typeProperties": {
    "schema": {},
    "table": {}
  }

For SparkObject, use:

  "type": "SparkObject",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For SqlServerTable, use:

  "type": "SqlServerTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For SquareObject, use:

  "type": "SquareObject",
  "typeProperties": {
    "tableName": {}
  }

For SybaseTable, use:

  "type": "SybaseTable",
  "typeProperties": {
    "tableName": {}
  }

For TeradataTable, use:

  "type": "TeradataTable",
  "typeProperties": {
    "database": {},
    "table": {}
  }

For VerticaTable, use:

  "type": "VerticaTable",
  "typeProperties": {
    "schema": {},
    "table": {},
    "tableName": {}
  }

For WarehouseTable, use:

  "type": "WarehouseTable",
  "typeProperties": {
    "schema": {},
    "table": {}
  }

For WebTable, use:

  "type": "WebTable",
  "typeProperties": {
    "index": {},
    "path": {}
  }

For XeroObject, use:

  "type": "XeroObject",
  "typeProperties": {
    "tableName": {}
  }

For Xml, use:

  "type": "Xml",
  "typeProperties": {
    "compression": {
      "level": {},
      "type": {},
      "{customized property}": {}
    },
    "encodingName": {},
    "location": {
      "fileName": {},
      "folderPath": {},
      "type": "string"
      // For remaining properties, see DatasetLocation objects
    },
    "nullValue": {}
  }

For ZohoObject, use:

  "type": "ZohoObject",
  "typeProperties": {
    "tableName": {}
  }

DatasetStorageFormat objects

Set the type property to specify the type of object.

For AvroFormat, use:

  "type": "AvroFormat"

For JsonFormat, use:

  "type": "JsonFormat",
  "encodingName": {},
  "filePattern": {},
  "jsonNodeReference": {},
  "jsonPathDefinition": {},
  "nestingSeparator": {}

For OrcFormat, use:

  "type": "OrcFormat"

For ParquetFormat, use:

  "type": "ParquetFormat"

For TextFormat, use:

  "type": "TextFormat",
  "columnDelimiter": {},
  "encodingName": {},
  "escapeChar": {},
  "firstRowAsHeader": {},
  "nullValue": {},
  "quoteChar": {},
  "rowDelimiter": {},
  "skipLineCount": {},
  "treatEmptyAsNull": {}

DatasetLocation objects

Set the type property to specify the type of object.

For AmazonS3CompatibleLocation, use:

  "type": "AmazonS3CompatibleLocation",
  "bucketName": {},
  "version": {}

For AmazonS3Location, use:

  "type": "AmazonS3Location",
  "bucketName": {},
  "version": {}

For AzureBlobFSLocation, use:

  "type": "AzureBlobFSLocation",
  "fileSystem": {}

For AzureBlobStorageLocation, use:

  "type": "AzureBlobStorageLocation",
  "container": {}

For AzureDataLakeStoreLocation, use:

  "type": "AzureDataLakeStoreLocation"

For AzureFileStorageLocation, use:

  "type": "AzureFileStorageLocation"

For FileServerLocation, use:

  "type": "FileServerLocation"

For FtpServerLocation, use:

  "type": "FtpServerLocation"

For GoogleCloudStorageLocation, use:

  "type": "GoogleCloudStorageLocation",
  "bucketName": {},
  "version": {}

For HdfsLocation, use:

  "type": "HdfsLocation"

For HttpServerLocation, use:

  "type": "HttpServerLocation",
  "relativeUrl": {}

For LakeHouseLocation, use:

  "type": "LakeHouseLocation"

For OracleCloudStorageLocation, use:

  "type": "OracleCloudStorageLocation",
  "bucketName": {},
  "version": {}

For SftpLocation, use:

  "type": "SftpLocation"

Property values

factories/datasets

Name Description Value
type The resource type 'Microsoft.DataFactory/factories/datasets'
apiVersion The resource api version '2018-06-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)

Character limit: 1-260

Valid characters:
Can't use:
<>*#.%&:\\+?/- or control characters

Start with alphanumeric.
properties Dataset properties. Dataset (required)

Dataset

Name Description Value
annotations List of tags that can be used for describing the Dataset. any[]
description Dataset description. string
folder The folder that this Dataset is in. If not specified, Dataset will appear at the root level. DatasetFolder
linkedServiceName Linked service reference. LinkedServiceReference (required)
parameters Parameters for dataset. ParameterDefinitionSpecification
schema Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type Set the object type AmazonMWSObject
AmazonRdsForOracleTable
AmazonRdsForSqlServerTable
AmazonRedshiftTable
AmazonS3Object
Avro
AzureBlob
AzureBlobFSFile
AzureDatabricksDeltaLakeDataset
AzureDataExplorerTable
AzureDataLakeStoreFile
AzureMariaDBTable
AzureMySqlTable
AzurePostgreSqlTable
AzureSearchIndex
AzureSqlDWTable
AzureSqlMITable
AzureSqlTable
AzureTable
Binary
CassandraTable
CommonDataServiceForAppsEntity
ConcurObject
CosmosDbMongoDbApiCollection
CosmosDbSqlApiCollection
CouchbaseTable
CustomDataset
Db2Table
DelimitedText
DocumentDbCollection
DrillTable
DynamicsAXResource
DynamicsCrmEntity
DynamicsEntity
EloquaObject
Excel
FileShare
GoogleAdWordsObject
GoogleBigQueryObject
GoogleBigQueryV2Object
GreenplumTable
HBaseObject
HiveObject
HttpFile
HubspotObject
ImpalaObject
InformixTable
JiraObject
Json
LakeHouseTable
MagentoObject
MariaDBTable
MarketoObject
MicrosoftAccessTable
MongoDbAtlasCollection
MongoDbCollection
MongoDbV2Collection
MySqlTable
NetezzaTable
ODataResource
OdbcTable
Office365Table
OracleServiceCloudObject
OracleTable
Orc
Parquet
PaypalObject
PhoenixObject
PostgreSqlTable
PostgreSqlV2Table
PrestoObject
QuickBooksObject
RelationalTable
ResponsysObject
RestResource
SalesforceMarketingCloudObject
SalesforceObject
SalesforceServiceCloudObject
SalesforceServiceCloudV2Object
SalesforceV2Object
SapBwCube
SapCloudForCustomerResource
SapEccResource
SapHanaTable
SapOdpResource
SapOpenHubTable
SapTableResource
ServiceNowObject
ServiceNowV2Object
SharePointOnlineListResource
ShopifyObject
SnowflakeTable
SnowflakeV2Table
SparkObject
SqlServerTable
SquareObject
SybaseTable
TeradataTable
VerticaTable
WarehouseTable
WebTable
XeroObject
Xml
ZohoObject (required)

DatasetFolder

Name Description Value
name The name of the folder that this Dataset is in. string

LinkedServiceReference

Name Description Value
parameters Arguments for LinkedService. ParameterValueSpecification
referenceName Reference LinkedService name. string (required)
type Linked service reference type. 'LinkedServiceReference' (required)

ParameterValueSpecification

Name Description Value
{customized property}

ParameterDefinitionSpecification

Name Description Value
{customized property} ParameterSpecification

ParameterSpecification

Name Description Value
defaultValue Default value of parameter.
type Parameter type. 'Array'
'Bool'
'Float'
'Int'
'Object'
'SecureString'
'String' (required)

AmazonMWSObjectDataset

Name Description Value
type Type of dataset. 'AmazonMWSObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

GenericDatasetTypeProperties

Name Description Value
tableName The table name. Type: string (or Expression with resultType string).

AmazonRdsForOracleTableDataset

Name Description Value
type Type of dataset. 'AmazonRdsForOracleTable' (required)
typeProperties AmazonRdsForOracle dataset properties. AmazonRdsForOracleTableDatasetTypeProperties

AmazonRdsForOracleTableDatasetTypeProperties

Name Description Value
schema The schema name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).
table The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).

AmazonRdsForSqlServerTableDataset

Name Description Value
type Type of dataset. 'AmazonRdsForSqlServerTable' (required)
typeProperties The Amazon RDS for SQL Server dataset properties. AmazonRdsForSqlServerTableDatasetTypeProperties

AmazonRdsForSqlServerTableDatasetTypeProperties

Name Description Value
schema The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).
table The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

AmazonRedshiftTableDataset

Name Description Value
type Type of dataset. 'AmazonRedshiftTable' (required)
typeProperties Amazon Redshift table dataset properties. AmazonRedshiftTableDatasetTypeProperties

AmazonRedshiftTableDatasetTypeProperties

Name Description Value
schema The Amazon Redshift schema name. Type: string (or Expression with resultType string).
table The Amazon Redshift table name. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

AmazonS3Dataset

Name Description Value
type Type of dataset. 'AmazonS3Object' (required)
typeProperties Amazon S3 dataset properties. AmazonS3DatasetTypeProperties (required)

AmazonS3DatasetTypeProperties

Name Description Value
bucketName The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
compression The data compression method used for the Amazon S3 object. DatasetCompression
format The format of files. DatasetStorageFormat
key The key of the Amazon S3 object. Type: string (or Expression with resultType string).
modifiedDatetimeEnd The end of S3 object's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart The start of S3 object's modified datetime. Type: string (or Expression with resultType string).
prefix The prefix filter for the S3 object name. Type: string (or Expression with resultType string).
version The version for the S3 object. Type: string (or Expression with resultType string).

DatasetCompression

Name Description Value
level The dataset compression level. Type: string (or Expression with resultType string).
type Type of dataset compression. Type: string (or Expression with resultType string).
{customized property}

DatasetStorageFormat

Name Description Value
deserializer Deserializer. Type: string (or Expression with resultType string).
serializer Serializer. Type: string (or Expression with resultType string).
type Set the object type AvroFormat
JsonFormat
OrcFormat
ParquetFormat
TextFormat (required)

AvroFormat

Name Description Value
type Type of dataset storage format. 'AvroFormat' (required)

JsonFormat

Name Description Value
type Type of dataset storage format. 'JsonFormat' (required)
encodingName The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).
filePattern File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.
jsonNodeReference The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).
jsonPathDefinition The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object).
nestingSeparator The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).

OrcFormat

Name Description Value
type Type of dataset storage format. 'OrcFormat' (required)

ParquetFormat

Name Description Value
type Type of dataset storage format. 'ParquetFormat' (required)

TextFormat

Name Description Value
type Type of dataset storage format. 'TextFormat' (required)
columnDelimiter The column delimiter. Type: string (or Expression with resultType string).
encodingName The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
escapeChar The escape character. Type: string (or Expression with resultType string).
firstRowAsHeader When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
nullValue The null value string. Type: string (or Expression with resultType string).
quoteChar The quote character. Type: string (or Expression with resultType string).
rowDelimiter The row delimiter. Type: string (or Expression with resultType string).
skipLineCount The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).
treatEmptyAsNull Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).

AvroDataset

Name Description Value
type Type of dataset. 'Avro' (required)
typeProperties Avro dataset properties. AvroDatasetTypeProperties

AvroDatasetTypeProperties

Name Description Value
avroCompressionCodec The data avroCompressionCodec. Type: string (or Expression with resultType string).
avroCompressionLevel int

Constraints:
Min value = 1
Max value = 9
location The location of the avro storage. DatasetLocation (required)

DatasetLocation

Name Description Value
fileName Specify the file name of dataset. Type: string (or Expression with resultType string).
folderPath Specify the folder path of dataset. Type: string (or Expression with resultType string)
type Set the object type AmazonS3CompatibleLocation
AmazonS3Location
AzureBlobFSLocation
AzureBlobStorageLocation
AzureDataLakeStoreLocation
AzureFileStorageLocation
FileServerLocation
FtpServerLocation
GoogleCloudStorageLocation
HdfsLocation
HttpServerLocation
LakeHouseLocation
OracleCloudStorageLocation
SftpLocation (required)

AmazonS3CompatibleLocation

Name Description Value
type Type of dataset storage location. 'AmazonS3CompatibleLocation' (required)
bucketName Specify the bucketName of Amazon S3 Compatible. Type: string (or Expression with resultType string)
version Specify the version of Amazon S3 Compatible. Type: string (or Expression with resultType string).

AmazonS3Location

Name Description Value
type Type of dataset storage location. 'AmazonS3Location' (required)
bucketName Specify the bucketName of amazon S3. Type: string (or Expression with resultType string)
version Specify the version of amazon S3. Type: string (or Expression with resultType string).

AzureBlobFSLocation

Name Description Value
type Type of dataset storage location. 'AzureBlobFSLocation' (required)
fileSystem Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string).

AzureBlobStorageLocation

Name Description Value
type Type of dataset storage location. 'AzureBlobStorageLocation' (required)
container Specify the container of azure blob. Type: string (or Expression with resultType string).

AzureDataLakeStoreLocation

Name Description Value
type Type of dataset storage location. 'AzureDataLakeStoreLocation' (required)

AzureFileStorageLocation

Name Description Value
type Type of dataset storage location. 'AzureFileStorageLocation' (required)

FileServerLocation

Name Description Value
type Type of dataset storage location. 'FileServerLocation' (required)

FtpServerLocation

Name Description Value
type Type of dataset storage location. 'FtpServerLocation' (required)

GoogleCloudStorageLocation

Name Description Value
type Type of dataset storage location. 'GoogleCloudStorageLocation' (required)
bucketName Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string)
version Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string).

HdfsLocation

Name Description Value
type Type of dataset storage location. 'HdfsLocation' (required)

HttpServerLocation

Name Description Value
type Type of dataset storage location. 'HttpServerLocation' (required)
relativeUrl Specify the relativeUrl of http server. Type: string (or Expression with resultType string)

LakeHouseLocation

Name Description Value
type Type of dataset storage location. 'LakeHouseLocation' (required)

OracleCloudStorageLocation

Name Description Value
type Type of dataset storage location. 'OracleCloudStorageLocation' (required)
bucketName Specify the bucketName of Oracle Cloud Storage. Type: string (or Expression with resultType string)
version Specify the version of Oracle Cloud Storage. Type: string (or Expression with resultType string).

SftpLocation

Name Description Value
type Type of dataset storage location. 'SftpLocation' (required)

AzureBlobDataset

Name Description Value
type Type of dataset. 'AzureBlob' (required)
typeProperties Azure Blob dataset properties. AzureBlobDatasetTypeProperties

AzureBlobDatasetTypeProperties

Name Description Value
compression The data compression method used for the blob storage. DatasetCompression
fileName The name of the Azure Blob. Type: string (or Expression with resultType string).
folderPath The path of the Azure Blob storage. Type: string (or Expression with resultType string).
format The format of the Azure Blob storage. DatasetStorageFormat
modifiedDatetimeEnd The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string).
tableRootLocation The root of blob path. Type: string (or Expression with resultType string).

AzureBlobFSDataset

Name Description Value
type Type of dataset. 'AzureBlobFSFile' (required)
typeProperties Azure Data Lake Storage Gen2 dataset properties. AzureBlobFSDatasetTypeProperties

AzureBlobFSDatasetTypeProperties

Name Description Value
compression The data compression method used for the blob storage. DatasetCompression
fileName The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string).
folderPath The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string).
format The format of the Azure Data Lake Storage Gen2 storage. DatasetStorageFormat

AzureDatabricksDeltaLakeDataset

Name Description Value
type Type of dataset. 'AzureDatabricksDeltaLakeDataset' (required)
typeProperties Properties specific to this dataset type. AzureDatabricksDeltaLakeDatasetTypeProperties

AzureDatabricksDeltaLakeDatasetTypeProperties

Name Description Value
database The database name of delta table. Type: string (or Expression with resultType string).
table The name of delta table. Type: string (or Expression with resultType string).

AzureDataExplorerTableDataset

Name Description Value
type Type of dataset. 'AzureDataExplorerTable' (required)
typeProperties Azure Data Explorer (Kusto) dataset properties. AzureDataExplorerDatasetTypeProperties (required)

AzureDataExplorerDatasetTypeProperties

Name Description Value
table The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string).

AzureDataLakeStoreDataset

Name Description Value
type Type of dataset. 'AzureDataLakeStoreFile' (required)
typeProperties Azure Data Lake Store dataset properties. AzureDataLakeStoreDatasetTypeProperties

AzureDataLakeStoreDatasetTypeProperties

Name Description Value
compression The data compression method used for the item(s) in the Azure Data Lake Store. DatasetCompression
fileName The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string).
folderPath Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).
format The format of the Data Lake Store. DatasetStorageFormat

AzureMariaDBTableDataset

Name Description Value
type Type of dataset. 'AzureMariaDBTable' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

AzureMySqlTableDataset

Name Description Value
type Type of dataset. 'AzureMySqlTable' (required)
typeProperties Azure MySQL database dataset properties. AzureMySqlTableDatasetTypeProperties (required)

AzureMySqlTableDatasetTypeProperties

Name Description Value
table The name of Azure MySQL database table. Type: string (or Expression with resultType string).
tableName The Azure MySQL database table name. Type: string (or Expression with resultType string).

AzurePostgreSqlTableDataset

Name Description Value
type Type of dataset. 'AzurePostgreSqlTable' (required)
typeProperties Properties specific to this dataset type. AzurePostgreSqlTableDatasetTypeProperties

AzurePostgreSqlTableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).
table The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).
tableName The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string).

AzureSearchIndexDataset

Name Description Value
type Type of dataset. 'AzureSearchIndex' (required)
typeProperties Properties specific to this dataset type. AzureSearchIndexDatasetTypeProperties (required)

AzureSearchIndexDatasetTypeProperties

Name Description Value
indexName The name of the Azure Search Index. Type: string (or Expression with resultType string).

AzureSqlDWTableDataset

Name Description Value
type Type of dataset. 'AzureSqlDWTable' (required)
typeProperties Azure SQL Data Warehouse dataset properties. AzureSqlDWTableDatasetTypeProperties

AzureSqlDWTableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
table The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

AzureSqlMITableDataset

Name Description Value
type Type of dataset. 'AzureSqlMITable' (required)
typeProperties Azure SQL Managed Instance dataset properties. AzureSqlMITableDatasetTypeProperties

AzureSqlMITableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string).
table The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

AzureSqlTableDataset

Name Description Value
type Type of dataset. 'AzureSqlTable' (required)
typeProperties Azure SQL dataset properties. AzureSqlTableDatasetTypeProperties

AzureSqlTableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure SQL database. Type: string (or Expression with resultType string).
table The table name of the Azure SQL database. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

AzureTableDataset

Name Description Value
type Type of dataset. 'AzureTable' (required)
typeProperties Azure Table dataset properties. AzureTableDatasetTypeProperties (required)

AzureTableDatasetTypeProperties

Name Description Value
tableName The table name of the Azure Table storage. Type: string (or Expression with resultType string).

BinaryDataset

Name Description Value
type Type of dataset. 'Binary' (required)
typeProperties Binary dataset properties. BinaryDatasetTypeProperties

BinaryDatasetTypeProperties

Name Description Value
compression The data compression method used for the binary dataset. DatasetCompression
location The location of the Binary storage. DatasetLocation (required)

CassandraTableDataset

Name Description Value
type Type of dataset. 'CassandraTable' (required)
typeProperties Cassandra dataset properties. CassandraTableDatasetTypeProperties

CassandraTableDatasetTypeProperties

Name Description Value
keyspace The keyspace of the Cassandra database. Type: string (or Expression with resultType string).
tableName The table name of the Cassandra database. Type: string (or Expression with resultType string).

CommonDataServiceForAppsEntityDataset

Name Description Value
type Type of dataset. 'CommonDataServiceForAppsEntity' (required)
typeProperties Common Data Service for Apps entity dataset properties. CommonDataServiceForAppsEntityDatasetTypeProperties

CommonDataServiceForAppsEntityDatasetTypeProperties

Name Description Value
entityName The logical name of the entity. Type: string (or Expression with resultType string).

ConcurObjectDataset

Name Description Value
type Type of dataset. 'ConcurObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

CosmosDbMongoDbApiCollectionDataset

Name Description Value
type Type of dataset. 'CosmosDbMongoDbApiCollection' (required)
typeProperties CosmosDB (MongoDB API) database dataset properties. CosmosDbMongoDbApiCollectionDatasetTypeProperties (required)

CosmosDbMongoDbApiCollectionDatasetTypeProperties

Name Description Value
collection The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).

CosmosDbSqlApiCollectionDataset

Name Description Value
type Type of dataset. 'CosmosDbSqlApiCollection' (required)
typeProperties CosmosDB (SQL API) Collection dataset properties. CosmosDbSqlApiCollectionDatasetTypeProperties (required)

CosmosDbSqlApiCollectionDatasetTypeProperties

Name Description Value
collectionName CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string).

CouchbaseTableDataset

Name Description Value
type Type of dataset. 'CouchbaseTable' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

CustomDataset

Name Description Value
type Type of dataset. 'CustomDataset' (required)
typeProperties Custom dataset properties.

Db2TableDataset

Name Description Value
type Type of dataset. 'Db2Table' (required)
typeProperties Db2 table dataset properties. Db2TableDatasetTypeProperties

Db2TableDatasetTypeProperties

Name Description Value
schema The Db2 schema name. Type: string (or Expression with resultType string).
table The Db2 table name. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

DelimitedTextDataset

Name Description Value
type Type of dataset. 'DelimitedText' (required)
typeProperties Delimited text dataset properties. DelimitedTextDatasetTypeProperties

DelimitedTextDatasetTypeProperties

Name Description Value
columnDelimiter The column delimiter. Type: string (or Expression with resultType string).
compressionCodec The data compressionCodec. Type: string (or Expression with resultType string).
compressionLevel The data compression method used for DelimitedText.
encodingName The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
escapeChar The escape character. Type: string (or Expression with resultType string).
firstRowAsHeader When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
location The location of the delimited text storage. DatasetLocation (required)
nullValue The null value string. Type: string (or Expression with resultType string).
quoteChar The quote character. Type: string (or Expression with resultType string).
rowDelimiter The row delimiter. Type: string (or Expression with resultType string).

DocumentDbCollectionDataset

Name Description Value
type Type of dataset. 'DocumentDbCollection' (required)
typeProperties DocumentDB Collection dataset properties. DocumentDbCollectionDatasetTypeProperties (required)

DocumentDbCollectionDatasetTypeProperties

Name Description Value
collectionName Document Database collection name. Type: string (or Expression with resultType string).

DrillTableDataset

Name Description Value
type Type of dataset. 'DrillTable' (required)
typeProperties Properties specific to this dataset type. DrillDatasetTypeProperties

DrillDatasetTypeProperties

Name Description Value
schema The schema name of the Drill. Type: string (or Expression with resultType string).
table The table name of the Drill. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

DynamicsAXResourceDataset

Name Description Value
type Type of dataset. 'DynamicsAXResource' (required)
typeProperties Dynamics AX OData resource dataset properties. DynamicsAXResourceDatasetTypeProperties (required)

DynamicsAXResourceDatasetTypeProperties

Name Description Value
path The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string).

DynamicsCrmEntityDataset

Name Description Value
type Type of dataset. 'DynamicsCrmEntity' (required)
typeProperties Dynamics CRM entity dataset properties. DynamicsCrmEntityDatasetTypeProperties

DynamicsCrmEntityDatasetTypeProperties

Name Description Value
entityName The logical name of the entity. Type: string (or Expression with resultType string).

DynamicsEntityDataset

Name Description Value
type Type of dataset. 'DynamicsEntity' (required)
typeProperties Dynamics entity dataset properties. DynamicsEntityDatasetTypeProperties

DynamicsEntityDatasetTypeProperties

Name Description Value
entityName The logical name of the entity. Type: string (or Expression with resultType string).

EloquaObjectDataset

Name Description Value
type Type of dataset. 'EloquaObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

ExcelDataset

Name Description Value
type Type of dataset. 'Excel' (required)
typeProperties Excel dataset properties. ExcelDatasetTypeProperties

ExcelDatasetTypeProperties

Name Description Value
compression The data compression method used for the json dataset. DatasetCompression
firstRowAsHeader When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
location The location of the excel storage. DatasetLocation (required)
nullValue The null value string. Type: string (or Expression with resultType string).
range The partial data of one sheet. Type: string (or Expression with resultType string).
sheetIndex The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer)
sheetName The sheet name of excel file. Type: string (or Expression with resultType string).

FileShareDataset

Name Description Value
type Type of dataset. 'FileShare' (required)
typeProperties On-premises file system dataset properties. FileShareDatasetTypeProperties

FileShareDatasetTypeProperties

Name Description Value
compression The data compression method used for the file system. DatasetCompression
fileFilter Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).
fileName The name of the on-premises file system. Type: string (or Expression with resultType string).
folderPath The path of the on-premises file system. Type: string (or Expression with resultType string).
format The format of the files. DatasetStorageFormat
modifiedDatetimeEnd The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart The start of file's modified datetime. Type: string (or Expression with resultType string).

GoogleAdWordsObjectDataset

Name Description Value
type Type of dataset. 'GoogleAdWordsObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

GoogleBigQueryObjectDataset

Name Description Value
type Type of dataset. 'GoogleBigQueryObject' (required)
typeProperties Properties specific to this dataset type. GoogleBigQueryDatasetTypeProperties

GoogleBigQueryDatasetTypeProperties

Name Description Value
dataset The database name of the Google BigQuery. Type: string (or Expression with resultType string).
table The table name of the Google BigQuery. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using database + table properties instead.

GoogleBigQueryV2ObjectDataset

Name Description Value
type Type of dataset. 'GoogleBigQueryV2Object' (required)
typeProperties Properties specific to this dataset type. GoogleBigQueryV2DatasetTypeProperties

GoogleBigQueryV2DatasetTypeProperties

Name Description Value
dataset The database name of the Google BigQuery. Type: string (or Expression with resultType string).
table The table name of the Google BigQuery. Type: string (or Expression with resultType string).

GreenplumTableDataset

Name Description Value
type Type of dataset. 'GreenplumTable' (required)
typeProperties Properties specific to this dataset type. GreenplumDatasetTypeProperties

GreenplumDatasetTypeProperties

Name Description Value
schema The schema name of Greenplum. Type: string (or Expression with resultType string).
table The table name of Greenplum. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

HBaseObjectDataset

Name Description Value
type Type of dataset. 'HBaseObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

HiveObjectDataset

Name Description Value
type Type of dataset. 'HiveObject' (required)
typeProperties Properties specific to this dataset type. HiveDatasetTypeProperties

HiveDatasetTypeProperties

Name Description Value
schema The schema name of the Hive. Type: string (or Expression with resultType string).
table The table name of the Hive. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

HttpDataset

Name Description Value
type Type of dataset. 'HttpFile' (required)
typeProperties Properties specific to this dataset type. HttpDatasetTypeProperties

HttpDatasetTypeProperties

Name Description Value
additionalHeaders The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1
...
request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).
compression The data compression method used on files. DatasetCompression
format The format of files. DatasetStorageFormat
relativeUrl The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).
requestBody The body for the HTTP request. Type: string (or Expression with resultType string).
requestMethod The HTTP method for the HTTP request. Type: string (or Expression with resultType string).

HubspotObjectDataset

Name Description Value
type Type of dataset. 'HubspotObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

ImpalaObjectDataset

Name Description Value
type Type of dataset. 'ImpalaObject' (required)
typeProperties Properties specific to this dataset type. ImpalaDatasetTypeProperties

ImpalaDatasetTypeProperties

Name Description Value
schema The schema name of the Impala. Type: string (or Expression with resultType string).
table The table name of the Impala. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

InformixTableDataset

Name Description Value
type Type of dataset. 'InformixTable' (required)
typeProperties Informix table dataset properties. InformixTableDatasetTypeProperties

InformixTableDatasetTypeProperties

Name Description Value
tableName The Informix table name. Type: string (or Expression with resultType string).

JiraObjectDataset

Name Description Value
type Type of dataset. 'JiraObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

JsonDataset

Name Description Value
type Type of dataset. 'Json' (required)
typeProperties Json dataset properties. JsonDatasetTypeProperties

JsonDatasetTypeProperties

Name Description Value
compression The data compression method used for the json dataset. DatasetCompression
encodingName The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
location The location of the json data storage. DatasetLocation (required)

LakeHouseTableDataset

Name Description Value
type Type of dataset. 'LakeHouseTable' (required)
typeProperties Microsoft Fabric LakeHouse Table dataset properties. LakeHouseTableDatasetTypeProperties

LakeHouseTableDatasetTypeProperties

Name Description Value
table The name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string).

MagentoObjectDataset

Name Description Value
type Type of dataset. 'MagentoObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

MariaDBTableDataset

Name Description Value
type Type of dataset. 'MariaDBTable' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

MarketoObjectDataset

Name Description Value
type Type of dataset. 'MarketoObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

MicrosoftAccessTableDataset

Name Description Value
type Type of dataset. 'MicrosoftAccessTable' (required)
typeProperties Microsoft Access table dataset properties. MicrosoftAccessTableDatasetTypeProperties

MicrosoftAccessTableDatasetTypeProperties

Name Description Value
tableName The Microsoft Access table name. Type: string (or Expression with resultType string).

MongoDbAtlasCollectionDataset

Name Description Value
type Type of dataset. 'MongoDbAtlasCollection' (required)
typeProperties MongoDB Atlas database dataset properties. MongoDbAtlasCollectionDatasetTypeProperties (required)

MongoDbAtlasCollectionDatasetTypeProperties

Name Description Value
collection The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string).

MongoDbCollectionDataset

Name Description Value
type Type of dataset. 'MongoDbCollection' (required)
typeProperties MongoDB database dataset properties. MongoDbCollectionDatasetTypeProperties (required)

MongoDbCollectionDatasetTypeProperties

Name Description Value
collectionName The table name of the MongoDB database. Type: string (or Expression with resultType string).

MongoDbV2CollectionDataset

Name Description Value
type Type of dataset. 'MongoDbV2Collection' (required)
typeProperties MongoDB database dataset properties. MongoDbV2CollectionDatasetTypeProperties (required)

MongoDbV2CollectionDatasetTypeProperties

Name Description Value
collection The collection name of the MongoDB database. Type: string (or Expression with resultType string).

MySqlTableDataset

Name Description Value
type Type of dataset. 'MySqlTable' (required)
typeProperties MySQL table dataset properties. MySqlTableDatasetTypeProperties

MySqlTableDatasetTypeProperties

Name Description Value
tableName The MySQL table name. Type: string (or Expression with resultType string).

NetezzaTableDataset

Name Description Value
type Type of dataset. 'NetezzaTable' (required)
typeProperties Properties specific to this dataset type. NetezzaTableDatasetTypeProperties

NetezzaTableDatasetTypeProperties

Name Description Value
schema The schema name of the Netezza. Type: string (or Expression with resultType string).
table The table name of the Netezza. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

ODataResourceDataset

Name Description Value
type Type of dataset. 'ODataResource' (required)
typeProperties OData dataset properties. ODataResourceDatasetTypeProperties

ODataResourceDatasetTypeProperties

Name Description Value
path The OData resource path. Type: string (or Expression with resultType string).

OdbcTableDataset

Name Description Value
type Type of dataset. 'OdbcTable' (required)
typeProperties ODBC table dataset properties. OdbcTableDatasetTypeProperties

OdbcTableDatasetTypeProperties

Name Description Value
tableName The ODBC table name. Type: string (or Expression with resultType string).

Office365Dataset

Name Description Value
type Type of dataset. 'Office365Table' (required)
typeProperties Office365 dataset properties. Office365DatasetTypeProperties (required)

Office365DatasetTypeProperties

Name Description Value
predicate A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string).
tableName Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string).

OracleServiceCloudObjectDataset

Name Description Value
type Type of dataset. 'OracleServiceCloudObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

OracleTableDataset

Name Description Value
type Type of dataset. 'OracleTable' (required)
typeProperties On-premises Oracle dataset properties. OracleTableDatasetTypeProperties

OracleTableDatasetTypeProperties

Name Description Value
schema The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string).
table The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

OrcDataset

Name Description Value
type Type of dataset. 'Orc' (required)
typeProperties ORC dataset properties. OrcDatasetTypeProperties

OrcDatasetTypeProperties

Name Description Value
location The location of the ORC data storage. DatasetLocation (required)
orcCompressionCodec The data orcCompressionCodec. Type: string (or Expression with resultType string).

ParquetDataset

Name Description Value
type Type of dataset. 'Parquet' (required)
typeProperties Parquet dataset properties. ParquetDatasetTypeProperties

ParquetDatasetTypeProperties

Name Description Value
compressionCodec The data compressionCodec. Type: string (or Expression with resultType string).
location The location of the parquet storage. DatasetLocation (required)

PaypalObjectDataset

Name Description Value
type Type of dataset. 'PaypalObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

PhoenixObjectDataset

Name Description Value
type Type of dataset. 'PhoenixObject' (required)
typeProperties Properties specific to this dataset type. PhoenixDatasetTypeProperties

PhoenixDatasetTypeProperties

Name Description Value
schema The schema name of the Phoenix. Type: string (or Expression with resultType string).
table The table name of the Phoenix. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

PostgreSqlTableDataset

Name Description Value
type Type of dataset. 'PostgreSqlTable' (required)
typeProperties PostgreSQL table dataset properties. PostgreSqlTableDatasetTypeProperties

PostgreSqlTableDatasetTypeProperties

Name Description Value
schema The PostgreSQL schema name. Type: string (or Expression with resultType string).
table The PostgreSQL table name. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

PostgreSqlV2TableDataset

Name Description Value
type Type of dataset. 'PostgreSqlV2Table' (required)
typeProperties PostgreSQLV2 table dataset properties. PostgreSqlV2TableDatasetTypeProperties

PostgreSqlV2TableDatasetTypeProperties

Name Description Value
schema The PostgreSQL schema name. Type: string (or Expression with resultType string).
table The PostgreSQL table name. Type: string (or Expression with resultType string).

PrestoObjectDataset

Name Description Value
type Type of dataset. 'PrestoObject' (required)
typeProperties Properties specific to this dataset type. PrestoDatasetTypeProperties

PrestoDatasetTypeProperties

Name Description Value
schema The schema name of the Presto. Type: string (or Expression with resultType string).
table The table name of the Presto. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

QuickBooksObjectDataset

Name Description Value
type Type of dataset. 'QuickBooksObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

RelationalTableDataset

Name Description Value
type Type of dataset. 'RelationalTable' (required)
typeProperties Relational table dataset properties. RelationalTableDatasetTypeProperties

RelationalTableDatasetTypeProperties

Name Description Value
tableName The relational table name. Type: string (or Expression with resultType string).

ResponsysObjectDataset

Name Description Value
type Type of dataset. 'ResponsysObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

RestResourceDataset

Name Description Value
type Type of dataset. 'RestResource' (required)
typeProperties Properties specific to this dataset type. RestResourceDatasetTypeProperties

RestResourceDatasetTypeProperties

Name Description Value
additionalHeaders The additional HTTP headers in the request to the RESTful API. RestResourceDatasetTypePropertiesAdditionalHeaders
paginationRules The pagination rules to compose next page requests. RestResourceDatasetTypePropertiesPaginationRules
relativeUrl The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
requestBody The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
requestMethod The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

RestResourceDatasetTypePropertiesAdditionalHeaders

Name Description Value
{customized property}

RestResourceDatasetTypePropertiesPaginationRules

Name Description Value
{customized property}

SalesforceMarketingCloudObjectDataset

Name Description Value
type Type of dataset. 'SalesforceMarketingCloudObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SalesforceObjectDataset

Name Description Value
type Type of dataset. 'SalesforceObject' (required)
typeProperties Salesforce object dataset properties. SalesforceObjectDatasetTypeProperties

SalesforceObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce object API name. Type: string (or Expression with resultType string).

SalesforceServiceCloudObjectDataset

Name Description Value
type Type of dataset. 'SalesforceServiceCloudObject' (required)
typeProperties Salesforce Service Cloud object dataset properties. SalesforceServiceCloudObjectDatasetTypeProperties

SalesforceServiceCloudObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string).

SalesforceServiceCloudV2ObjectDataset

Name Description Value
type Type of dataset. 'SalesforceServiceCloudV2Object' (required)
typeProperties Salesforce Service Cloud V2 object dataset properties. SalesforceServiceCloudV2ObjectDatasetTypeProperties

SalesforceServiceCloudV2ObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce Service Cloud V2 object API name. Type: string (or Expression with resultType string).
reportId The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string).

SalesforceV2ObjectDataset

Name Description Value
type Type of dataset. 'SalesforceV2Object' (required)
typeProperties Salesforce V2 object dataset properties. SalesforceV2ObjectDatasetTypeProperties

SalesforceV2ObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce V2 object API name. Type: string (or Expression with resultType string).
reportId The Salesforce V2 report Id. Type: string (or Expression with resultType string).

SapBwCubeDataset

Name Description Value
type Type of dataset. 'SapBwCube' (required)

SapCloudForCustomerResourceDataset

Name Description Value
type Type of dataset. 'SapCloudForCustomerResource' (required)
typeProperties SAP Cloud For Customer OData resource dataset properties. SapCloudForCustomerResourceDatasetTypeProperties (required)

SapCloudForCustomerResourceDatasetTypeProperties

Name Description Value
path The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string).

SapEccResourceDataset

Name Description Value
type Type of dataset. 'SapEccResource' (required)
typeProperties SAP ECC OData resource dataset properties. SapEccResourceDatasetTypeProperties (required)

SapEccResourceDatasetTypeProperties

Name Description Value
path The path of the SAP ECC OData entity. Type: string (or Expression with resultType string).

SapHanaTableDataset

Name Description Value
type Type of dataset. 'SapHanaTable' (required)
typeProperties SAP HANA Table properties. SapHanaTableDatasetTypeProperties

SapHanaTableDatasetTypeProperties

Name Description Value
schema The schema name of SAP HANA. Type: string (or Expression with resultType string).
table The table name of SAP HANA. Type: string (or Expression with resultType string).

SapOdpResourceDataset

Name Description Value
type Type of dataset. 'SapOdpResource' (required)
typeProperties SAP ODP Resource properties. SapOdpResourceDatasetTypeProperties (required)

SapOdpResourceDatasetTypeProperties

Name Description Value
context The context of the SAP ODP Object. Type: string (or Expression with resultType string).
objectName The name of the SAP ODP Object. Type: string (or Expression with resultType string).

SapOpenHubTableDataset

Name Description Value
type Type of dataset. 'SapOpenHubTable' (required)
typeProperties Sap Business Warehouse Open Hub Destination Table properties. SapOpenHubTableDatasetTypeProperties (required)

SapOpenHubTableDatasetTypeProperties

Name Description Value
baseRequestId The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).
excludeLastRequest Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).
openHubDestinationName The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string).

SapTableResourceDataset

Name Description Value
type Type of dataset. 'SapTableResource' (required)
typeProperties SAP Table Resource properties. SapTableResourceDatasetTypeProperties (required)

SapTableResourceDatasetTypeProperties

Name Description Value
tableName The name of the SAP Table. Type: string (or Expression with resultType string).

ServiceNowObjectDataset

Name Description Value
type Type of dataset. 'ServiceNowObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

ServiceNowV2ObjectDataset

Name Description Value
type Type of dataset. 'ServiceNowV2Object' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SharePointOnlineListResourceDataset

Name Description Value
type Type of dataset. 'SharePointOnlineListResource' (required)
typeProperties Sharepoint online list dataset properties. SharePointOnlineListDatasetTypeProperties

SharePointOnlineListDatasetTypeProperties

Name Description Value
listName The name of the SharePoint Online list. Type: string (or Expression with resultType string).

ShopifyObjectDataset

Name Description Value
type Type of dataset. 'ShopifyObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SnowflakeDataset

Name Description Value
type Type of dataset. 'SnowflakeTable' (required)
typeProperties Snowflake dataset properties. SnowflakeDatasetTypeProperties (required)

SnowflakeDatasetTypeProperties

Name Description Value
schema The schema name of the Snowflake database. Type: string (or Expression with resultType string).
table The table name of the Snowflake database. Type: string (or Expression with resultType string).

SnowflakeV2Dataset

Name Description Value
type Type of dataset. 'SnowflakeV2Table' (required)
typeProperties Snowflake dataset properties. SnowflakeDatasetTypeProperties (required)

SparkObjectDataset

Name Description Value
type Type of dataset. 'SparkObject' (required)
typeProperties Properties specific to this dataset type. SparkDatasetTypeProperties

SparkDatasetTypeProperties

Name Description Value
schema The schema name of the Spark. Type: string (or Expression with resultType string).
table The table name of the Spark. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

SqlServerTableDataset

Name Description Value
type Type of dataset. 'SqlServerTable' (required)
typeProperties On-premises SQL Server dataset properties. SqlServerTableDatasetTypeProperties

SqlServerTableDatasetTypeProperties

Name Description Value
schema The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).
table The table name of the SQL Server dataset. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

SquareObjectDataset

Name Description Value
type Type of dataset. 'SquareObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SybaseTableDataset

Name Description Value
type Type of dataset. 'SybaseTable' (required)
typeProperties Sybase table dataset properties. SybaseTableDatasetTypeProperties

SybaseTableDatasetTypeProperties

Name Description Value
tableName The Sybase table name. Type: string (or Expression with resultType string).

TeradataTableDataset

Name Description Value
type Type of dataset. 'TeradataTable' (required)
typeProperties Teradata dataset properties. TeradataTableDatasetTypeProperties

TeradataTableDatasetTypeProperties

Name Description Value
database The database name of Teradata. Type: string (or Expression with resultType string).
table The table name of Teradata. Type: string (or Expression with resultType string).

VerticaTableDataset

Name Description Value
type Type of dataset. 'VerticaTable' (required)
typeProperties Properties specific to this dataset type. VerticaDatasetTypeProperties

VerticaDatasetTypeProperties

Name Description Value
schema The schema name of the Vertica. Type: string (or Expression with resultType string).
table The table name of the Vertica. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

WarehouseTableDataset

Name Description Value
type Type of dataset. 'WarehouseTable' (required)
typeProperties Microsoft Fabric Warehouse dataset properties. WarehouseTableDatasetTypeProperties

WarehouseTableDatasetTypeProperties

Name Description Value
schema The schema name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string).
table The table name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string).

WebTableDataset

Name Description Value
type Type of dataset. 'WebTable' (required)
typeProperties Web table dataset properties. WebTableDatasetTypeProperties (required)

WebTableDatasetTypeProperties

Name Description Value
index The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0.
path The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string).

XeroObjectDataset

Name Description Value
type Type of dataset. 'XeroObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

XmlDataset

Name Description Value
type Type of dataset. 'Xml' (required)
typeProperties Xml dataset properties. XmlDatasetTypeProperties

XmlDatasetTypeProperties

Name Description Value
compression The data compression method used for the json dataset. DatasetCompression
encodingName The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
location The location of the json data storage. DatasetLocation (required)
nullValue The null value string. Type: string (or Expression with resultType string).

ZohoObjectDataset

Name Description Value
type Type of dataset. 'ZohoObject' (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
More is possible with Azure Data Factory - One click to try Azure Data Factory

Deploy to Azure
This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob
Create a Data Factory, copy from Salesforce to Blob

Deploy to Azure
This template uses Azure Data Factory to perform data movement from Salesforce to Azure Blobs
Bulk copy using Azure Data Factory

Deploy to Azure
This template creates a V2 data factory that copies data in bulk an Azure SQL database to an Azure SQL data warehouse.
Create a V2 data factory

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage.
Create a V2 data factory (MySQL)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for MySQL.
Create a V2 data factory (PostGre)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for PostgreSQL.
Create a V2 data factory (SQL)

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure SQL database.
Create a V2 data factory (SQL On-prem)

Deploy to Azure
This template creates a V2 data factory that copies data from an on-premises SQL Server to an Azure blob storage

Terraform (AzAPI provider) resource definition

The factories/datasets resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/datasets resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/datasets@2018-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      annotations = [ object ]
      description = "string"
      folder = {
        name = "string"
      }
      linkedServiceName = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
      parameters = {
        {customized property} = {
          type = "string"
        }
      }
      type = "string"
      // For remaining properties, see Dataset objects
    }
  })
}

Dataset objects

Set the type property to specify the type of object.

For AmazonMWSObject, use:

  type = "AmazonMWSObject"
  typeProperties = {}

For AmazonRdsForOracleTable, use:

  type = "AmazonRdsForOracleTable"
  typeProperties = {}

For AmazonRdsForSqlServerTable, use:

  type = "AmazonRdsForSqlServerTable"
  typeProperties = {}

For AmazonRedshiftTable, use:

  type = "AmazonRedshiftTable"
  typeProperties = {}

For AmazonS3Object, use:

  type = "AmazonS3Object"
  typeProperties = {
    compression = {}
    format = {
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }

For Avro, use:

  type = "Avro"
  typeProperties = {
    avroCompressionLevel = int
    location = {
      type = "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For AzureBlob, use:

  type = "AzureBlob"
  typeProperties = {
    compression = {}
    format = {
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }

For AzureBlobFSFile, use:

  type = "AzureBlobFSFile"
  typeProperties = {
    compression = {}
    format = {
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }

For AzureDatabricksDeltaLakeDataset, use:

  type = "AzureDatabricksDeltaLakeDataset"
  typeProperties = {}

For AzureDataExplorerTable, use:

  type = "AzureDataExplorerTable"
  typeProperties = {}

For AzureDataLakeStoreFile, use:

  type = "AzureDataLakeStoreFile"
  typeProperties = {
    compression = {}
    format = {
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }

For AzureMariaDBTable, use:

  type = "AzureMariaDBTable"
  typeProperties = {}

For AzureMySqlTable, use:

  type = "AzureMySqlTable"
  typeProperties = {}

For AzurePostgreSqlTable, use:

  type = "AzurePostgreSqlTable"
  typeProperties = {}

For AzureSearchIndex, use:

  type = "AzureSearchIndex"
  typeProperties = {}

For AzureSqlDWTable, use:

  type = "AzureSqlDWTable"
  typeProperties = {}

For AzureSqlMITable, use:

  type = "AzureSqlMITable"
  typeProperties = {}

For AzureSqlTable, use:

  type = "AzureSqlTable"
  typeProperties = {}

For AzureTable, use:

  type = "AzureTable"
  typeProperties = {}

For Binary, use:

  type = "Binary"
  typeProperties = {
    compression = {}
    location = {
      type = "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For CassandraTable, use:

  type = "CassandraTable"
  typeProperties = {}

For CommonDataServiceForAppsEntity, use:

  type = "CommonDataServiceForAppsEntity"
  typeProperties = {}

For ConcurObject, use:

  type = "ConcurObject"
  typeProperties = {}

For CosmosDbMongoDbApiCollection, use:

  type = "CosmosDbMongoDbApiCollection"
  typeProperties = {}

For CosmosDbSqlApiCollection, use:

  type = "CosmosDbSqlApiCollection"
  typeProperties = {}

For CouchbaseTable, use:

  type = "CouchbaseTable"
  typeProperties = {}

For CustomDataset, use:

  type = "CustomDataset"

For Db2Table, use:

  type = "Db2Table"
  typeProperties = {}

For DelimitedText, use:

  type = "DelimitedText"
  typeProperties = {
    location = {
      type = "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For DocumentDbCollection, use:

  type = "DocumentDbCollection"
  typeProperties = {}

For DrillTable, use:

  type = "DrillTable"
  typeProperties = {}

For DynamicsAXResource, use:

  type = "DynamicsAXResource"
  typeProperties = {}

For DynamicsCrmEntity, use:

  type = "DynamicsCrmEntity"
  typeProperties = {}

For DynamicsEntity, use:

  type = "DynamicsEntity"
  typeProperties = {}

For EloquaObject, use:

  type = "EloquaObject"
  typeProperties = {}

For Excel, use:

  type = "Excel"
  typeProperties = {
    compression = {}
    location = {
      type = "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For FileShare, use:

  type = "FileShare"
  typeProperties = {
    compression = {}
    format = {
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }

For GoogleAdWordsObject, use:

  type = "GoogleAdWordsObject"
  typeProperties = {}

For GoogleBigQueryObject, use:

  type = "GoogleBigQueryObject"
  typeProperties = {}

For GoogleBigQueryV2Object, use:

  type = "GoogleBigQueryV2Object"
  typeProperties = {}

For GreenplumTable, use:

  type = "GreenplumTable"
  typeProperties = {}

For HBaseObject, use:

  type = "HBaseObject"
  typeProperties = {}

For HiveObject, use:

  type = "HiveObject"
  typeProperties = {}

For HttpFile, use:

  type = "HttpFile"
  typeProperties = {
    compression = {}
    format = {
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }

For HubspotObject, use:

  type = "HubspotObject"
  typeProperties = {}

For ImpalaObject, use:

  type = "ImpalaObject"
  typeProperties = {}

For InformixTable, use:

  type = "InformixTable"
  typeProperties = {}

For JiraObject, use:

  type = "JiraObject"
  typeProperties = {}

For Json, use:

  type = "Json"
  typeProperties = {
    compression = {}
    location = {
      type = "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For LakeHouseTable, use:

  type = "LakeHouseTable"
  typeProperties = {}

For MagentoObject, use:

  type = "MagentoObject"
  typeProperties = {}

For MariaDBTable, use:

  type = "MariaDBTable"
  typeProperties = {}

For MarketoObject, use:

  type = "MarketoObject"
  typeProperties = {}

For MicrosoftAccessTable, use:

  type = "MicrosoftAccessTable"
  typeProperties = {}

For MongoDbAtlasCollection, use:

  type = "MongoDbAtlasCollection"
  typeProperties = {}

For MongoDbCollection, use:

  type = "MongoDbCollection"
  typeProperties = {}

For MongoDbV2Collection, use:

  type = "MongoDbV2Collection"
  typeProperties = {}

For MySqlTable, use:

  type = "MySqlTable"
  typeProperties = {}

For NetezzaTable, use:

  type = "NetezzaTable"
  typeProperties = {}

For ODataResource, use:

  type = "ODataResource"
  typeProperties = {}

For OdbcTable, use:

  type = "OdbcTable"
  typeProperties = {}

For Office365Table, use:

  type = "Office365Table"
  typeProperties = {}

For OracleServiceCloudObject, use:

  type = "OracleServiceCloudObject"
  typeProperties = {}

For OracleTable, use:

  type = "OracleTable"
  typeProperties = {}

For Orc, use:

  type = "Orc"
  typeProperties = {
    location = {
      type = "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For Parquet, use:

  type = "Parquet"
  typeProperties = {
    location = {
      type = "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For PaypalObject, use:

  type = "PaypalObject"
  typeProperties = {}

For PhoenixObject, use:

  type = "PhoenixObject"
  typeProperties = {}

For PostgreSqlTable, use:

  type = "PostgreSqlTable"
  typeProperties = {}

For PostgreSqlV2Table, use:

  type = "PostgreSqlV2Table"
  typeProperties = {}

For PrestoObject, use:

  type = "PrestoObject"
  typeProperties = {}

For QuickBooksObject, use:

  type = "QuickBooksObject"
  typeProperties = {}

For RelationalTable, use:

  type = "RelationalTable"
  typeProperties = {}

For ResponsysObject, use:

  type = "ResponsysObject"
  typeProperties = {}

For RestResource, use:

  type = "RestResource"
  typeProperties = {
    additionalHeaders = {}
    paginationRules = {}
  }

For SalesforceMarketingCloudObject, use:

  type = "SalesforceMarketingCloudObject"
  typeProperties = {}

For SalesforceObject, use:

  type = "SalesforceObject"
  typeProperties = {}

For SalesforceServiceCloudObject, use:

  type = "SalesforceServiceCloudObject"
  typeProperties = {}

For SalesforceServiceCloudV2Object, use:

  type = "SalesforceServiceCloudV2Object"
  typeProperties = {}

For SalesforceV2Object, use:

  type = "SalesforceV2Object"
  typeProperties = {}

For SapBwCube, use:

  type = "SapBwCube"

For SapCloudForCustomerResource, use:

  type = "SapCloudForCustomerResource"
  typeProperties = {}

For SapEccResource, use:

  type = "SapEccResource"
  typeProperties = {}

For SapHanaTable, use:

  type = "SapHanaTable"
  typeProperties = {}

For SapOdpResource, use:

  type = "SapOdpResource"
  typeProperties = {}

For SapOpenHubTable, use:

  type = "SapOpenHubTable"
  typeProperties = {}

For SapTableResource, use:

  type = "SapTableResource"
  typeProperties = {}

For ServiceNowObject, use:

  type = "ServiceNowObject"
  typeProperties = {}

For ServiceNowV2Object, use:

  type = "ServiceNowV2Object"
  typeProperties = {}

For SharePointOnlineListResource, use:

  type = "SharePointOnlineListResource"
  typeProperties = {}

For ShopifyObject, use:

  type = "ShopifyObject"
  typeProperties = {}

For SnowflakeTable, use:

  type = "SnowflakeTable"
  typeProperties = {}

For SnowflakeV2Table, use:

  type = "SnowflakeV2Table"
  typeProperties = {}

For SparkObject, use:

  type = "SparkObject"
  typeProperties = {}

For SqlServerTable, use:

  type = "SqlServerTable"
  typeProperties = {}

For SquareObject, use:

  type = "SquareObject"
  typeProperties = {}

For SybaseTable, use:

  type = "SybaseTable"
  typeProperties = {}

For TeradataTable, use:

  type = "TeradataTable"
  typeProperties = {}

For VerticaTable, use:

  type = "VerticaTable"
  typeProperties = {}

For WarehouseTable, use:

  type = "WarehouseTable"
  typeProperties = {}

For WebTable, use:

  type = "WebTable"
  typeProperties = {}

For XeroObject, use:

  type = "XeroObject"
  typeProperties = {}

For Xml, use:

  type = "Xml"
  typeProperties = {
    compression = {}
    location = {
      type = "string"
      // For remaining properties, see DatasetLocation objects
    }
  }

For ZohoObject, use:

  type = "ZohoObject"
  typeProperties = {}

DatasetStorageFormat objects

Set the type property to specify the type of object.

For AvroFormat, use:

  type = "AvroFormat"

For JsonFormat, use:

  type = "JsonFormat"

For OrcFormat, use:

  type = "OrcFormat"

For ParquetFormat, use:

  type = "ParquetFormat"

For TextFormat, use:

  type = "TextFormat"

DatasetLocation objects

Set the type property to specify the type of object.

For AmazonS3CompatibleLocation, use:

  type = "AmazonS3CompatibleLocation"

For AmazonS3Location, use:

  type = "AmazonS3Location"

For AzureBlobFSLocation, use:

  type = "AzureBlobFSLocation"

For AzureBlobStorageLocation, use:

  type = "AzureBlobStorageLocation"

For AzureDataLakeStoreLocation, use:

  type = "AzureDataLakeStoreLocation"

For AzureFileStorageLocation, use:

  type = "AzureFileStorageLocation"

For FileServerLocation, use:

  type = "FileServerLocation"

For FtpServerLocation, use:

  type = "FtpServerLocation"

For GoogleCloudStorageLocation, use:

  type = "GoogleCloudStorageLocation"

For HdfsLocation, use:

  type = "HdfsLocation"

For HttpServerLocation, use:

  type = "HttpServerLocation"

For LakeHouseLocation, use:

  type = "LakeHouseLocation"

For OracleCloudStorageLocation, use:

  type = "OracleCloudStorageLocation"

For SftpLocation, use:

  type = "SftpLocation"

Property values

factories/datasets

Name Description Value
type The resource type "Microsoft.DataFactory/factories/datasets@2018-06-01"
name The resource name string (required)

Character limit: 1-260

Valid characters:
Can't use:
<>*#.%&:\\+?/- or control characters

Start with alphanumeric.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: factories
properties Dataset properties. Dataset (required)

Dataset

Name Description Value
annotations List of tags that can be used for describing the Dataset. any[]
description Dataset description. string
folder The folder that this Dataset is in. If not specified, Dataset will appear at the root level. DatasetFolder
linkedServiceName Linked service reference. LinkedServiceReference (required)
parameters Parameters for dataset. ParameterDefinitionSpecification
schema Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type Set the object type AmazonMWSObject
AmazonRdsForOracleTable
AmazonRdsForSqlServerTable
AmazonRedshiftTable
AmazonS3Object
Avro
AzureBlob
AzureBlobFSFile
AzureDatabricksDeltaLakeDataset
AzureDataExplorerTable
AzureDataLakeStoreFile
AzureMariaDBTable
AzureMySqlTable
AzurePostgreSqlTable
AzureSearchIndex
AzureSqlDWTable
AzureSqlMITable
AzureSqlTable
AzureTable
Binary
CassandraTable
CommonDataServiceForAppsEntity
ConcurObject
CosmosDbMongoDbApiCollection
CosmosDbSqlApiCollection
CouchbaseTable
CustomDataset
Db2Table
DelimitedText
DocumentDbCollection
DrillTable
DynamicsAXResource
DynamicsCrmEntity
DynamicsEntity
EloquaObject
Excel
FileShare
GoogleAdWordsObject
GoogleBigQueryObject
GoogleBigQueryV2Object
GreenplumTable
HBaseObject
HiveObject
HttpFile
HubspotObject
ImpalaObject
InformixTable
JiraObject
Json
LakeHouseTable
MagentoObject
MariaDBTable
MarketoObject
MicrosoftAccessTable
MongoDbAtlasCollection
MongoDbCollection
MongoDbV2Collection
MySqlTable
NetezzaTable
ODataResource
OdbcTable
Office365Table
OracleServiceCloudObject
OracleTable
Orc
Parquet
PaypalObject
PhoenixObject
PostgreSqlTable
PostgreSqlV2Table
PrestoObject
QuickBooksObject
RelationalTable
ResponsysObject
RestResource
SalesforceMarketingCloudObject
SalesforceObject
SalesforceServiceCloudObject
SalesforceServiceCloudV2Object
SalesforceV2Object
SapBwCube
SapCloudForCustomerResource
SapEccResource
SapHanaTable
SapOdpResource
SapOpenHubTable
SapTableResource
ServiceNowObject
ServiceNowV2Object
SharePointOnlineListResource
ShopifyObject
SnowflakeTable
SnowflakeV2Table
SparkObject
SqlServerTable
SquareObject
SybaseTable
TeradataTable
VerticaTable
WarehouseTable
WebTable
XeroObject
Xml
ZohoObject (required)

DatasetFolder

Name Description Value
name The name of the folder that this Dataset is in. string

LinkedServiceReference

Name Description Value
parameters Arguments for LinkedService. ParameterValueSpecification
referenceName Reference LinkedService name. string (required)
type Linked service reference type. "LinkedServiceReference" (required)

ParameterValueSpecification

Name Description Value
{customized property}

ParameterDefinitionSpecification

Name Description Value
{customized property} ParameterSpecification

ParameterSpecification

Name Description Value
defaultValue Default value of parameter.
type Parameter type. "Array"
"Bool"
"Float"
"Int"
"Object"
"SecureString"
"String" (required)

AmazonMWSObjectDataset

Name Description Value
type Type of dataset. "AmazonMWSObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

GenericDatasetTypeProperties

Name Description Value
tableName The table name. Type: string (or Expression with resultType string).

AmazonRdsForOracleTableDataset

Name Description Value
type Type of dataset. "AmazonRdsForOracleTable" (required)
typeProperties AmazonRdsForOracle dataset properties. AmazonRdsForOracleTableDatasetTypeProperties

AmazonRdsForOracleTableDatasetTypeProperties

Name Description Value
schema The schema name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).
table The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).

AmazonRdsForSqlServerTableDataset

Name Description Value
type Type of dataset. "AmazonRdsForSqlServerTable" (required)
typeProperties The Amazon RDS for SQL Server dataset properties. AmazonRdsForSqlServerTableDatasetTypeProperties

AmazonRdsForSqlServerTableDatasetTypeProperties

Name Description Value
schema The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).
table The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

AmazonRedshiftTableDataset

Name Description Value
type Type of dataset. "AmazonRedshiftTable" (required)
typeProperties Amazon Redshift table dataset properties. AmazonRedshiftTableDatasetTypeProperties

AmazonRedshiftTableDatasetTypeProperties

Name Description Value
schema The Amazon Redshift schema name. Type: string (or Expression with resultType string).
table The Amazon Redshift table name. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

AmazonS3Dataset

Name Description Value
type Type of dataset. "AmazonS3Object" (required)
typeProperties Amazon S3 dataset properties. AmazonS3DatasetTypeProperties (required)

AmazonS3DatasetTypeProperties

Name Description Value
bucketName The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
compression The data compression method used for the Amazon S3 object. DatasetCompression
format The format of files. DatasetStorageFormat
key The key of the Amazon S3 object. Type: string (or Expression with resultType string).
modifiedDatetimeEnd The end of S3 object's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart The start of S3 object's modified datetime. Type: string (or Expression with resultType string).
prefix The prefix filter for the S3 object name. Type: string (or Expression with resultType string).
version The version for the S3 object. Type: string (or Expression with resultType string).

DatasetCompression

Name Description Value
level The dataset compression level. Type: string (or Expression with resultType string).
type Type of dataset compression. Type: string (or Expression with resultType string).
{customized property}

DatasetStorageFormat

Name Description Value
deserializer Deserializer. Type: string (or Expression with resultType string).
serializer Serializer. Type: string (or Expression with resultType string).
type Set the object type AvroFormat
JsonFormat
OrcFormat
ParquetFormat
TextFormat (required)

AvroFormat

Name Description Value
type Type of dataset storage format. "AvroFormat" (required)

JsonFormat

Name Description Value
type Type of dataset storage format. "JsonFormat" (required)
encodingName The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).
filePattern File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.
jsonNodeReference The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).
jsonPathDefinition The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object).
nestingSeparator The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).

OrcFormat

Name Description Value
type Type of dataset storage format. "OrcFormat" (required)

ParquetFormat

Name Description Value
type Type of dataset storage format. "ParquetFormat" (required)

TextFormat

Name Description Value
type Type of dataset storage format. "TextFormat" (required)
columnDelimiter The column delimiter. Type: string (or Expression with resultType string).
encodingName The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
escapeChar The escape character. Type: string (or Expression with resultType string).
firstRowAsHeader When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
nullValue The null value string. Type: string (or Expression with resultType string).
quoteChar The quote character. Type: string (or Expression with resultType string).
rowDelimiter The row delimiter. Type: string (or Expression with resultType string).
skipLineCount The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).
treatEmptyAsNull Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).

AvroDataset

Name Description Value
type Type of dataset. "Avro" (required)
typeProperties Avro dataset properties. AvroDatasetTypeProperties

AvroDatasetTypeProperties

Name Description Value
avroCompressionCodec The data avroCompressionCodec. Type: string (or Expression with resultType string).
avroCompressionLevel int

Constraints:
Min value = 1
Max value = 9
location The location of the avro storage. DatasetLocation (required)

DatasetLocation

Name Description Value
fileName Specify the file name of dataset. Type: string (or Expression with resultType string).
folderPath Specify the folder path of dataset. Type: string (or Expression with resultType string)
type Set the object type AmazonS3CompatibleLocation
AmazonS3Location
AzureBlobFSLocation
AzureBlobStorageLocation
AzureDataLakeStoreLocation
AzureFileStorageLocation
FileServerLocation
FtpServerLocation
GoogleCloudStorageLocation
HdfsLocation
HttpServerLocation
LakeHouseLocation
OracleCloudStorageLocation
SftpLocation (required)

AmazonS3CompatibleLocation

Name Description Value
type Type of dataset storage location. "AmazonS3CompatibleLocation" (required)
bucketName Specify the bucketName of Amazon S3 Compatible. Type: string (or Expression with resultType string)
version Specify the version of Amazon S3 Compatible. Type: string (or Expression with resultType string).

AmazonS3Location

Name Description Value
type Type of dataset storage location. "AmazonS3Location" (required)
bucketName Specify the bucketName of amazon S3. Type: string (or Expression with resultType string)
version Specify the version of amazon S3. Type: string (or Expression with resultType string).

AzureBlobFSLocation

Name Description Value
type Type of dataset storage location. "AzureBlobFSLocation" (required)
fileSystem Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string).

AzureBlobStorageLocation

Name Description Value
type Type of dataset storage location. "AzureBlobStorageLocation" (required)
container Specify the container of azure blob. Type: string (or Expression with resultType string).

AzureDataLakeStoreLocation

Name Description Value
type Type of dataset storage location. "AzureDataLakeStoreLocation" (required)

AzureFileStorageLocation

Name Description Value
type Type of dataset storage location. "AzureFileStorageLocation" (required)

FileServerLocation

Name Description Value
type Type of dataset storage location. "FileServerLocation" (required)

FtpServerLocation

Name Description Value
type Type of dataset storage location. "FtpServerLocation" (required)

GoogleCloudStorageLocation

Name Description Value
type Type of dataset storage location. "GoogleCloudStorageLocation" (required)
bucketName Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string)
version Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string).

HdfsLocation

Name Description Value
type Type of dataset storage location. "HdfsLocation" (required)

HttpServerLocation

Name Description Value
type Type of dataset storage location. "HttpServerLocation" (required)
relativeUrl Specify the relativeUrl of http server. Type: string (or Expression with resultType string)

LakeHouseLocation

Name Description Value
type Type of dataset storage location. "LakeHouseLocation" (required)

OracleCloudStorageLocation

Name Description Value
type Type of dataset storage location. "OracleCloudStorageLocation" (required)
bucketName Specify the bucketName of Oracle Cloud Storage. Type: string (or Expression with resultType string)
version Specify the version of Oracle Cloud Storage. Type: string (or Expression with resultType string).

SftpLocation

Name Description Value
type Type of dataset storage location. "SftpLocation" (required)

AzureBlobDataset

Name Description Value
type Type of dataset. "AzureBlob" (required)
typeProperties Azure Blob dataset properties. AzureBlobDatasetTypeProperties

AzureBlobDatasetTypeProperties

Name Description Value
compression The data compression method used for the blob storage. DatasetCompression
fileName The name of the Azure Blob. Type: string (or Expression with resultType string).
folderPath The path of the Azure Blob storage. Type: string (or Expression with resultType string).
format The format of the Azure Blob storage. DatasetStorageFormat
modifiedDatetimeEnd The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string).
tableRootLocation The root of blob path. Type: string (or Expression with resultType string).

AzureBlobFSDataset

Name Description Value
type Type of dataset. "AzureBlobFSFile" (required)
typeProperties Azure Data Lake Storage Gen2 dataset properties. AzureBlobFSDatasetTypeProperties

AzureBlobFSDatasetTypeProperties

Name Description Value
compression The data compression method used for the blob storage. DatasetCompression
fileName The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string).
folderPath The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string).
format The format of the Azure Data Lake Storage Gen2 storage. DatasetStorageFormat

AzureDatabricksDeltaLakeDataset

Name Description Value
type Type of dataset. "AzureDatabricksDeltaLakeDataset" (required)
typeProperties Properties specific to this dataset type. AzureDatabricksDeltaLakeDatasetTypeProperties

AzureDatabricksDeltaLakeDatasetTypeProperties

Name Description Value
database The database name of delta table. Type: string (or Expression with resultType string).
table The name of delta table. Type: string (or Expression with resultType string).

AzureDataExplorerTableDataset

Name Description Value
type Type of dataset. "AzureDataExplorerTable" (required)
typeProperties Azure Data Explorer (Kusto) dataset properties. AzureDataExplorerDatasetTypeProperties (required)

AzureDataExplorerDatasetTypeProperties

Name Description Value
table The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string).

AzureDataLakeStoreDataset

Name Description Value
type Type of dataset. "AzureDataLakeStoreFile" (required)
typeProperties Azure Data Lake Store dataset properties. AzureDataLakeStoreDatasetTypeProperties

AzureDataLakeStoreDatasetTypeProperties

Name Description Value
compression The data compression method used for the item(s) in the Azure Data Lake Store. DatasetCompression
fileName The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string).
folderPath Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).
format The format of the Data Lake Store. DatasetStorageFormat

AzureMariaDBTableDataset

Name Description Value
type Type of dataset. "AzureMariaDBTable" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

AzureMySqlTableDataset

Name Description Value
type Type of dataset. "AzureMySqlTable" (required)
typeProperties Azure MySQL database dataset properties. AzureMySqlTableDatasetTypeProperties (required)

AzureMySqlTableDatasetTypeProperties

Name Description Value
table The name of Azure MySQL database table. Type: string (or Expression with resultType string).
tableName The Azure MySQL database table name. Type: string (or Expression with resultType string).

AzurePostgreSqlTableDataset

Name Description Value
type Type of dataset. "AzurePostgreSqlTable" (required)
typeProperties Properties specific to this dataset type. AzurePostgreSqlTableDatasetTypeProperties

AzurePostgreSqlTableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).
table The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).
tableName The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string).

AzureSearchIndexDataset

Name Description Value
type Type of dataset. "AzureSearchIndex" (required)
typeProperties Properties specific to this dataset type. AzureSearchIndexDatasetTypeProperties (required)

AzureSearchIndexDatasetTypeProperties

Name Description Value
indexName The name of the Azure Search Index. Type: string (or Expression with resultType string).

AzureSqlDWTableDataset

Name Description Value
type Type of dataset. "AzureSqlDWTable" (required)
typeProperties Azure SQL Data Warehouse dataset properties. AzureSqlDWTableDatasetTypeProperties

AzureSqlDWTableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
table The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

AzureSqlMITableDataset

Name Description Value
type Type of dataset. "AzureSqlMITable" (required)
typeProperties Azure SQL Managed Instance dataset properties. AzureSqlMITableDatasetTypeProperties

AzureSqlMITableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string).
table The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

AzureSqlTableDataset

Name Description Value
type Type of dataset. "AzureSqlTable" (required)
typeProperties Azure SQL dataset properties. AzureSqlTableDatasetTypeProperties

AzureSqlTableDatasetTypeProperties

Name Description Value
schema The schema name of the Azure SQL database. Type: string (or Expression with resultType string).
table The table name of the Azure SQL database. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

AzureTableDataset

Name Description Value
type Type of dataset. "AzureTable" (required)
typeProperties Azure Table dataset properties. AzureTableDatasetTypeProperties (required)

AzureTableDatasetTypeProperties

Name Description Value
tableName The table name of the Azure Table storage. Type: string (or Expression with resultType string).

BinaryDataset

Name Description Value
type Type of dataset. "Binary" (required)
typeProperties Binary dataset properties. BinaryDatasetTypeProperties

BinaryDatasetTypeProperties

Name Description Value
compression The data compression method used for the binary dataset. DatasetCompression
location The location of the Binary storage. DatasetLocation (required)

CassandraTableDataset

Name Description Value
type Type of dataset. "CassandraTable" (required)
typeProperties Cassandra dataset properties. CassandraTableDatasetTypeProperties

CassandraTableDatasetTypeProperties

Name Description Value
keyspace The keyspace of the Cassandra database. Type: string (or Expression with resultType string).
tableName The table name of the Cassandra database. Type: string (or Expression with resultType string).

CommonDataServiceForAppsEntityDataset

Name Description Value
type Type of dataset. "CommonDataServiceForAppsEntity" (required)
typeProperties Common Data Service for Apps entity dataset properties. CommonDataServiceForAppsEntityDatasetTypeProperties

CommonDataServiceForAppsEntityDatasetTypeProperties

Name Description Value
entityName The logical name of the entity. Type: string (or Expression with resultType string).

ConcurObjectDataset

Name Description Value
type Type of dataset. "ConcurObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

CosmosDbMongoDbApiCollectionDataset

Name Description Value
type Type of dataset. "CosmosDbMongoDbApiCollection" (required)
typeProperties CosmosDB (MongoDB API) database dataset properties. CosmosDbMongoDbApiCollectionDatasetTypeProperties (required)

CosmosDbMongoDbApiCollectionDatasetTypeProperties

Name Description Value
collection The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).

CosmosDbSqlApiCollectionDataset

Name Description Value
type Type of dataset. "CosmosDbSqlApiCollection" (required)
typeProperties CosmosDB (SQL API) Collection dataset properties. CosmosDbSqlApiCollectionDatasetTypeProperties (required)

CosmosDbSqlApiCollectionDatasetTypeProperties

Name Description Value
collectionName CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string).

CouchbaseTableDataset

Name Description Value
type Type of dataset. "CouchbaseTable" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

CustomDataset

Name Description Value
type Type of dataset. "CustomDataset" (required)
typeProperties Custom dataset properties.

Db2TableDataset

Name Description Value
type Type of dataset. "Db2Table" (required)
typeProperties Db2 table dataset properties. Db2TableDatasetTypeProperties

Db2TableDatasetTypeProperties

Name Description Value
schema The Db2 schema name. Type: string (or Expression with resultType string).
table The Db2 table name. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

DelimitedTextDataset

Name Description Value
type Type of dataset. "DelimitedText" (required)
typeProperties Delimited text dataset properties. DelimitedTextDatasetTypeProperties

DelimitedTextDatasetTypeProperties

Name Description Value
columnDelimiter The column delimiter. Type: string (or Expression with resultType string).
compressionCodec The data compressionCodec. Type: string (or Expression with resultType string).
compressionLevel The data compression method used for DelimitedText.
encodingName The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
escapeChar The escape character. Type: string (or Expression with resultType string).
firstRowAsHeader When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
location The location of the delimited text storage. DatasetLocation (required)
nullValue The null value string. Type: string (or Expression with resultType string).
quoteChar The quote character. Type: string (or Expression with resultType string).
rowDelimiter The row delimiter. Type: string (or Expression with resultType string).

DocumentDbCollectionDataset

Name Description Value
type Type of dataset. "DocumentDbCollection" (required)
typeProperties DocumentDB Collection dataset properties. DocumentDbCollectionDatasetTypeProperties (required)

DocumentDbCollectionDatasetTypeProperties

Name Description Value
collectionName Document Database collection name. Type: string (or Expression with resultType string).

DrillTableDataset

Name Description Value
type Type of dataset. "DrillTable" (required)
typeProperties Properties specific to this dataset type. DrillDatasetTypeProperties

DrillDatasetTypeProperties

Name Description Value
schema The schema name of the Drill. Type: string (or Expression with resultType string).
table The table name of the Drill. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

DynamicsAXResourceDataset

Name Description Value
type Type of dataset. "DynamicsAXResource" (required)
typeProperties Dynamics AX OData resource dataset properties. DynamicsAXResourceDatasetTypeProperties (required)

DynamicsAXResourceDatasetTypeProperties

Name Description Value
path The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string).

DynamicsCrmEntityDataset

Name Description Value
type Type of dataset. "DynamicsCrmEntity" (required)
typeProperties Dynamics CRM entity dataset properties. DynamicsCrmEntityDatasetTypeProperties

DynamicsCrmEntityDatasetTypeProperties

Name Description Value
entityName The logical name of the entity. Type: string (or Expression with resultType string).

DynamicsEntityDataset

Name Description Value
type Type of dataset. "DynamicsEntity" (required)
typeProperties Dynamics entity dataset properties. DynamicsEntityDatasetTypeProperties

DynamicsEntityDatasetTypeProperties

Name Description Value
entityName The logical name of the entity. Type: string (or Expression with resultType string).

EloquaObjectDataset

Name Description Value
type Type of dataset. "EloquaObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

ExcelDataset

Name Description Value
type Type of dataset. "Excel" (required)
typeProperties Excel dataset properties. ExcelDatasetTypeProperties

ExcelDatasetTypeProperties

Name Description Value
compression The data compression method used for the json dataset. DatasetCompression
firstRowAsHeader When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
location The location of the excel storage. DatasetLocation (required)
nullValue The null value string. Type: string (or Expression with resultType string).
range The partial data of one sheet. Type: string (or Expression with resultType string).
sheetIndex The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer)
sheetName The sheet name of excel file. Type: string (or Expression with resultType string).

FileShareDataset

Name Description Value
type Type of dataset. "FileShare" (required)
typeProperties On-premises file system dataset properties. FileShareDatasetTypeProperties

FileShareDatasetTypeProperties

Name Description Value
compression The data compression method used for the file system. DatasetCompression
fileFilter Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).
fileName The name of the on-premises file system. Type: string (or Expression with resultType string).
folderPath The path of the on-premises file system. Type: string (or Expression with resultType string).
format The format of the files. DatasetStorageFormat
modifiedDatetimeEnd The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart The start of file's modified datetime. Type: string (or Expression with resultType string).

GoogleAdWordsObjectDataset

Name Description Value
type Type of dataset. "GoogleAdWordsObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

GoogleBigQueryObjectDataset

Name Description Value
type Type of dataset. "GoogleBigQueryObject" (required)
typeProperties Properties specific to this dataset type. GoogleBigQueryDatasetTypeProperties

GoogleBigQueryDatasetTypeProperties

Name Description Value
dataset The database name of the Google BigQuery. Type: string (or Expression with resultType string).
table The table name of the Google BigQuery. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using database + table properties instead.

GoogleBigQueryV2ObjectDataset

Name Description Value
type Type of dataset. "GoogleBigQueryV2Object" (required)
typeProperties Properties specific to this dataset type. GoogleBigQueryV2DatasetTypeProperties

GoogleBigQueryV2DatasetTypeProperties

Name Description Value
dataset The database name of the Google BigQuery. Type: string (or Expression with resultType string).
table The table name of the Google BigQuery. Type: string (or Expression with resultType string).

GreenplumTableDataset

Name Description Value
type Type of dataset. "GreenplumTable" (required)
typeProperties Properties specific to this dataset type. GreenplumDatasetTypeProperties

GreenplumDatasetTypeProperties

Name Description Value
schema The schema name of Greenplum. Type: string (or Expression with resultType string).
table The table name of Greenplum. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

HBaseObjectDataset

Name Description Value
type Type of dataset. "HBaseObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

HiveObjectDataset

Name Description Value
type Type of dataset. "HiveObject" (required)
typeProperties Properties specific to this dataset type. HiveDatasetTypeProperties

HiveDatasetTypeProperties

Name Description Value
schema The schema name of the Hive. Type: string (or Expression with resultType string).
table The table name of the Hive. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

HttpDataset

Name Description Value
type Type of dataset. "HttpFile" (required)
typeProperties Properties specific to this dataset type. HttpDatasetTypeProperties

HttpDatasetTypeProperties

Name Description Value
additionalHeaders The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1
...
request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).
compression The data compression method used on files. DatasetCompression
format The format of files. DatasetStorageFormat
relativeUrl The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).
requestBody The body for the HTTP request. Type: string (or Expression with resultType string).
requestMethod The HTTP method for the HTTP request. Type: string (or Expression with resultType string).

HubspotObjectDataset

Name Description Value
type Type of dataset. "HubspotObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

ImpalaObjectDataset

Name Description Value
type Type of dataset. "ImpalaObject" (required)
typeProperties Properties specific to this dataset type. ImpalaDatasetTypeProperties

ImpalaDatasetTypeProperties

Name Description Value
schema The schema name of the Impala. Type: string (or Expression with resultType string).
table The table name of the Impala. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

InformixTableDataset

Name Description Value
type Type of dataset. "InformixTable" (required)
typeProperties Informix table dataset properties. InformixTableDatasetTypeProperties

InformixTableDatasetTypeProperties

Name Description Value
tableName The Informix table name. Type: string (or Expression with resultType string).

JiraObjectDataset

Name Description Value
type Type of dataset. "JiraObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

JsonDataset

Name Description Value
type Type of dataset. "Json" (required)
typeProperties Json dataset properties. JsonDatasetTypeProperties

JsonDatasetTypeProperties

Name Description Value
compression The data compression method used for the json dataset. DatasetCompression
encodingName The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
location The location of the json data storage. DatasetLocation (required)

LakeHouseTableDataset

Name Description Value
type Type of dataset. "LakeHouseTable" (required)
typeProperties Microsoft Fabric LakeHouse Table dataset properties. LakeHouseTableDatasetTypeProperties

LakeHouseTableDatasetTypeProperties

Name Description Value
table The name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string).

MagentoObjectDataset

Name Description Value
type Type of dataset. "MagentoObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

MariaDBTableDataset

Name Description Value
type Type of dataset. "MariaDBTable" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

MarketoObjectDataset

Name Description Value
type Type of dataset. "MarketoObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

MicrosoftAccessTableDataset

Name Description Value
type Type of dataset. "MicrosoftAccessTable" (required)
typeProperties Microsoft Access table dataset properties. MicrosoftAccessTableDatasetTypeProperties

MicrosoftAccessTableDatasetTypeProperties

Name Description Value
tableName The Microsoft Access table name. Type: string (or Expression with resultType string).

MongoDbAtlasCollectionDataset

Name Description Value
type Type of dataset. "MongoDbAtlasCollection" (required)
typeProperties MongoDB Atlas database dataset properties. MongoDbAtlasCollectionDatasetTypeProperties (required)

MongoDbAtlasCollectionDatasetTypeProperties

Name Description Value
collection The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string).

MongoDbCollectionDataset

Name Description Value
type Type of dataset. "MongoDbCollection" (required)
typeProperties MongoDB database dataset properties. MongoDbCollectionDatasetTypeProperties (required)

MongoDbCollectionDatasetTypeProperties

Name Description Value
collectionName The table name of the MongoDB database. Type: string (or Expression with resultType string).

MongoDbV2CollectionDataset

Name Description Value
type Type of dataset. "MongoDbV2Collection" (required)
typeProperties MongoDB database dataset properties. MongoDbV2CollectionDatasetTypeProperties (required)

MongoDbV2CollectionDatasetTypeProperties

Name Description Value
collection The collection name of the MongoDB database. Type: string (or Expression with resultType string).

MySqlTableDataset

Name Description Value
type Type of dataset. "MySqlTable" (required)
typeProperties MySQL table dataset properties. MySqlTableDatasetTypeProperties

MySqlTableDatasetTypeProperties

Name Description Value
tableName The MySQL table name. Type: string (or Expression with resultType string).

NetezzaTableDataset

Name Description Value
type Type of dataset. "NetezzaTable" (required)
typeProperties Properties specific to this dataset type. NetezzaTableDatasetTypeProperties

NetezzaTableDatasetTypeProperties

Name Description Value
schema The schema name of the Netezza. Type: string (or Expression with resultType string).
table The table name of the Netezza. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

ODataResourceDataset

Name Description Value
type Type of dataset. "ODataResource" (required)
typeProperties OData dataset properties. ODataResourceDatasetTypeProperties

ODataResourceDatasetTypeProperties

Name Description Value
path The OData resource path. Type: string (or Expression with resultType string).

OdbcTableDataset

Name Description Value
type Type of dataset. "OdbcTable" (required)
typeProperties ODBC table dataset properties. OdbcTableDatasetTypeProperties

OdbcTableDatasetTypeProperties

Name Description Value
tableName The ODBC table name. Type: string (or Expression with resultType string).

Office365Dataset

Name Description Value
type Type of dataset. "Office365Table" (required)
typeProperties Office365 dataset properties. Office365DatasetTypeProperties (required)

Office365DatasetTypeProperties

Name Description Value
predicate A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string).
tableName Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string).

OracleServiceCloudObjectDataset

Name Description Value
type Type of dataset. "OracleServiceCloudObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

OracleTableDataset

Name Description Value
type Type of dataset. "OracleTable" (required)
typeProperties On-premises Oracle dataset properties. OracleTableDatasetTypeProperties

OracleTableDatasetTypeProperties

Name Description Value
schema The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string).
table The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

OrcDataset

Name Description Value
type Type of dataset. "Orc" (required)
typeProperties ORC dataset properties. OrcDatasetTypeProperties

OrcDatasetTypeProperties

Name Description Value
location The location of the ORC data storage. DatasetLocation (required)
orcCompressionCodec The data orcCompressionCodec. Type: string (or Expression with resultType string).

ParquetDataset

Name Description Value
type Type of dataset. "Parquet" (required)
typeProperties Parquet dataset properties. ParquetDatasetTypeProperties

ParquetDatasetTypeProperties

Name Description Value
compressionCodec The data compressionCodec. Type: string (or Expression with resultType string).
location The location of the parquet storage. DatasetLocation (required)

PaypalObjectDataset

Name Description Value
type Type of dataset. "PaypalObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

PhoenixObjectDataset

Name Description Value
type Type of dataset. "PhoenixObject" (required)
typeProperties Properties specific to this dataset type. PhoenixDatasetTypeProperties

PhoenixDatasetTypeProperties

Name Description Value
schema The schema name of the Phoenix. Type: string (or Expression with resultType string).
table The table name of the Phoenix. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

PostgreSqlTableDataset

Name Description Value
type Type of dataset. "PostgreSqlTable" (required)
typeProperties PostgreSQL table dataset properties. PostgreSqlTableDatasetTypeProperties

PostgreSqlTableDatasetTypeProperties

Name Description Value
schema The PostgreSQL schema name. Type: string (or Expression with resultType string).
table The PostgreSQL table name. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

PostgreSqlV2TableDataset

Name Description Value
type Type of dataset. "PostgreSqlV2Table" (required)
typeProperties PostgreSQLV2 table dataset properties. PostgreSqlV2TableDatasetTypeProperties

PostgreSqlV2TableDatasetTypeProperties

Name Description Value
schema The PostgreSQL schema name. Type: string (or Expression with resultType string).
table The PostgreSQL table name. Type: string (or Expression with resultType string).

PrestoObjectDataset

Name Description Value
type Type of dataset. "PrestoObject" (required)
typeProperties Properties specific to this dataset type. PrestoDatasetTypeProperties

PrestoDatasetTypeProperties

Name Description Value
schema The schema name of the Presto. Type: string (or Expression with resultType string).
table The table name of the Presto. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

QuickBooksObjectDataset

Name Description Value
type Type of dataset. "QuickBooksObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

RelationalTableDataset

Name Description Value
type Type of dataset. "RelationalTable" (required)
typeProperties Relational table dataset properties. RelationalTableDatasetTypeProperties

RelationalTableDatasetTypeProperties

Name Description Value
tableName The relational table name. Type: string (or Expression with resultType string).

ResponsysObjectDataset

Name Description Value
type Type of dataset. "ResponsysObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

RestResourceDataset

Name Description Value
type Type of dataset. "RestResource" (required)
typeProperties Properties specific to this dataset type. RestResourceDatasetTypeProperties

RestResourceDatasetTypeProperties

Name Description Value
additionalHeaders The additional HTTP headers in the request to the RESTful API. RestResourceDatasetTypePropertiesAdditionalHeaders
paginationRules The pagination rules to compose next page requests. RestResourceDatasetTypePropertiesPaginationRules
relativeUrl The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
requestBody The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
requestMethod The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

RestResourceDatasetTypePropertiesAdditionalHeaders

Name Description Value
{customized property}

RestResourceDatasetTypePropertiesPaginationRules

Name Description Value
{customized property}

SalesforceMarketingCloudObjectDataset

Name Description Value
type Type of dataset. "SalesforceMarketingCloudObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SalesforceObjectDataset

Name Description Value
type Type of dataset. "SalesforceObject" (required)
typeProperties Salesforce object dataset properties. SalesforceObjectDatasetTypeProperties

SalesforceObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce object API name. Type: string (or Expression with resultType string).

SalesforceServiceCloudObjectDataset

Name Description Value
type Type of dataset. "SalesforceServiceCloudObject" (required)
typeProperties Salesforce Service Cloud object dataset properties. SalesforceServiceCloudObjectDatasetTypeProperties

SalesforceServiceCloudObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string).

SalesforceServiceCloudV2ObjectDataset

Name Description Value
type Type of dataset. "SalesforceServiceCloudV2Object" (required)
typeProperties Salesforce Service Cloud V2 object dataset properties. SalesforceServiceCloudV2ObjectDatasetTypeProperties

SalesforceServiceCloudV2ObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce Service Cloud V2 object API name. Type: string (or Expression with resultType string).
reportId The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string).

SalesforceV2ObjectDataset

Name Description Value
type Type of dataset. "SalesforceV2Object" (required)
typeProperties Salesforce V2 object dataset properties. SalesforceV2ObjectDatasetTypeProperties

SalesforceV2ObjectDatasetTypeProperties

Name Description Value
objectApiName The Salesforce V2 object API name. Type: string (or Expression with resultType string).
reportId The Salesforce V2 report Id. Type: string (or Expression with resultType string).

SapBwCubeDataset

Name Description Value
type Type of dataset. "SapBwCube" (required)

SapCloudForCustomerResourceDataset

Name Description Value
type Type of dataset. "SapCloudForCustomerResource" (required)
typeProperties SAP Cloud For Customer OData resource dataset properties. SapCloudForCustomerResourceDatasetTypeProperties (required)

SapCloudForCustomerResourceDatasetTypeProperties

Name Description Value
path The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string).

SapEccResourceDataset

Name Description Value
type Type of dataset. "SapEccResource" (required)
typeProperties SAP ECC OData resource dataset properties. SapEccResourceDatasetTypeProperties (required)

SapEccResourceDatasetTypeProperties

Name Description Value
path The path of the SAP ECC OData entity. Type: string (or Expression with resultType string).

SapHanaTableDataset

Name Description Value
type Type of dataset. "SapHanaTable" (required)
typeProperties SAP HANA Table properties. SapHanaTableDatasetTypeProperties

SapHanaTableDatasetTypeProperties

Name Description Value
schema The schema name of SAP HANA. Type: string (or Expression with resultType string).
table The table name of SAP HANA. Type: string (or Expression with resultType string).

SapOdpResourceDataset

Name Description Value
type Type of dataset. "SapOdpResource" (required)
typeProperties SAP ODP Resource properties. SapOdpResourceDatasetTypeProperties (required)

SapOdpResourceDatasetTypeProperties

Name Description Value
context The context of the SAP ODP Object. Type: string (or Expression with resultType string).
objectName The name of the SAP ODP Object. Type: string (or Expression with resultType string).

SapOpenHubTableDataset

Name Description Value
type Type of dataset. "SapOpenHubTable" (required)
typeProperties Sap Business Warehouse Open Hub Destination Table properties. SapOpenHubTableDatasetTypeProperties (required)

SapOpenHubTableDatasetTypeProperties

Name Description Value
baseRequestId The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).
excludeLastRequest Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).
openHubDestinationName The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string).

SapTableResourceDataset

Name Description Value
type Type of dataset. "SapTableResource" (required)
typeProperties SAP Table Resource properties. SapTableResourceDatasetTypeProperties (required)

SapTableResourceDatasetTypeProperties

Name Description Value
tableName The name of the SAP Table. Type: string (or Expression with resultType string).

ServiceNowObjectDataset

Name Description Value
type Type of dataset. "ServiceNowObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

ServiceNowV2ObjectDataset

Name Description Value
type Type of dataset. "ServiceNowV2Object" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SharePointOnlineListResourceDataset

Name Description Value
type Type of dataset. "SharePointOnlineListResource" (required)
typeProperties Sharepoint online list dataset properties. SharePointOnlineListDatasetTypeProperties

SharePointOnlineListDatasetTypeProperties

Name Description Value
listName The name of the SharePoint Online list. Type: string (or Expression with resultType string).

ShopifyObjectDataset

Name Description Value
type Type of dataset. "ShopifyObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SnowflakeDataset

Name Description Value
type Type of dataset. "SnowflakeTable" (required)
typeProperties Snowflake dataset properties. SnowflakeDatasetTypeProperties (required)

SnowflakeDatasetTypeProperties

Name Description Value
schema The schema name of the Snowflake database. Type: string (or Expression with resultType string).
table The table name of the Snowflake database. Type: string (or Expression with resultType string).

SnowflakeV2Dataset

Name Description Value
type Type of dataset. "SnowflakeV2Table" (required)
typeProperties Snowflake dataset properties. SnowflakeDatasetTypeProperties (required)

SparkObjectDataset

Name Description Value
type Type of dataset. "SparkObject" (required)
typeProperties Properties specific to this dataset type. SparkDatasetTypeProperties

SparkDatasetTypeProperties

Name Description Value
schema The schema name of the Spark. Type: string (or Expression with resultType string).
table The table name of the Spark. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

SqlServerTableDataset

Name Description Value
type Type of dataset. "SqlServerTable" (required)
typeProperties On-premises SQL Server dataset properties. SqlServerTableDatasetTypeProperties

SqlServerTableDatasetTypeProperties

Name Description Value
schema The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).
table The table name of the SQL Server dataset. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

SquareObjectDataset

Name Description Value
type Type of dataset. "SquareObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

SybaseTableDataset

Name Description Value
type Type of dataset. "SybaseTable" (required)
typeProperties Sybase table dataset properties. SybaseTableDatasetTypeProperties

SybaseTableDatasetTypeProperties

Name Description Value
tableName The Sybase table name. Type: string (or Expression with resultType string).

TeradataTableDataset

Name Description Value
type Type of dataset. "TeradataTable" (required)
typeProperties Teradata dataset properties. TeradataTableDatasetTypeProperties

TeradataTableDatasetTypeProperties

Name Description Value
database The database name of Teradata. Type: string (or Expression with resultType string).
table The table name of Teradata. Type: string (or Expression with resultType string).

VerticaTableDataset

Name Description Value
type Type of dataset. "VerticaTable" (required)
typeProperties Properties specific to this dataset type. VerticaDatasetTypeProperties

VerticaDatasetTypeProperties

Name Description Value
schema The schema name of the Vertica. Type: string (or Expression with resultType string).
table The table name of the Vertica. Type: string (or Expression with resultType string).
tableName This property will be retired. Please consider using schema + table properties instead.

WarehouseTableDataset

Name Description Value
type Type of dataset. "WarehouseTable" (required)
typeProperties Microsoft Fabric Warehouse dataset properties. WarehouseTableDatasetTypeProperties

WarehouseTableDatasetTypeProperties

Name Description Value
schema The schema name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string).
table The table name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string).

WebTableDataset

Name Description Value
type Type of dataset. "WebTable" (required)
typeProperties Web table dataset properties. WebTableDatasetTypeProperties (required)

WebTableDatasetTypeProperties

Name Description Value
index The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0.
path The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string).

XeroObjectDataset

Name Description Value
type Type of dataset. "XeroObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties

XmlDataset

Name Description Value
type Type of dataset. "Xml" (required)
typeProperties Xml dataset properties. XmlDatasetTypeProperties

XmlDatasetTypeProperties

Name Description Value
compression The data compression method used for the json dataset. DatasetCompression
encodingName The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
location The location of the json data storage. DatasetLocation (required)
nullValue The null value string. Type: string (or Expression with resultType string).

ZohoObjectDataset

Name Description Value
type Type of dataset. "ZohoObject" (required)
typeProperties Properties specific to this dataset type. GenericDatasetTypeProperties