Microsoft.DataFactory factories/datasets
Bicep resource definition
The factories/datasets resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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' = {
parent: resourceSymbolicName
name: 'string'
properties: {
annotations: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
description: 'string'
folder: {
name: 'string'
}
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
parameters: {
{customized property}: {
defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
}
}
schema: any(Azure.Bicep.Types.Concrete.AnyType)
structure: any(Azure.Bicep.Types.Concrete.AnyType)
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(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AmazonRdsForOracleTable, use:
{
type: 'AmazonRdsForOracleTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AmazonRdsForSqlServerTable, use:
{
type: 'AmazonRdsForSqlServerTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AmazonRedshiftTable, use:
{
type: 'AmazonRedshiftTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AmazonS3Object, use:
{
type: 'AmazonS3Object'
typeProperties: {
bucketName: any(Azure.Bicep.Types.Concrete.AnyType)
compression: {
level: any(Azure.Bicep.Types.Concrete.AnyType)
type: any(Azure.Bicep.Types.Concrete.AnyType)
}
format: {
deserializer: any(Azure.Bicep.Types.Concrete.AnyType)
serializer: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetStorageFormat objects
}
key: any(Azure.Bicep.Types.Concrete.AnyType)
modifiedDatetimeEnd: any(Azure.Bicep.Types.Concrete.AnyType)
modifiedDatetimeStart: any(Azure.Bicep.Types.Concrete.AnyType)
prefix: any(Azure.Bicep.Types.Concrete.AnyType)
version: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Avro, use:
{
type: 'Avro'
typeProperties: {
avroCompressionCodec: any(Azure.Bicep.Types.Concrete.AnyType)
avroCompressionLevel: int
location: {
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetLocation objects
}
}
}
For AzureBlob, use:
{
type: 'AzureBlob'
typeProperties: {
compression: {
level: any(Azure.Bicep.Types.Concrete.AnyType)
type: any(Azure.Bicep.Types.Concrete.AnyType)
}
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
format: {
deserializer: any(Azure.Bicep.Types.Concrete.AnyType)
serializer: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetStorageFormat objects
}
modifiedDatetimeEnd: any(Azure.Bicep.Types.Concrete.AnyType)
modifiedDatetimeStart: any(Azure.Bicep.Types.Concrete.AnyType)
tableRootLocation: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureBlobFSFile, use:
{
type: 'AzureBlobFSFile'
typeProperties: {
compression: {
level: any(Azure.Bicep.Types.Concrete.AnyType)
type: any(Azure.Bicep.Types.Concrete.AnyType)
}
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
format: {
deserializer: any(Azure.Bicep.Types.Concrete.AnyType)
serializer: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetStorageFormat objects
}
}
}
For AzureDataExplorerTable, use:
{
type: 'AzureDataExplorerTable'
typeProperties: {
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureDataLakeStoreFile, use:
{
type: 'AzureDataLakeStoreFile'
typeProperties: {
compression: {
level: any(Azure.Bicep.Types.Concrete.AnyType)
type: any(Azure.Bicep.Types.Concrete.AnyType)
}
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
format: {
deserializer: any(Azure.Bicep.Types.Concrete.AnyType)
serializer: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetStorageFormat objects
}
}
}
For AzureDatabricksDeltaLakeDataset, use:
{
type: 'AzureDatabricksDeltaLakeDataset'
typeProperties: {
database: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureMariaDBTable, use:
{
type: 'AzureMariaDBTable'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureMySqlTable, use:
{
type: 'AzureMySqlTable'
typeProperties: {
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzurePostgreSqlTable, use:
{
type: 'AzurePostgreSqlTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureSearchIndex, use:
{
type: 'AzureSearchIndex'
typeProperties: {
indexName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureSqlDWTable, use:
{
type: 'AzureSqlDWTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureSqlMITable, use:
{
type: 'AzureSqlMITable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureSqlTable, use:
{
type: 'AzureSqlTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For AzureTable, use:
{
type: 'AzureTable'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Binary, use:
{
type: 'Binary'
typeProperties: {
compression: {
level: any(Azure.Bicep.Types.Concrete.AnyType)
type: any(Azure.Bicep.Types.Concrete.AnyType)
}
location: {
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetLocation objects
}
}
}
For CassandraTable, use:
{
type: 'CassandraTable'
typeProperties: {
keyspace: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For CommonDataServiceForAppsEntity, use:
{
type: 'CommonDataServiceForAppsEntity'
typeProperties: {
entityName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For ConcurObject, use:
{
type: 'ConcurObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For CosmosDbMongoDbApiCollection, use:
{
type: 'CosmosDbMongoDbApiCollection'
typeProperties: {
collection: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For CosmosDbSqlApiCollection, use:
{
type: 'CosmosDbSqlApiCollection'
typeProperties: {
collectionName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For CouchbaseTable, use:
{
type: 'CouchbaseTable'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For CustomDataset, use:
{
type: 'CustomDataset'
typeProperties: any(Azure.Bicep.Types.Concrete.AnyType)
}
For Db2Table, use:
{
type: 'Db2Table'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For DelimitedText, use:
{
type: 'DelimitedText'
typeProperties: {
columnDelimiter: any(Azure.Bicep.Types.Concrete.AnyType)
compressionCodec: any(Azure.Bicep.Types.Concrete.AnyType)
compressionLevel: any(Azure.Bicep.Types.Concrete.AnyType)
encodingName: any(Azure.Bicep.Types.Concrete.AnyType)
escapeChar: any(Azure.Bicep.Types.Concrete.AnyType)
firstRowAsHeader: any(Azure.Bicep.Types.Concrete.AnyType)
location: {
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetLocation objects
}
nullValue: any(Azure.Bicep.Types.Concrete.AnyType)
quoteChar: any(Azure.Bicep.Types.Concrete.AnyType)
rowDelimiter: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For DocumentDbCollection, use:
{
type: 'DocumentDbCollection'
typeProperties: {
collectionName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For DrillTable, use:
{
type: 'DrillTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For DynamicsAXResource, use:
{
type: 'DynamicsAXResource'
typeProperties: {
path: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For DynamicsCrmEntity, use:
{
type: 'DynamicsCrmEntity'
typeProperties: {
entityName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For DynamicsEntity, use:
{
type: 'DynamicsEntity'
typeProperties: {
entityName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For EloquaObject, use:
{
type: 'EloquaObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Excel, use:
{
type: 'Excel'
typeProperties: {
compression: {
level: any(Azure.Bicep.Types.Concrete.AnyType)
type: any(Azure.Bicep.Types.Concrete.AnyType)
}
firstRowAsHeader: any(Azure.Bicep.Types.Concrete.AnyType)
location: {
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetLocation objects
}
nullValue: any(Azure.Bicep.Types.Concrete.AnyType)
range: any(Azure.Bicep.Types.Concrete.AnyType)
sheetIndex: any(Azure.Bicep.Types.Concrete.AnyType)
sheetName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For FileShare, use:
{
type: 'FileShare'
typeProperties: {
compression: {
level: any(Azure.Bicep.Types.Concrete.AnyType)
type: any(Azure.Bicep.Types.Concrete.AnyType)
}
fileFilter: any(Azure.Bicep.Types.Concrete.AnyType)
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
format: {
deserializer: any(Azure.Bicep.Types.Concrete.AnyType)
serializer: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetStorageFormat objects
}
modifiedDatetimeEnd: any(Azure.Bicep.Types.Concrete.AnyType)
modifiedDatetimeStart: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For GoogleAdWordsObject, use:
{
type: 'GoogleAdWordsObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For GoogleBigQueryObject, use:
{
type: 'GoogleBigQueryObject'
typeProperties: {
dataset: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For GoogleBigQueryV2Object, use:
{
type: 'GoogleBigQueryV2Object'
typeProperties: {
dataset: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For GreenplumTable, use:
{
type: 'GreenplumTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For HBaseObject, use:
{
type: 'HBaseObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For HiveObject, use:
{
type: 'HiveObject'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For HttpFile, use:
{
type: 'HttpFile'
typeProperties: {
additionalHeaders: any(Azure.Bicep.Types.Concrete.AnyType)
compression: {
level: any(Azure.Bicep.Types.Concrete.AnyType)
type: any(Azure.Bicep.Types.Concrete.AnyType)
}
format: {
deserializer: any(Azure.Bicep.Types.Concrete.AnyType)
serializer: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetStorageFormat objects
}
relativeUrl: any(Azure.Bicep.Types.Concrete.AnyType)
requestBody: any(Azure.Bicep.Types.Concrete.AnyType)
requestMethod: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For HubspotObject, use:
{
type: 'HubspotObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Iceberg, use:
{
type: 'Iceberg'
typeProperties: {
location: {
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetLocation objects
}
}
}
For ImpalaObject, use:
{
type: 'ImpalaObject'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For InformixTable, use:
{
type: 'InformixTable'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For JiraObject, use:
{
type: 'JiraObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Json, use:
{
type: 'Json'
typeProperties: {
compression: {
level: any(Azure.Bicep.Types.Concrete.AnyType)
type: any(Azure.Bicep.Types.Concrete.AnyType)
}
encodingName: any(Azure.Bicep.Types.Concrete.AnyType)
location: {
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetLocation objects
}
}
}
For LakeHouseTable, use:
{
type: 'LakeHouseTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MagentoObject, use:
{
type: 'MagentoObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MariaDBTable, use:
{
type: 'MariaDBTable'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MarketoObject, use:
{
type: 'MarketoObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MicrosoftAccessTable, use:
{
type: 'MicrosoftAccessTable'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MongoDbAtlasCollection, use:
{
type: 'MongoDbAtlasCollection'
typeProperties: {
collection: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MongoDbCollection, use:
{
type: 'MongoDbCollection'
typeProperties: {
collectionName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MongoDbV2Collection, use:
{
type: 'MongoDbV2Collection'
typeProperties: {
collection: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For MySqlTable, use:
{
type: 'MySqlTable'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For NetezzaTable, use:
{
type: 'NetezzaTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For ODataResource, use:
{
type: 'ODataResource'
typeProperties: {
path: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For OdbcTable, use:
{
type: 'OdbcTable'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Office365Table, use:
{
type: 'Office365Table'
typeProperties: {
predicate: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For OracleServiceCloudObject, use:
{
type: 'OracleServiceCloudObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For OracleTable, use:
{
type: 'OracleTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Orc, use:
{
type: 'Orc'
typeProperties: {
location: {
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetLocation objects
}
orcCompressionCodec: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Parquet, use:
{
type: 'Parquet'
typeProperties: {
compressionCodec: any(Azure.Bicep.Types.Concrete.AnyType)
location: {
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetLocation objects
}
}
}
For PaypalObject, use:
{
type: 'PaypalObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For PhoenixObject, use:
{
type: 'PhoenixObject'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For PostgreSqlTable, use:
{
type: 'PostgreSqlTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For PostgreSqlV2Table, use:
{
type: 'PostgreSqlV2Table'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For PrestoObject, use:
{
type: 'PrestoObject'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For QuickBooksObject, use:
{
type: 'QuickBooksObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For RelationalTable, use:
{
type: 'RelationalTable'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For ResponsysObject, use:
{
type: 'ResponsysObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For RestResource, use:
{
type: 'RestResource'
typeProperties: {
additionalHeaders: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
paginationRules: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
relativeUrl: any(Azure.Bicep.Types.Concrete.AnyType)
requestBody: any(Azure.Bicep.Types.Concrete.AnyType)
requestMethod: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SalesforceMarketingCloudObject, use:
{
type: 'SalesforceMarketingCloudObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SalesforceObject, use:
{
type: 'SalesforceObject'
typeProperties: {
objectApiName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SalesforceServiceCloudObject, use:
{
type: 'SalesforceServiceCloudObject'
typeProperties: {
objectApiName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SalesforceServiceCloudV2Object, use:
{
type: 'SalesforceServiceCloudV2Object'
typeProperties: {
objectApiName: any(Azure.Bicep.Types.Concrete.AnyType)
reportId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SalesforceV2Object, use:
{
type: 'SalesforceV2Object'
typeProperties: {
objectApiName: any(Azure.Bicep.Types.Concrete.AnyType)
reportId: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapBwCube, use:
{
type: 'SapBwCube'
}
For SapCloudForCustomerResource, use:
{
type: 'SapCloudForCustomerResource'
typeProperties: {
path: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapEccResource, use:
{
type: 'SapEccResource'
typeProperties: {
path: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapHanaTable, use:
{
type: 'SapHanaTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapOdpResource, use:
{
type: 'SapOdpResource'
typeProperties: {
context: any(Azure.Bicep.Types.Concrete.AnyType)
objectName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapOpenHubTable, use:
{
type: 'SapOpenHubTable'
typeProperties: {
baseRequestId: any(Azure.Bicep.Types.Concrete.AnyType)
excludeLastRequest: any(Azure.Bicep.Types.Concrete.AnyType)
openHubDestinationName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SapTableResource, use:
{
type: 'SapTableResource'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For ServiceNowObject, use:
{
type: 'ServiceNowObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For ServiceNowV2Object, use:
{
type: 'ServiceNowV2Object'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SharePointOnlineListResource, use:
{
type: 'SharePointOnlineListResource'
typeProperties: {
listName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For ShopifyObject, use:
{
type: 'ShopifyObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SnowflakeTable, use:
{
type: 'SnowflakeTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SnowflakeV2Table, use:
{
type: 'SnowflakeV2Table'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SparkObject, use:
{
type: 'SparkObject'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SqlServerTable, use:
{
type: 'SqlServerTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SquareObject, use:
{
type: 'SquareObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For SybaseTable, use:
{
type: 'SybaseTable'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For TeradataTable, use:
{
type: 'TeradataTable'
typeProperties: {
database: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For VerticaTable, use:
{
type: 'VerticaTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For WarehouseTable, use:
{
type: 'WarehouseTable'
typeProperties: {
schema: any(Azure.Bicep.Types.Concrete.AnyType)
table: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For WebTable, use:
{
type: 'WebTable'
typeProperties: {
index: any(Azure.Bicep.Types.Concrete.AnyType)
path: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For XeroObject, use:
{
type: 'XeroObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For Xml, use:
{
type: 'Xml'
typeProperties: {
compression: {
level: any(Azure.Bicep.Types.Concrete.AnyType)
type: any(Azure.Bicep.Types.Concrete.AnyType)
}
encodingName: any(Azure.Bicep.Types.Concrete.AnyType)
location: {
fileName: any(Azure.Bicep.Types.Concrete.AnyType)
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see DatasetLocation objects
}
nullValue: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
For ZohoObject, use:
{
type: 'ZohoObject'
typeProperties: {
tableName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
DatasetStorageFormat objects
Set the type property to specify the type of object.
For AvroFormat, use:
{
type: 'AvroFormat'
}
For JsonFormat, use:
{
encodingName: any(Azure.Bicep.Types.Concrete.AnyType)
filePattern: any(Azure.Bicep.Types.Concrete.AnyType)
jsonNodeReference: any(Azure.Bicep.Types.Concrete.AnyType)
jsonPathDefinition: any(Azure.Bicep.Types.Concrete.AnyType)
nestingSeparator: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'JsonFormat'
}
For OrcFormat, use:
{
type: 'OrcFormat'
}
For ParquetFormat, use:
{
type: 'ParquetFormat'
}
For TextFormat, use:
{
columnDelimiter: any(Azure.Bicep.Types.Concrete.AnyType)
encodingName: any(Azure.Bicep.Types.Concrete.AnyType)
escapeChar: any(Azure.Bicep.Types.Concrete.AnyType)
firstRowAsHeader: any(Azure.Bicep.Types.Concrete.AnyType)
nullValue: any(Azure.Bicep.Types.Concrete.AnyType)
quoteChar: any(Azure.Bicep.Types.Concrete.AnyType)
rowDelimiter: any(Azure.Bicep.Types.Concrete.AnyType)
skipLineCount: any(Azure.Bicep.Types.Concrete.AnyType)
treatEmptyAsNull: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'TextFormat'
}
DatasetLocation objects
Set the type property to specify the type of object.
For AmazonS3CompatibleLocation, use:
{
bucketName: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'AmazonS3CompatibleLocation'
version: any(Azure.Bicep.Types.Concrete.AnyType)
}
For AmazonS3Location, use:
{
bucketName: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'AmazonS3Location'
version: any(Azure.Bicep.Types.Concrete.AnyType)
}
For AzureBlobFSLocation, use:
{
fileSystem: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'AzureBlobFSLocation'
}
For AzureBlobStorageLocation, use:
{
container: any(Azure.Bicep.Types.Concrete.AnyType)
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:
{
bucketName: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'GoogleCloudStorageLocation'
version: any(Azure.Bicep.Types.Concrete.AnyType)
}
For HdfsLocation, use:
{
type: 'HdfsLocation'
}
For HttpServerLocation, use:
{
relativeUrl: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'HttpServerLocation'
}
For LakeHouseLocation, use:
{
type: 'LakeHouseLocation'
}
For OracleCloudStorageLocation, use:
{
bucketName: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'OracleCloudStorageLocation'
version: any(Azure.Bicep.Types.Concrete.AnyType)
}
For SftpLocation, use:
{
type: 'SftpLocation'
}
Property values
AmazonMWSObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'AmazonMWSObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
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). | any |
table | The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string). | any |
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). | any |
table | The table name of the SQL Server dataset. Type: string (or Expression with resultType string). | any |
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). | any |
table | The Amazon Redshift table name. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
AmazonS3CompatibleLocation
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of Amazon S3 Compatible. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'AmazonS3CompatibleLocation' (required) |
version | Specify the version of Amazon S3 Compatible. Type: string (or Expression with resultType string). | any |
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). | any (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). | any |
modifiedDatetimeEnd | The end of S3 object's modified datetime. Type: string (or Expression with resultType string). | any |
modifiedDatetimeStart | The start of S3 object's modified datetime. Type: string (or Expression with resultType string). | any |
prefix | The prefix filter for the S3 object name. Type: string (or Expression with resultType string). | any |
version | The version for the S3 object. Type: string (or Expression with resultType string). | any |
AmazonS3Location
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of amazon S3. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'AmazonS3Location' (required) |
version | Specify the version of amazon S3. Type: string (or Expression with resultType string). | any |
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). | any |
avroCompressionLevel | int Constraints: Min value = 1 Max value = 9 |
|
location | The location of the avro storage. | DatasetLocation (required) |
AvroFormat
Name | Description | Value |
---|---|---|
type | Type of dataset storage format. | 'AvroFormat' (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). | any |
folderPath | The path of the Azure Blob storage. Type: string (or Expression with resultType string). | any |
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). | any |
modifiedDatetimeStart | The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string). | any |
tableRootLocation | The root of blob path. Type: string (or Expression with resultType string). | any |
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). | any |
folderPath | The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string). | any |
format | The format of the Azure Data Lake Storage Gen2 storage. | DatasetStorageFormat |
AzureBlobFSLocation
Name | Description | Value |
---|---|---|
fileSystem | Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string). | any |
type | Type of dataset storage location. | 'AzureBlobFSLocation' (required) |
AzureBlobStorageLocation
Name | Description | Value |
---|---|---|
container | Specify the container of azure blob. Type: string (or Expression with resultType string). | any |
type | Type of dataset storage location. | 'AzureBlobStorageLocation' (required) |
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). | any |
table | The name of delta table. Type: string (or Expression with resultType string). | any |
AzureDataExplorerDatasetTypeProperties
Name | Description | Value |
---|---|---|
table | The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string). | any |
AzureDataExplorerTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'AzureDataExplorerTable' (required) |
typeProperties | Azure Data Explorer (Kusto) dataset properties. | AzureDataExplorerDatasetTypeProperties (required) |
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). | any |
folderPath | Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string). | any |
format | The format of the Data Lake Store. | DatasetStorageFormat |
AzureDataLakeStoreLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'AzureDataLakeStoreLocation' (required) |
AzureFileStorageLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'AzureFileStorageLocation' (required) |
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). | any |
tableName | The Azure MySQL database table name. Type: string (or Expression with resultType string). | any |
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). | any |
table | The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string). | any |
tableName | The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string). | any |
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). | any (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). | any |
table | The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
table | The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
table | The table name of the Azure SQL database. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any (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). | any |
tableName | The table name of the Cassandra database. Type: string (or Expression with resultType string). | any |
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). | any |
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). | any (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). | any (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. | any |
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. | any |
structure | Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. | any |
type | Set to 'AmazonMWSObject' for type AmazonMWSObjectDataset. Set to 'AmazonRdsForOracleTable' for type AmazonRdsForOracleTableDataset. Set to 'AmazonRdsForSqlServerTable' for type AmazonRdsForSqlServerTableDataset. Set to 'AmazonRedshiftTable' for type AmazonRedshiftTableDataset. Set to 'AmazonS3Object' for type AmazonS3Dataset. Set to 'Avro' for type AvroDataset. Set to 'AzureBlob' for type AzureBlobDataset. Set to 'AzureBlobFSFile' for type AzureBlobFSDataset. Set to 'AzureDataExplorerTable' for type AzureDataExplorerTableDataset. Set to 'AzureDataLakeStoreFile' for type AzureDataLakeStoreDataset. Set to 'AzureDatabricksDeltaLakeDataset' for type AzureDatabricksDeltaLakeDataset. Set to 'AzureMariaDBTable' for type AzureMariaDBTableDataset. Set to 'AzureMySqlTable' for type AzureMySqlTableDataset. Set to 'AzurePostgreSqlTable' for type AzurePostgreSqlTableDataset. Set to 'AzureSearchIndex' for type AzureSearchIndexDataset. Set to 'AzureSqlDWTable' for type AzureSqlDWTableDataset. Set to 'AzureSqlMITable' for type AzureSqlMITableDataset. Set to 'AzureSqlTable' for type AzureSqlTableDataset. Set to 'AzureTable' for type AzureTableDataset. Set to 'Binary' for type BinaryDataset. Set to 'CassandraTable' for type CassandraTableDataset. Set to 'CommonDataServiceForAppsEntity' for type CommonDataServiceForAppsEntityDataset. Set to 'ConcurObject' for type ConcurObjectDataset. Set to 'CosmosDbMongoDbApiCollection' for type CosmosDbMongoDbApiCollectionDataset. Set to 'CosmosDbSqlApiCollection' for type CosmosDbSqlApiCollectionDataset. Set to 'CouchbaseTable' for type CouchbaseTableDataset. Set to 'CustomDataset' for type CustomDataset. Set to 'Db2Table' for type Db2TableDataset. Set to 'DelimitedText' for type DelimitedTextDataset. Set to 'DocumentDbCollection' for type DocumentDbCollectionDataset. Set to 'DrillTable' for type DrillTableDataset. Set to 'DynamicsAXResource' for type DynamicsAXResourceDataset. Set to 'DynamicsCrmEntity' for type DynamicsCrmEntityDataset. Set to 'DynamicsEntity' for type DynamicsEntityDataset. Set to 'EloquaObject' for type EloquaObjectDataset. Set to 'Excel' for type ExcelDataset. Set to 'FileShare' for type FileShareDataset. Set to 'GoogleAdWordsObject' for type GoogleAdWordsObjectDataset. Set to 'GoogleBigQueryObject' for type GoogleBigQueryObjectDataset. Set to 'GoogleBigQueryV2Object' for type GoogleBigQueryV2ObjectDataset. Set to 'GreenplumTable' for type GreenplumTableDataset. Set to 'HBaseObject' for type HBaseObjectDataset. Set to 'HiveObject' for type HiveObjectDataset. Set to 'HttpFile' for type HttpDataset. Set to 'HubspotObject' for type HubspotObjectDataset. Set to 'Iceberg' for type IcebergDataset. Set to 'ImpalaObject' for type ImpalaObjectDataset. Set to 'InformixTable' for type InformixTableDataset. Set to 'JiraObject' for type JiraObjectDataset. Set to 'Json' for type JsonDataset. Set to 'LakeHouseTable' for type LakeHouseTableDataset. Set to 'MagentoObject' for type MagentoObjectDataset. Set to 'MariaDBTable' for type MariaDBTableDataset. Set to 'MarketoObject' for type MarketoObjectDataset. Set to 'MicrosoftAccessTable' for type MicrosoftAccessTableDataset. Set to 'MongoDbAtlasCollection' for type MongoDbAtlasCollectionDataset. Set to 'MongoDbCollection' for type MongoDbCollectionDataset. Set to 'MongoDbV2Collection' for type MongoDbV2CollectionDataset. Set to 'MySqlTable' for type MySqlTableDataset. Set to 'NetezzaTable' for type NetezzaTableDataset. Set to 'ODataResource' for type ODataResourceDataset. Set to 'OdbcTable' for type OdbcTableDataset. Set to 'Office365Table' for type Office365Dataset. Set to 'OracleServiceCloudObject' for type OracleServiceCloudObjectDataset. Set to 'OracleTable' for type OracleTableDataset. Set to 'Orc' for type OrcDataset. Set to 'Parquet' for type ParquetDataset. Set to 'PaypalObject' for type PaypalObjectDataset. Set to 'PhoenixObject' for type PhoenixObjectDataset. Set to 'PostgreSqlTable' for type PostgreSqlTableDataset. Set to 'PostgreSqlV2Table' for type PostgreSqlV2TableDataset. Set to 'PrestoObject' for type PrestoObjectDataset. Set to 'QuickBooksObject' for type QuickBooksObjectDataset. Set to 'RelationalTable' for type RelationalTableDataset. Set to 'ResponsysObject' for type ResponsysObjectDataset. Set to 'RestResource' for type RestResourceDataset. Set to 'SalesforceMarketingCloudObject' for type SalesforceMarketingCloudObjectDataset. Set to 'SalesforceObject' for type SalesforceObjectDataset. Set to 'SalesforceServiceCloudObject' for type SalesforceServiceCloudObjectDataset. Set to 'SalesforceServiceCloudV2Object' for type SalesforceServiceCloudV2ObjectDataset. Set to 'SalesforceV2Object' for type SalesforceV2ObjectDataset. Set to 'SapBwCube' for type SapBwCubeDataset. Set to 'SapCloudForCustomerResource' for type SapCloudForCustomerResourceDataset. Set to 'SapEccResource' for type SapEccResourceDataset. Set to 'SapHanaTable' for type SapHanaTableDataset. Set to 'SapOdpResource' for type SapOdpResourceDataset. Set to 'SapOpenHubTable' for type SapOpenHubTableDataset. Set to 'SapTableResource' for type SapTableResourceDataset. Set to 'ServiceNowObject' for type ServiceNowObjectDataset. Set to 'ServiceNowV2Object' for type ServiceNowV2ObjectDataset. Set to 'SharePointOnlineListResource' for type SharePointOnlineListResourceDataset. Set to 'ShopifyObject' for type ShopifyObjectDataset. Set to 'SnowflakeTable' for type SnowflakeDataset. Set to 'SnowflakeV2Table' for type SnowflakeV2Dataset. Set to 'SparkObject' for type SparkObjectDataset. Set to 'SqlServerTable' for type SqlServerTableDataset. Set to 'SquareObject' for type SquareObjectDataset. Set to 'SybaseTable' for type SybaseTableDataset. Set to 'TeradataTable' for type TeradataTableDataset. Set to 'VerticaTable' for type VerticaTableDataset. Set to 'WarehouseTable' for type WarehouseTableDataset. Set to 'WebTable' for type WebTableDataset. Set to 'XeroObject' for type XeroObjectDataset. Set to 'Xml' for type XmlDataset. Set to 'ZohoObject' for type ZohoObjectDataset. | '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' 'Iceberg' '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) |
DatasetCompression
Name | Description | Value |
---|---|---|
level | The dataset compression level. Type: string (or Expression with resultType string). | any |
type | Type of dataset compression. Type: string (or Expression with resultType string). | any (required) |
DatasetFolder
Name | Description | Value |
---|---|---|
name | The name of the folder that this Dataset is in. | string |
DatasetLocation
Name | Description | Value |
---|---|---|
fileName | Specify the file name of dataset. Type: string (or Expression with resultType string). | any |
folderPath | Specify the folder path of dataset. Type: string (or Expression with resultType string) | any |
type | Set to 'AmazonS3CompatibleLocation' for type AmazonS3CompatibleLocation. Set to 'AmazonS3Location' for type AmazonS3Location. Set to 'AzureBlobFSLocation' for type AzureBlobFSLocation. Set to 'AzureBlobStorageLocation' for type AzureBlobStorageLocation. Set to 'AzureDataLakeStoreLocation' for type AzureDataLakeStoreLocation. Set to 'AzureFileStorageLocation' for type AzureFileStorageLocation. Set to 'FileServerLocation' for type FileServerLocation. Set to 'FtpServerLocation' for type FtpServerLocation. Set to 'GoogleCloudStorageLocation' for type GoogleCloudStorageLocation. Set to 'HdfsLocation' for type HdfsLocation. Set to 'HttpServerLocation' for type HttpServerLocation. Set to 'LakeHouseLocation' for type LakeHouseLocation. Set to 'OracleCloudStorageLocation' for type OracleCloudStorageLocation. Set to 'SftpLocation' for type SftpLocation. | 'AmazonS3CompatibleLocation' 'AmazonS3Location' 'AzureBlobFSLocation' 'AzureBlobStorageLocation' 'AzureDataLakeStoreLocation' 'AzureFileStorageLocation' 'FileServerLocation' 'FtpServerLocation' 'GoogleCloudStorageLocation' 'HdfsLocation' 'HttpServerLocation' 'LakeHouseLocation' 'OracleCloudStorageLocation' 'SftpLocation' (required) |
DatasetStorageFormat
Name | Description | Value |
---|---|---|
deserializer | Deserializer. Type: string (or Expression with resultType string). | any |
serializer | Serializer. Type: string (or Expression with resultType string). | any |
type | Set to 'AvroFormat' for type AvroFormat. Set to 'JsonFormat' for type JsonFormat. Set to 'OrcFormat' for type OrcFormat. Set to 'ParquetFormat' for type ParquetFormat. Set to 'TextFormat' for type TextFormat. | 'AvroFormat' 'JsonFormat' 'OrcFormat' 'ParquetFormat' 'TextFormat' (required) |
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). | any |
table | The Db2 table name. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
compressionCodec | The data compressionCodec. Type: string (or Expression with resultType string). | any |
compressionLevel | The data compression method used for DelimitedText. | any |
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). | any |
escapeChar | The escape character. Type: string (or Expression with resultType string). | any |
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). | any |
location | The location of the delimited text storage. | DatasetLocation (required) |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
quoteChar | The quote character. Type: string (or Expression with resultType string). | any |
rowDelimiter | The row delimiter. Type: string (or Expression with resultType string). | any |
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). | any (required) |
DrillDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Drill. Type: string (or Expression with resultType string). | any |
table | The table name of the Drill. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
DrillTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'DrillTable' (required) |
typeProperties | Properties specific to this dataset type. | DrillDatasetTypeProperties |
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). | any (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). | any |
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). | any |
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). | any |
location | The location of the excel storage. | DatasetLocation (required) |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
range | The partial data of one sheet. Type: string (or Expression with resultType string). | any |
sheetIndex | The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer) | any |
sheetName | The sheet name of excel file. Type: string (or Expression with resultType string). | any |
FileServerLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'FileServerLocation' (required) |
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). | any |
fileName | The name of the on-premises file system. Type: string (or Expression with resultType string). | any |
folderPath | The path of the on-premises file system. Type: string (or Expression with resultType string). | any |
format | The format of the files. | DatasetStorageFormat |
modifiedDatetimeEnd | The end of file's modified datetime. Type: string (or Expression with resultType string). | any |
modifiedDatetimeStart | The start of file's modified datetime. Type: string (or Expression with resultType string). | any |
FtpServerLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'FtpServerLocation' (required) |
GenericDatasetTypeProperties
Name | Description | Value |
---|---|---|
tableName | The table name. Type: string (or Expression with resultType string). | any |
GoogleAdWordsObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GoogleAdWordsObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
GoogleBigQueryDatasetTypeProperties
Name | Description | Value |
---|---|---|
dataset | The database name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
table | The table name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using database + table properties instead. | any |
GoogleBigQueryObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GoogleBigQueryObject' (required) |
typeProperties | Properties specific to this dataset type. | GoogleBigQueryDatasetTypeProperties |
GoogleBigQueryV2DatasetTypeProperties
Name | Description | Value |
---|---|---|
dataset | The database name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
table | The table name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
GoogleBigQueryV2ObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GoogleBigQueryV2Object' (required) |
typeProperties | Properties specific to this dataset type. | GoogleBigQueryV2DatasetTypeProperties |
GoogleCloudStorageLocation
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'GoogleCloudStorageLocation' (required) |
version | Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string). | any |
GreenplumDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of Greenplum. Type: string (or Expression with resultType string). | any |
table | The table name of Greenplum. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
GreenplumTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GreenplumTable' (required) |
typeProperties | Properties specific to this dataset type. | GreenplumDatasetTypeProperties |
HBaseObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'HBaseObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
HdfsLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'HdfsLocation' (required) |
HiveDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Hive. Type: string (or Expression with resultType string). | any |
table | The table name of the Hive. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
HiveObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'HiveObject' (required) |
typeProperties | Properties specific to this dataset type. | HiveDatasetTypeProperties |
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). |
any |
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). | any |
requestBody | The body for the HTTP request. Type: string (or Expression with resultType string). | any |
requestMethod | The HTTP method for the HTTP request. Type: string (or Expression with resultType string). | any |
HttpServerLocation
Name | Description | Value |
---|---|---|
relativeUrl | Specify the relativeUrl of http server. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'HttpServerLocation' (required) |
HubspotObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'HubspotObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
IcebergDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'Iceberg' (required) |
typeProperties | Iceberg dataset properties. | IcebergDatasetTypeProperties |
IcebergDatasetTypeProperties
Name | Description | Value |
---|---|---|
location | The location of the iceberg storage. Setting a file name is not allowed for iceberg format. | DatasetLocation (required) |
ImpalaDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Impala. Type: string (or Expression with resultType string). | any |
table | The table name of the Impala. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
ImpalaObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'ImpalaObject' (required) |
typeProperties | Properties specific to this dataset type. | ImpalaDatasetTypeProperties |
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). | any |
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). | any |
location | The location of the json data storage. | DatasetLocation (required) |
JsonFormat
Name | Description | Value |
---|---|---|
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). | any |
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. | any |
jsonNodeReference | The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string). | any |
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). | any |
nestingSeparator | The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string). | any |
type | Type of dataset storage format. | 'JsonFormat' (required) |
LakeHouseLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'LakeHouseLocation' (required) |
LakeHouseTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'LakeHouseTable' (required) |
typeProperties | Microsoft Fabric LakeHouse Table dataset properties. | LakeHouseTableDatasetTypeProperties |
LakeHouseTableDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string). | any |
table | The name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string). | any |
LinkedServiceReference
Name | Description | Value |
---|---|---|
parameters | Arguments for LinkedService. | ParameterValueSpecification |
referenceName | Reference LinkedService name. | string (required) |
type | Linked service reference type. | 'LinkedServiceReference' (required) |
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 |
Microsoft.DataFactory/factories/datasets
Name | Description | Value |
---|---|---|
name | The resource name | string Constraints: Min length = 1 Max length = 260 Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required) |
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) |
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). | any |
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). | any (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). | any (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). | any (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). | any |
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). | any |
table | The table name of the Netezza. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
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). | any |
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). | any |
tableName | Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string). | any (required) |
OracleCloudStorageLocation
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of Oracle Cloud Storage. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'OracleCloudStorageLocation' (required) |
version | Specify the version of Oracle Cloud Storage. Type: string (or Expression with resultType string). | any |
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). | any |
table | The table name of the on-premises Oracle database. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
OrcFormat
Name | Description | Value |
---|---|---|
type | Type of dataset storage format. | 'OrcFormat' (required) |
ParameterDefinitionSpecification
Name | Description | Value |
---|
ParameterSpecification
Name | Description | Value |
---|---|---|
defaultValue | Default value of parameter. | any |
type | Parameter type. | 'Array' 'Bool' 'Float' 'Int' 'Object' 'SecureString' 'String' (required) |
ParameterValueSpecification
Name | Description | Value |
---|
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). | any |
location | The location of the parquet storage. | DatasetLocation (required) |
ParquetFormat
Name | Description | Value |
---|---|---|
type | Type of dataset storage format. | 'ParquetFormat' (required) |
PaypalObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'PaypalObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
PhoenixDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Phoenix. Type: string (or Expression with resultType string). | any |
table | The table name of the Phoenix. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
PhoenixObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'PhoenixObject' (required) |
typeProperties | Properties specific to this dataset type. | PhoenixDatasetTypeProperties |
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). | any |
table | The PostgreSQL table name. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
table | The PostgreSQL table name. Type: string (or Expression with resultType string). | any |
PrestoDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Presto. Type: string (or Expression with resultType string). | any |
table | The table name of the Presto. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
PrestoObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'PrestoObject' (required) |
typeProperties | Properties specific to this dataset type. | PrestoDatasetTypeProperties |
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). | any |
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). | any |
requestBody | The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string). | any |
requestMethod | The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string). | any |
RestResourceDatasetTypePropertiesAdditionalHeaders
Name | Description | Value |
---|
RestResourceDatasetTypePropertiesPaginationRules
Name | Description | Value |
---|
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). | any |
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). | any |
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). | any |
reportId | The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string). | any |
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). | any |
reportId | The Salesforce V2 report Id. Type: string (or Expression with resultType string). | any |
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). | any (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). | any (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). | any |
table | The table name of SAP HANA. Type: string (or Expression with resultType string). | any |
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). | any (required) |
objectName | The name of the SAP ODP Object. Type: string (or Expression with resultType string). | any (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 ). | any |
excludeLastRequest | Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
openHubDestinationName | The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string). | any (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). | any (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 |
SftpLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'SftpLocation' (required) |
SharePointOnlineListDatasetTypeProperties
Name | Description | Value |
---|---|---|
listName | The name of the SharePoint Online list. Type: string (or Expression with resultType string). | any |
SharePointOnlineListResourceDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'SharePointOnlineListResource' (required) |
typeProperties | Sharepoint online list dataset properties. | SharePointOnlineListDatasetTypeProperties |
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). | any |
table | The table name of the Snowflake database. Type: string (or Expression with resultType string). | any |
SnowflakeV2Dataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'SnowflakeV2Table' (required) |
typeProperties | Snowflake dataset properties. | SnowflakeDatasetTypeProperties (required) |
SparkDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Spark. Type: string (or Expression with resultType string). | any |
table | The table name of the Spark. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
SparkObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'SparkObject' (required) |
typeProperties | Properties specific to this dataset type. | SparkDatasetTypeProperties |
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). | any |
table | The table name of the SQL Server dataset. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
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). | any |
table | The table name of Teradata. Type: string (or Expression with resultType string). | any |
TextFormat
Name | Description | Value |
---|---|---|
columnDelimiter | The column delimiter. Type: string (or Expression with resultType string). | any |
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). | any |
escapeChar | The escape character. Type: string (or Expression with resultType string). | any |
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). | any |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
quoteChar | The quote character. Type: string (or Expression with resultType string). | any |
rowDelimiter | The row delimiter. Type: string (or Expression with resultType string). | any |
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). | any |
treatEmptyAsNull | Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
type | Type of dataset storage format. | 'TextFormat' (required) |
VerticaDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Vertica. Type: string (or Expression with resultType string). | any |
table | The table name of the Vertica. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
VerticaTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'VerticaTable' (required) |
typeProperties | Properties specific to this dataset type. | VerticaDatasetTypeProperties |
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). | any |
table | The table name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). | any |
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. | any (required) |
path | The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string). | any |
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). | any |
location | The location of the json data storage. | DatasetLocation (required) |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
ZohoObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'ZohoObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
Quickstart samples
The following quickstart samples deploy this resource type.
Bicep File | Description |
---|---|
Create a V2 data factory | This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
More is possible with Azure Data Factory - One click to try Azure Data Factory | This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob |
ARM template resource definition
The factories/datasets resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": [ {} ],
"description": "string",
"folder": {
"name": "string"
},
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"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": {}
},
"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": {}
},
"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": {}
},
"fileName": {},
"folderPath": {},
"format": {
"deserializer": {},
"serializer": {},
"type": "string"
// For remaining properties, see DatasetStorageFormat objects
}
}
}
For AzureDataExplorerTable, use:
{
"type": "AzureDataExplorerTable",
"typeProperties": {
"table": {}
}
}
For AzureDataLakeStoreFile, use:
{
"type": "AzureDataLakeStoreFile",
"typeProperties": {
"compression": {
"level": {},
"type": {}
},
"fileName": {},
"folderPath": {},
"format": {
"deserializer": {},
"serializer": {},
"type": "string"
// For remaining properties, see DatasetStorageFormat objects
}
}
}
For AzureDatabricksDeltaLakeDataset, use:
{
"type": "AzureDatabricksDeltaLakeDataset",
"typeProperties": {
"database": {},
"table": {}
}
}
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": {}
},
"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": {}
},
"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": {}
},
"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": {}
},
"format": {
"deserializer": {},
"serializer": {},
"type": "string"
// For remaining properties, see DatasetStorageFormat objects
},
"relativeUrl": {},
"requestBody": {},
"requestMethod": {}
}
}
For HubspotObject, use:
{
"type": "HubspotObject",
"typeProperties": {
"tableName": {}
}
}
For Iceberg, use:
{
"type": "Iceberg",
"typeProperties": {
"location": {
"fileName": {},
"folderPath": {},
"type": "string"
// For remaining properties, see DatasetLocation objects
}
}
}
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": {}
},
"encodingName": {},
"location": {
"fileName": {},
"folderPath": {},
"type": "string"
// For remaining properties, see DatasetLocation objects
}
}
}
For LakeHouseTable, use:
{
"type": "LakeHouseTable",
"typeProperties": {
"schema": {},
"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": {}
},
"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:
{
"encodingName": {},
"filePattern": {},
"jsonNodeReference": {},
"jsonPathDefinition": {},
"nestingSeparator": {},
"type": "JsonFormat"
}
For OrcFormat, use:
{
"type": "OrcFormat"
}
For ParquetFormat, use:
{
"type": "ParquetFormat"
}
For TextFormat, use:
{
"columnDelimiter": {},
"encodingName": {},
"escapeChar": {},
"firstRowAsHeader": {},
"nullValue": {},
"quoteChar": {},
"rowDelimiter": {},
"skipLineCount": {},
"treatEmptyAsNull": {},
"type": "TextFormat"
}
DatasetLocation objects
Set the type property to specify the type of object.
For AmazonS3CompatibleLocation, use:
{
"bucketName": {},
"type": "AmazonS3CompatibleLocation",
"version": {}
}
For AmazonS3Location, use:
{
"bucketName": {},
"type": "AmazonS3Location",
"version": {}
}
For AzureBlobFSLocation, use:
{
"fileSystem": {},
"type": "AzureBlobFSLocation"
}
For AzureBlobStorageLocation, use:
{
"container": {},
"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:
{
"bucketName": {},
"type": "GoogleCloudStorageLocation",
"version": {}
}
For HdfsLocation, use:
{
"type": "HdfsLocation"
}
For HttpServerLocation, use:
{
"relativeUrl": {},
"type": "HttpServerLocation"
}
For LakeHouseLocation, use:
{
"type": "LakeHouseLocation"
}
For OracleCloudStorageLocation, use:
{
"bucketName": {},
"type": "OracleCloudStorageLocation",
"version": {}
}
For SftpLocation, use:
{
"type": "SftpLocation"
}
Property values
AmazonMWSObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'AmazonMWSObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
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). | any |
table | The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string). | any |
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). | any |
table | The table name of the SQL Server dataset. Type: string (or Expression with resultType string). | any |
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). | any |
table | The Amazon Redshift table name. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
AmazonS3CompatibleLocation
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of Amazon S3 Compatible. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'AmazonS3CompatibleLocation' (required) |
version | Specify the version of Amazon S3 Compatible. Type: string (or Expression with resultType string). | any |
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). | any (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). | any |
modifiedDatetimeEnd | The end of S3 object's modified datetime. Type: string (or Expression with resultType string). | any |
modifiedDatetimeStart | The start of S3 object's modified datetime. Type: string (or Expression with resultType string). | any |
prefix | The prefix filter for the S3 object name. Type: string (or Expression with resultType string). | any |
version | The version for the S3 object. Type: string (or Expression with resultType string). | any |
AmazonS3Location
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of amazon S3. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'AmazonS3Location' (required) |
version | Specify the version of amazon S3. Type: string (or Expression with resultType string). | any |
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). | any |
avroCompressionLevel | int Constraints: Min value = 1 Max value = 9 |
|
location | The location of the avro storage. | DatasetLocation (required) |
AvroFormat
Name | Description | Value |
---|---|---|
type | Type of dataset storage format. | 'AvroFormat' (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). | any |
folderPath | The path of the Azure Blob storage. Type: string (or Expression with resultType string). | any |
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). | any |
modifiedDatetimeStart | The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string). | any |
tableRootLocation | The root of blob path. Type: string (or Expression with resultType string). | any |
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). | any |
folderPath | The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string). | any |
format | The format of the Azure Data Lake Storage Gen2 storage. | DatasetStorageFormat |
AzureBlobFSLocation
Name | Description | Value |
---|---|---|
fileSystem | Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string). | any |
type | Type of dataset storage location. | 'AzureBlobFSLocation' (required) |
AzureBlobStorageLocation
Name | Description | Value |
---|---|---|
container | Specify the container of azure blob. Type: string (or Expression with resultType string). | any |
type | Type of dataset storage location. | 'AzureBlobStorageLocation' (required) |
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). | any |
table | The name of delta table. Type: string (or Expression with resultType string). | any |
AzureDataExplorerDatasetTypeProperties
Name | Description | Value |
---|---|---|
table | The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string). | any |
AzureDataExplorerTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'AzureDataExplorerTable' (required) |
typeProperties | Azure Data Explorer (Kusto) dataset properties. | AzureDataExplorerDatasetTypeProperties (required) |
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). | any |
folderPath | Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string). | any |
format | The format of the Data Lake Store. | DatasetStorageFormat |
AzureDataLakeStoreLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'AzureDataLakeStoreLocation' (required) |
AzureFileStorageLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'AzureFileStorageLocation' (required) |
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). | any |
tableName | The Azure MySQL database table name. Type: string (or Expression with resultType string). | any |
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). | any |
table | The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string). | any |
tableName | The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string). | any |
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). | any (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). | any |
table | The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
table | The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
table | The table name of the Azure SQL database. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any (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). | any |
tableName | The table name of the Cassandra database. Type: string (or Expression with resultType string). | any |
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). | any |
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). | any (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). | any (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. | any |
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. | any |
structure | Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. | any |
type | Set to 'AmazonMWSObject' for type AmazonMWSObjectDataset. Set to 'AmazonRdsForOracleTable' for type AmazonRdsForOracleTableDataset. Set to 'AmazonRdsForSqlServerTable' for type AmazonRdsForSqlServerTableDataset. Set to 'AmazonRedshiftTable' for type AmazonRedshiftTableDataset. Set to 'AmazonS3Object' for type AmazonS3Dataset. Set to 'Avro' for type AvroDataset. Set to 'AzureBlob' for type AzureBlobDataset. Set to 'AzureBlobFSFile' for type AzureBlobFSDataset. Set to 'AzureDataExplorerTable' for type AzureDataExplorerTableDataset. Set to 'AzureDataLakeStoreFile' for type AzureDataLakeStoreDataset. Set to 'AzureDatabricksDeltaLakeDataset' for type AzureDatabricksDeltaLakeDataset. Set to 'AzureMariaDBTable' for type AzureMariaDBTableDataset. Set to 'AzureMySqlTable' for type AzureMySqlTableDataset. Set to 'AzurePostgreSqlTable' for type AzurePostgreSqlTableDataset. Set to 'AzureSearchIndex' for type AzureSearchIndexDataset. Set to 'AzureSqlDWTable' for type AzureSqlDWTableDataset. Set to 'AzureSqlMITable' for type AzureSqlMITableDataset. Set to 'AzureSqlTable' for type AzureSqlTableDataset. Set to 'AzureTable' for type AzureTableDataset. Set to 'Binary' for type BinaryDataset. Set to 'CassandraTable' for type CassandraTableDataset. Set to 'CommonDataServiceForAppsEntity' for type CommonDataServiceForAppsEntityDataset. Set to 'ConcurObject' for type ConcurObjectDataset. Set to 'CosmosDbMongoDbApiCollection' for type CosmosDbMongoDbApiCollectionDataset. Set to 'CosmosDbSqlApiCollection' for type CosmosDbSqlApiCollectionDataset. Set to 'CouchbaseTable' for type CouchbaseTableDataset. Set to 'CustomDataset' for type CustomDataset. Set to 'Db2Table' for type Db2TableDataset. Set to 'DelimitedText' for type DelimitedTextDataset. Set to 'DocumentDbCollection' for type DocumentDbCollectionDataset. Set to 'DrillTable' for type DrillTableDataset. Set to 'DynamicsAXResource' for type DynamicsAXResourceDataset. Set to 'DynamicsCrmEntity' for type DynamicsCrmEntityDataset. Set to 'DynamicsEntity' for type DynamicsEntityDataset. Set to 'EloquaObject' for type EloquaObjectDataset. Set to 'Excel' for type ExcelDataset. Set to 'FileShare' for type FileShareDataset. Set to 'GoogleAdWordsObject' for type GoogleAdWordsObjectDataset. Set to 'GoogleBigQueryObject' for type GoogleBigQueryObjectDataset. Set to 'GoogleBigQueryV2Object' for type GoogleBigQueryV2ObjectDataset. Set to 'GreenplumTable' for type GreenplumTableDataset. Set to 'HBaseObject' for type HBaseObjectDataset. Set to 'HiveObject' for type HiveObjectDataset. Set to 'HttpFile' for type HttpDataset. Set to 'HubspotObject' for type HubspotObjectDataset. Set to 'Iceberg' for type IcebergDataset. Set to 'ImpalaObject' for type ImpalaObjectDataset. Set to 'InformixTable' for type InformixTableDataset. Set to 'JiraObject' for type JiraObjectDataset. Set to 'Json' for type JsonDataset. Set to 'LakeHouseTable' for type LakeHouseTableDataset. Set to 'MagentoObject' for type MagentoObjectDataset. Set to 'MariaDBTable' for type MariaDBTableDataset. Set to 'MarketoObject' for type MarketoObjectDataset. Set to 'MicrosoftAccessTable' for type MicrosoftAccessTableDataset. Set to 'MongoDbAtlasCollection' for type MongoDbAtlasCollectionDataset. Set to 'MongoDbCollection' for type MongoDbCollectionDataset. Set to 'MongoDbV2Collection' for type MongoDbV2CollectionDataset. Set to 'MySqlTable' for type MySqlTableDataset. Set to 'NetezzaTable' for type NetezzaTableDataset. Set to 'ODataResource' for type ODataResourceDataset. Set to 'OdbcTable' for type OdbcTableDataset. Set to 'Office365Table' for type Office365Dataset. Set to 'OracleServiceCloudObject' for type OracleServiceCloudObjectDataset. Set to 'OracleTable' for type OracleTableDataset. Set to 'Orc' for type OrcDataset. Set to 'Parquet' for type ParquetDataset. Set to 'PaypalObject' for type PaypalObjectDataset. Set to 'PhoenixObject' for type PhoenixObjectDataset. Set to 'PostgreSqlTable' for type PostgreSqlTableDataset. Set to 'PostgreSqlV2Table' for type PostgreSqlV2TableDataset. Set to 'PrestoObject' for type PrestoObjectDataset. Set to 'QuickBooksObject' for type QuickBooksObjectDataset. Set to 'RelationalTable' for type RelationalTableDataset. Set to 'ResponsysObject' for type ResponsysObjectDataset. Set to 'RestResource' for type RestResourceDataset. Set to 'SalesforceMarketingCloudObject' for type SalesforceMarketingCloudObjectDataset. Set to 'SalesforceObject' for type SalesforceObjectDataset. Set to 'SalesforceServiceCloudObject' for type SalesforceServiceCloudObjectDataset. Set to 'SalesforceServiceCloudV2Object' for type SalesforceServiceCloudV2ObjectDataset. Set to 'SalesforceV2Object' for type SalesforceV2ObjectDataset. Set to 'SapBwCube' for type SapBwCubeDataset. Set to 'SapCloudForCustomerResource' for type SapCloudForCustomerResourceDataset. Set to 'SapEccResource' for type SapEccResourceDataset. Set to 'SapHanaTable' for type SapHanaTableDataset. Set to 'SapOdpResource' for type SapOdpResourceDataset. Set to 'SapOpenHubTable' for type SapOpenHubTableDataset. Set to 'SapTableResource' for type SapTableResourceDataset. Set to 'ServiceNowObject' for type ServiceNowObjectDataset. Set to 'ServiceNowV2Object' for type ServiceNowV2ObjectDataset. Set to 'SharePointOnlineListResource' for type SharePointOnlineListResourceDataset. Set to 'ShopifyObject' for type ShopifyObjectDataset. Set to 'SnowflakeTable' for type SnowflakeDataset. Set to 'SnowflakeV2Table' for type SnowflakeV2Dataset. Set to 'SparkObject' for type SparkObjectDataset. Set to 'SqlServerTable' for type SqlServerTableDataset. Set to 'SquareObject' for type SquareObjectDataset. Set to 'SybaseTable' for type SybaseTableDataset. Set to 'TeradataTable' for type TeradataTableDataset. Set to 'VerticaTable' for type VerticaTableDataset. Set to 'WarehouseTable' for type WarehouseTableDataset. Set to 'WebTable' for type WebTableDataset. Set to 'XeroObject' for type XeroObjectDataset. Set to 'Xml' for type XmlDataset. Set to 'ZohoObject' for type ZohoObjectDataset. | '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' 'Iceberg' '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) |
DatasetCompression
Name | Description | Value |
---|---|---|
level | The dataset compression level. Type: string (or Expression with resultType string). | any |
type | Type of dataset compression. Type: string (or Expression with resultType string). | any (required) |
DatasetFolder
Name | Description | Value |
---|---|---|
name | The name of the folder that this Dataset is in. | string |
DatasetLocation
Name | Description | Value |
---|---|---|
fileName | Specify the file name of dataset. Type: string (or Expression with resultType string). | any |
folderPath | Specify the folder path of dataset. Type: string (or Expression with resultType string) | any |
type | Set to 'AmazonS3CompatibleLocation' for type AmazonS3CompatibleLocation. Set to 'AmazonS3Location' for type AmazonS3Location. Set to 'AzureBlobFSLocation' for type AzureBlobFSLocation. Set to 'AzureBlobStorageLocation' for type AzureBlobStorageLocation. Set to 'AzureDataLakeStoreLocation' for type AzureDataLakeStoreLocation. Set to 'AzureFileStorageLocation' for type AzureFileStorageLocation. Set to 'FileServerLocation' for type FileServerLocation. Set to 'FtpServerLocation' for type FtpServerLocation. Set to 'GoogleCloudStorageLocation' for type GoogleCloudStorageLocation. Set to 'HdfsLocation' for type HdfsLocation. Set to 'HttpServerLocation' for type HttpServerLocation. Set to 'LakeHouseLocation' for type LakeHouseLocation. Set to 'OracleCloudStorageLocation' for type OracleCloudStorageLocation. Set to 'SftpLocation' for type SftpLocation. | 'AmazonS3CompatibleLocation' 'AmazonS3Location' 'AzureBlobFSLocation' 'AzureBlobStorageLocation' 'AzureDataLakeStoreLocation' 'AzureFileStorageLocation' 'FileServerLocation' 'FtpServerLocation' 'GoogleCloudStorageLocation' 'HdfsLocation' 'HttpServerLocation' 'LakeHouseLocation' 'OracleCloudStorageLocation' 'SftpLocation' (required) |
DatasetStorageFormat
Name | Description | Value |
---|---|---|
deserializer | Deserializer. Type: string (or Expression with resultType string). | any |
serializer | Serializer. Type: string (or Expression with resultType string). | any |
type | Set to 'AvroFormat' for type AvroFormat. Set to 'JsonFormat' for type JsonFormat. Set to 'OrcFormat' for type OrcFormat. Set to 'ParquetFormat' for type ParquetFormat. Set to 'TextFormat' for type TextFormat. | 'AvroFormat' 'JsonFormat' 'OrcFormat' 'ParquetFormat' 'TextFormat' (required) |
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). | any |
table | The Db2 table name. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
compressionCodec | The data compressionCodec. Type: string (or Expression with resultType string). | any |
compressionLevel | The data compression method used for DelimitedText. | any |
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). | any |
escapeChar | The escape character. Type: string (or Expression with resultType string). | any |
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). | any |
location | The location of the delimited text storage. | DatasetLocation (required) |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
quoteChar | The quote character. Type: string (or Expression with resultType string). | any |
rowDelimiter | The row delimiter. Type: string (or Expression with resultType string). | any |
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). | any (required) |
DrillDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Drill. Type: string (or Expression with resultType string). | any |
table | The table name of the Drill. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
DrillTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'DrillTable' (required) |
typeProperties | Properties specific to this dataset type. | DrillDatasetTypeProperties |
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). | any (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). | any |
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). | any |
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). | any |
location | The location of the excel storage. | DatasetLocation (required) |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
range | The partial data of one sheet. Type: string (or Expression with resultType string). | any |
sheetIndex | The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer) | any |
sheetName | The sheet name of excel file. Type: string (or Expression with resultType string). | any |
FileServerLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'FileServerLocation' (required) |
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). | any |
fileName | The name of the on-premises file system. Type: string (or Expression with resultType string). | any |
folderPath | The path of the on-premises file system. Type: string (or Expression with resultType string). | any |
format | The format of the files. | DatasetStorageFormat |
modifiedDatetimeEnd | The end of file's modified datetime. Type: string (or Expression with resultType string). | any |
modifiedDatetimeStart | The start of file's modified datetime. Type: string (or Expression with resultType string). | any |
FtpServerLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'FtpServerLocation' (required) |
GenericDatasetTypeProperties
Name | Description | Value |
---|---|---|
tableName | The table name. Type: string (or Expression with resultType string). | any |
GoogleAdWordsObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GoogleAdWordsObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
GoogleBigQueryDatasetTypeProperties
Name | Description | Value |
---|---|---|
dataset | The database name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
table | The table name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using database + table properties instead. | any |
GoogleBigQueryObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GoogleBigQueryObject' (required) |
typeProperties | Properties specific to this dataset type. | GoogleBigQueryDatasetTypeProperties |
GoogleBigQueryV2DatasetTypeProperties
Name | Description | Value |
---|---|---|
dataset | The database name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
table | The table name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
GoogleBigQueryV2ObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GoogleBigQueryV2Object' (required) |
typeProperties | Properties specific to this dataset type. | GoogleBigQueryV2DatasetTypeProperties |
GoogleCloudStorageLocation
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'GoogleCloudStorageLocation' (required) |
version | Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string). | any |
GreenplumDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of Greenplum. Type: string (or Expression with resultType string). | any |
table | The table name of Greenplum. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
GreenplumTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GreenplumTable' (required) |
typeProperties | Properties specific to this dataset type. | GreenplumDatasetTypeProperties |
HBaseObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'HBaseObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
HdfsLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'HdfsLocation' (required) |
HiveDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Hive. Type: string (or Expression with resultType string). | any |
table | The table name of the Hive. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
HiveObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'HiveObject' (required) |
typeProperties | Properties specific to this dataset type. | HiveDatasetTypeProperties |
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). |
any |
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). | any |
requestBody | The body for the HTTP request. Type: string (or Expression with resultType string). | any |
requestMethod | The HTTP method for the HTTP request. Type: string (or Expression with resultType string). | any |
HttpServerLocation
Name | Description | Value |
---|---|---|
relativeUrl | Specify the relativeUrl of http server. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'HttpServerLocation' (required) |
HubspotObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'HubspotObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
IcebergDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'Iceberg' (required) |
typeProperties | Iceberg dataset properties. | IcebergDatasetTypeProperties |
IcebergDatasetTypeProperties
Name | Description | Value |
---|---|---|
location | The location of the iceberg storage. Setting a file name is not allowed for iceberg format. | DatasetLocation (required) |
ImpalaDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Impala. Type: string (or Expression with resultType string). | any |
table | The table name of the Impala. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
ImpalaObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'ImpalaObject' (required) |
typeProperties | Properties specific to this dataset type. | ImpalaDatasetTypeProperties |
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). | any |
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). | any |
location | The location of the json data storage. | DatasetLocation (required) |
JsonFormat
Name | Description | Value |
---|---|---|
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). | any |
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. | any |
jsonNodeReference | The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string). | any |
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). | any |
nestingSeparator | The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string). | any |
type | Type of dataset storage format. | 'JsonFormat' (required) |
LakeHouseLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'LakeHouseLocation' (required) |
LakeHouseTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'LakeHouseTable' (required) |
typeProperties | Microsoft Fabric LakeHouse Table dataset properties. | LakeHouseTableDatasetTypeProperties |
LakeHouseTableDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string). | any |
table | The name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string). | any |
LinkedServiceReference
Name | Description | Value |
---|---|---|
parameters | Arguments for LinkedService. | ParameterValueSpecification |
referenceName | Reference LinkedService name. | string (required) |
type | Linked service reference type. | 'LinkedServiceReference' (required) |
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 |
Microsoft.DataFactory/factories/datasets
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2018-06-01' |
name | The resource name | string Constraints: Min length = 1 Max length = 260 Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required) |
properties | Dataset properties. | Dataset (required) |
type | The resource type | 'Microsoft.DataFactory/factories/datasets' |
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). | any |
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). | any (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). | any (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). | any (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). | any |
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). | any |
table | The table name of the Netezza. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
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). | any |
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). | any |
tableName | Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string). | any (required) |
OracleCloudStorageLocation
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of Oracle Cloud Storage. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'OracleCloudStorageLocation' (required) |
version | Specify the version of Oracle Cloud Storage. Type: string (or Expression with resultType string). | any |
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). | any |
table | The table name of the on-premises Oracle database. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
OrcFormat
Name | Description | Value |
---|---|---|
type | Type of dataset storage format. | 'OrcFormat' (required) |
ParameterDefinitionSpecification
Name | Description | Value |
---|
ParameterSpecification
Name | Description | Value |
---|---|---|
defaultValue | Default value of parameter. | any |
type | Parameter type. | 'Array' 'Bool' 'Float' 'Int' 'Object' 'SecureString' 'String' (required) |
ParameterValueSpecification
Name | Description | Value |
---|
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). | any |
location | The location of the parquet storage. | DatasetLocation (required) |
ParquetFormat
Name | Description | Value |
---|---|---|
type | Type of dataset storage format. | 'ParquetFormat' (required) |
PaypalObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'PaypalObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
PhoenixDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Phoenix. Type: string (or Expression with resultType string). | any |
table | The table name of the Phoenix. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
PhoenixObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'PhoenixObject' (required) |
typeProperties | Properties specific to this dataset type. | PhoenixDatasetTypeProperties |
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). | any |
table | The PostgreSQL table name. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
table | The PostgreSQL table name. Type: string (or Expression with resultType string). | any |
PrestoDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Presto. Type: string (or Expression with resultType string). | any |
table | The table name of the Presto. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
PrestoObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'PrestoObject' (required) |
typeProperties | Properties specific to this dataset type. | PrestoDatasetTypeProperties |
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). | any |
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). | any |
requestBody | The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string). | any |
requestMethod | The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string). | any |
RestResourceDatasetTypePropertiesAdditionalHeaders
Name | Description | Value |
---|
RestResourceDatasetTypePropertiesPaginationRules
Name | Description | Value |
---|
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). | any |
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). | any |
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). | any |
reportId | The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string). | any |
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). | any |
reportId | The Salesforce V2 report Id. Type: string (or Expression with resultType string). | any |
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). | any (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). | any (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). | any |
table | The table name of SAP HANA. Type: string (or Expression with resultType string). | any |
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). | any (required) |
objectName | The name of the SAP ODP Object. Type: string (or Expression with resultType string). | any (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 ). | any |
excludeLastRequest | Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
openHubDestinationName | The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string). | any (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). | any (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 |
SftpLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'SftpLocation' (required) |
SharePointOnlineListDatasetTypeProperties
Name | Description | Value |
---|---|---|
listName | The name of the SharePoint Online list. Type: string (or Expression with resultType string). | any |
SharePointOnlineListResourceDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'SharePointOnlineListResource' (required) |
typeProperties | Sharepoint online list dataset properties. | SharePointOnlineListDatasetTypeProperties |
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). | any |
table | The table name of the Snowflake database. Type: string (or Expression with resultType string). | any |
SnowflakeV2Dataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'SnowflakeV2Table' (required) |
typeProperties | Snowflake dataset properties. | SnowflakeDatasetTypeProperties (required) |
SparkDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Spark. Type: string (or Expression with resultType string). | any |
table | The table name of the Spark. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
SparkObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'SparkObject' (required) |
typeProperties | Properties specific to this dataset type. | SparkDatasetTypeProperties |
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). | any |
table | The table name of the SQL Server dataset. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
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). | any |
table | The table name of Teradata. Type: string (or Expression with resultType string). | any |
TextFormat
Name | Description | Value |
---|---|---|
columnDelimiter | The column delimiter. Type: string (or Expression with resultType string). | any |
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). | any |
escapeChar | The escape character. Type: string (or Expression with resultType string). | any |
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). | any |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
quoteChar | The quote character. Type: string (or Expression with resultType string). | any |
rowDelimiter | The row delimiter. Type: string (or Expression with resultType string). | any |
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). | any |
treatEmptyAsNull | Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
type | Type of dataset storage format. | 'TextFormat' (required) |
VerticaDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Vertica. Type: string (or Expression with resultType string). | any |
table | The table name of the Vertica. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
VerticaTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'VerticaTable' (required) |
typeProperties | Properties specific to this dataset type. | VerticaDatasetTypeProperties |
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). | any |
table | The table name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). | any |
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. | any (required) |
path | The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string). | any |
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). | any |
location | The location of the json data storage. | DatasetLocation (required) |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
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 |
---|---|
Create a V2 data factory |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
More is possible with Azure Data Factory - One click to try Azure Data Factory |
This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob |
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"
body = jsonencode({
properties = {
annotations = [
?
]
description = "string"
folder = {
name = "string"
}
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
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 = ?
}
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 = ?
}
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 = ?
}
fileName = ?
folderPath = ?
format = {
deserializer = ?
serializer = ?
type = "string"
// For remaining properties, see DatasetStorageFormat objects
}
}
}
For AzureDataExplorerTable, use:
{
type = "AzureDataExplorerTable"
typeProperties = {
table = ?
}
}
For AzureDataLakeStoreFile, use:
{
type = "AzureDataLakeStoreFile"
typeProperties = {
compression = {
level = ?
type = ?
}
fileName = ?
folderPath = ?
format = {
deserializer = ?
serializer = ?
type = "string"
// For remaining properties, see DatasetStorageFormat objects
}
}
}
For AzureDatabricksDeltaLakeDataset, use:
{
type = "AzureDatabricksDeltaLakeDataset"
typeProperties = {
database = ?
table = ?
}
}
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 = ?
}
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 = ?
}
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 = ?
}
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 = ?
}
format = {
deserializer = ?
serializer = ?
type = "string"
// For remaining properties, see DatasetStorageFormat objects
}
relativeUrl = ?
requestBody = ?
requestMethod = ?
}
}
For HubspotObject, use:
{
type = "HubspotObject"
typeProperties = {
tableName = ?
}
}
For Iceberg, use:
{
type = "Iceberg"
typeProperties = {
location = {
fileName = ?
folderPath = ?
type = "string"
// For remaining properties, see DatasetLocation objects
}
}
}
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 = ?
}
encodingName = ?
location = {
fileName = ?
folderPath = ?
type = "string"
// For remaining properties, see DatasetLocation objects
}
}
}
For LakeHouseTable, use:
{
type = "LakeHouseTable"
typeProperties = {
schema = ?
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 = ?
}
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:
{
encodingName = ?
filePattern = ?
jsonNodeReference = ?
jsonPathDefinition = ?
nestingSeparator = ?
type = "JsonFormat"
}
For OrcFormat, use:
{
type = "OrcFormat"
}
For ParquetFormat, use:
{
type = "ParquetFormat"
}
For TextFormat, use:
{
columnDelimiter = ?
encodingName = ?
escapeChar = ?
firstRowAsHeader = ?
nullValue = ?
quoteChar = ?
rowDelimiter = ?
skipLineCount = ?
treatEmptyAsNull = ?
type = "TextFormat"
}
DatasetLocation objects
Set the type property to specify the type of object.
For AmazonS3CompatibleLocation, use:
{
bucketName = ?
type = "AmazonS3CompatibleLocation"
version = ?
}
For AmazonS3Location, use:
{
bucketName = ?
type = "AmazonS3Location"
version = ?
}
For AzureBlobFSLocation, use:
{
fileSystem = ?
type = "AzureBlobFSLocation"
}
For AzureBlobStorageLocation, use:
{
container = ?
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:
{
bucketName = ?
type = "GoogleCloudStorageLocation"
version = ?
}
For HdfsLocation, use:
{
type = "HdfsLocation"
}
For HttpServerLocation, use:
{
relativeUrl = ?
type = "HttpServerLocation"
}
For LakeHouseLocation, use:
{
type = "LakeHouseLocation"
}
For OracleCloudStorageLocation, use:
{
bucketName = ?
type = "OracleCloudStorageLocation"
version = ?
}
For SftpLocation, use:
{
type = "SftpLocation"
}
Property values
AmazonMWSObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'AmazonMWSObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
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). | any |
table | The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string). | any |
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). | any |
table | The table name of the SQL Server dataset. Type: string (or Expression with resultType string). | any |
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). | any |
table | The Amazon Redshift table name. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
AmazonS3CompatibleLocation
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of Amazon S3 Compatible. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'AmazonS3CompatibleLocation' (required) |
version | Specify the version of Amazon S3 Compatible. Type: string (or Expression with resultType string). | any |
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). | any (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). | any |
modifiedDatetimeEnd | The end of S3 object's modified datetime. Type: string (or Expression with resultType string). | any |
modifiedDatetimeStart | The start of S3 object's modified datetime. Type: string (or Expression with resultType string). | any |
prefix | The prefix filter for the S3 object name. Type: string (or Expression with resultType string). | any |
version | The version for the S3 object. Type: string (or Expression with resultType string). | any |
AmazonS3Location
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of amazon S3. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'AmazonS3Location' (required) |
version | Specify the version of amazon S3. Type: string (or Expression with resultType string). | any |
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). | any |
avroCompressionLevel | int Constraints: Min value = 1 Max value = 9 |
|
location | The location of the avro storage. | DatasetLocation (required) |
AvroFormat
Name | Description | Value |
---|---|---|
type | Type of dataset storage format. | 'AvroFormat' (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). | any |
folderPath | The path of the Azure Blob storage. Type: string (or Expression with resultType string). | any |
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). | any |
modifiedDatetimeStart | The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string). | any |
tableRootLocation | The root of blob path. Type: string (or Expression with resultType string). | any |
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). | any |
folderPath | The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string). | any |
format | The format of the Azure Data Lake Storage Gen2 storage. | DatasetStorageFormat |
AzureBlobFSLocation
Name | Description | Value |
---|---|---|
fileSystem | Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string). | any |
type | Type of dataset storage location. | 'AzureBlobFSLocation' (required) |
AzureBlobStorageLocation
Name | Description | Value |
---|---|---|
container | Specify the container of azure blob. Type: string (or Expression with resultType string). | any |
type | Type of dataset storage location. | 'AzureBlobStorageLocation' (required) |
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). | any |
table | The name of delta table. Type: string (or Expression with resultType string). | any |
AzureDataExplorerDatasetTypeProperties
Name | Description | Value |
---|---|---|
table | The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string). | any |
AzureDataExplorerTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'AzureDataExplorerTable' (required) |
typeProperties | Azure Data Explorer (Kusto) dataset properties. | AzureDataExplorerDatasetTypeProperties (required) |
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). | any |
folderPath | Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string). | any |
format | The format of the Data Lake Store. | DatasetStorageFormat |
AzureDataLakeStoreLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'AzureDataLakeStoreLocation' (required) |
AzureFileStorageLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'AzureFileStorageLocation' (required) |
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). | any |
tableName | The Azure MySQL database table name. Type: string (or Expression with resultType string). | any |
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). | any |
table | The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string). | any |
tableName | The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string). | any |
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). | any (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). | any |
table | The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
table | The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
table | The table name of the Azure SQL database. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any (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). | any |
tableName | The table name of the Cassandra database. Type: string (or Expression with resultType string). | any |
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). | any |
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). | any (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). | any (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. | any |
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. | any |
structure | Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. | any |
type | Set to 'AmazonMWSObject' for type AmazonMWSObjectDataset. Set to 'AmazonRdsForOracleTable' for type AmazonRdsForOracleTableDataset. Set to 'AmazonRdsForSqlServerTable' for type AmazonRdsForSqlServerTableDataset. Set to 'AmazonRedshiftTable' for type AmazonRedshiftTableDataset. Set to 'AmazonS3Object' for type AmazonS3Dataset. Set to 'Avro' for type AvroDataset. Set to 'AzureBlob' for type AzureBlobDataset. Set to 'AzureBlobFSFile' for type AzureBlobFSDataset. Set to 'AzureDataExplorerTable' for type AzureDataExplorerTableDataset. Set to 'AzureDataLakeStoreFile' for type AzureDataLakeStoreDataset. Set to 'AzureDatabricksDeltaLakeDataset' for type AzureDatabricksDeltaLakeDataset. Set to 'AzureMariaDBTable' for type AzureMariaDBTableDataset. Set to 'AzureMySqlTable' for type AzureMySqlTableDataset. Set to 'AzurePostgreSqlTable' for type AzurePostgreSqlTableDataset. Set to 'AzureSearchIndex' for type AzureSearchIndexDataset. Set to 'AzureSqlDWTable' for type AzureSqlDWTableDataset. Set to 'AzureSqlMITable' for type AzureSqlMITableDataset. Set to 'AzureSqlTable' for type AzureSqlTableDataset. Set to 'AzureTable' for type AzureTableDataset. Set to 'Binary' for type BinaryDataset. Set to 'CassandraTable' for type CassandraTableDataset. Set to 'CommonDataServiceForAppsEntity' for type CommonDataServiceForAppsEntityDataset. Set to 'ConcurObject' for type ConcurObjectDataset. Set to 'CosmosDbMongoDbApiCollection' for type CosmosDbMongoDbApiCollectionDataset. Set to 'CosmosDbSqlApiCollection' for type CosmosDbSqlApiCollectionDataset. Set to 'CouchbaseTable' for type CouchbaseTableDataset. Set to 'CustomDataset' for type CustomDataset. Set to 'Db2Table' for type Db2TableDataset. Set to 'DelimitedText' for type DelimitedTextDataset. Set to 'DocumentDbCollection' for type DocumentDbCollectionDataset. Set to 'DrillTable' for type DrillTableDataset. Set to 'DynamicsAXResource' for type DynamicsAXResourceDataset. Set to 'DynamicsCrmEntity' for type DynamicsCrmEntityDataset. Set to 'DynamicsEntity' for type DynamicsEntityDataset. Set to 'EloquaObject' for type EloquaObjectDataset. Set to 'Excel' for type ExcelDataset. Set to 'FileShare' for type FileShareDataset. Set to 'GoogleAdWordsObject' for type GoogleAdWordsObjectDataset. Set to 'GoogleBigQueryObject' for type GoogleBigQueryObjectDataset. Set to 'GoogleBigQueryV2Object' for type GoogleBigQueryV2ObjectDataset. Set to 'GreenplumTable' for type GreenplumTableDataset. Set to 'HBaseObject' for type HBaseObjectDataset. Set to 'HiveObject' for type HiveObjectDataset. Set to 'HttpFile' for type HttpDataset. Set to 'HubspotObject' for type HubspotObjectDataset. Set to 'Iceberg' for type IcebergDataset. Set to 'ImpalaObject' for type ImpalaObjectDataset. Set to 'InformixTable' for type InformixTableDataset. Set to 'JiraObject' for type JiraObjectDataset. Set to 'Json' for type JsonDataset. Set to 'LakeHouseTable' for type LakeHouseTableDataset. Set to 'MagentoObject' for type MagentoObjectDataset. Set to 'MariaDBTable' for type MariaDBTableDataset. Set to 'MarketoObject' for type MarketoObjectDataset. Set to 'MicrosoftAccessTable' for type MicrosoftAccessTableDataset. Set to 'MongoDbAtlasCollection' for type MongoDbAtlasCollectionDataset. Set to 'MongoDbCollection' for type MongoDbCollectionDataset. Set to 'MongoDbV2Collection' for type MongoDbV2CollectionDataset. Set to 'MySqlTable' for type MySqlTableDataset. Set to 'NetezzaTable' for type NetezzaTableDataset. Set to 'ODataResource' for type ODataResourceDataset. Set to 'OdbcTable' for type OdbcTableDataset. Set to 'Office365Table' for type Office365Dataset. Set to 'OracleServiceCloudObject' for type OracleServiceCloudObjectDataset. Set to 'OracleTable' for type OracleTableDataset. Set to 'Orc' for type OrcDataset. Set to 'Parquet' for type ParquetDataset. Set to 'PaypalObject' for type PaypalObjectDataset. Set to 'PhoenixObject' for type PhoenixObjectDataset. Set to 'PostgreSqlTable' for type PostgreSqlTableDataset. Set to 'PostgreSqlV2Table' for type PostgreSqlV2TableDataset. Set to 'PrestoObject' for type PrestoObjectDataset. Set to 'QuickBooksObject' for type QuickBooksObjectDataset. Set to 'RelationalTable' for type RelationalTableDataset. Set to 'ResponsysObject' for type ResponsysObjectDataset. Set to 'RestResource' for type RestResourceDataset. Set to 'SalesforceMarketingCloudObject' for type SalesforceMarketingCloudObjectDataset. Set to 'SalesforceObject' for type SalesforceObjectDataset. Set to 'SalesforceServiceCloudObject' for type SalesforceServiceCloudObjectDataset. Set to 'SalesforceServiceCloudV2Object' for type SalesforceServiceCloudV2ObjectDataset. Set to 'SalesforceV2Object' for type SalesforceV2ObjectDataset. Set to 'SapBwCube' for type SapBwCubeDataset. Set to 'SapCloudForCustomerResource' for type SapCloudForCustomerResourceDataset. Set to 'SapEccResource' for type SapEccResourceDataset. Set to 'SapHanaTable' for type SapHanaTableDataset. Set to 'SapOdpResource' for type SapOdpResourceDataset. Set to 'SapOpenHubTable' for type SapOpenHubTableDataset. Set to 'SapTableResource' for type SapTableResourceDataset. Set to 'ServiceNowObject' for type ServiceNowObjectDataset. Set to 'ServiceNowV2Object' for type ServiceNowV2ObjectDataset. Set to 'SharePointOnlineListResource' for type SharePointOnlineListResourceDataset. Set to 'ShopifyObject' for type ShopifyObjectDataset. Set to 'SnowflakeTable' for type SnowflakeDataset. Set to 'SnowflakeV2Table' for type SnowflakeV2Dataset. Set to 'SparkObject' for type SparkObjectDataset. Set to 'SqlServerTable' for type SqlServerTableDataset. Set to 'SquareObject' for type SquareObjectDataset. Set to 'SybaseTable' for type SybaseTableDataset. Set to 'TeradataTable' for type TeradataTableDataset. Set to 'VerticaTable' for type VerticaTableDataset. Set to 'WarehouseTable' for type WarehouseTableDataset. Set to 'WebTable' for type WebTableDataset. Set to 'XeroObject' for type XeroObjectDataset. Set to 'Xml' for type XmlDataset. Set to 'ZohoObject' for type ZohoObjectDataset. | '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' 'Iceberg' '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) |
DatasetCompression
Name | Description | Value |
---|---|---|
level | The dataset compression level. Type: string (or Expression with resultType string). | any |
type | Type of dataset compression. Type: string (or Expression with resultType string). | any (required) |
DatasetFolder
Name | Description | Value |
---|---|---|
name | The name of the folder that this Dataset is in. | string |
DatasetLocation
Name | Description | Value |
---|---|---|
fileName | Specify the file name of dataset. Type: string (or Expression with resultType string). | any |
folderPath | Specify the folder path of dataset. Type: string (or Expression with resultType string) | any |
type | Set to 'AmazonS3CompatibleLocation' for type AmazonS3CompatibleLocation. Set to 'AmazonS3Location' for type AmazonS3Location. Set to 'AzureBlobFSLocation' for type AzureBlobFSLocation. Set to 'AzureBlobStorageLocation' for type AzureBlobStorageLocation. Set to 'AzureDataLakeStoreLocation' for type AzureDataLakeStoreLocation. Set to 'AzureFileStorageLocation' for type AzureFileStorageLocation. Set to 'FileServerLocation' for type FileServerLocation. Set to 'FtpServerLocation' for type FtpServerLocation. Set to 'GoogleCloudStorageLocation' for type GoogleCloudStorageLocation. Set to 'HdfsLocation' for type HdfsLocation. Set to 'HttpServerLocation' for type HttpServerLocation. Set to 'LakeHouseLocation' for type LakeHouseLocation. Set to 'OracleCloudStorageLocation' for type OracleCloudStorageLocation. Set to 'SftpLocation' for type SftpLocation. | 'AmazonS3CompatibleLocation' 'AmazonS3Location' 'AzureBlobFSLocation' 'AzureBlobStorageLocation' 'AzureDataLakeStoreLocation' 'AzureFileStorageLocation' 'FileServerLocation' 'FtpServerLocation' 'GoogleCloudStorageLocation' 'HdfsLocation' 'HttpServerLocation' 'LakeHouseLocation' 'OracleCloudStorageLocation' 'SftpLocation' (required) |
DatasetStorageFormat
Name | Description | Value |
---|---|---|
deserializer | Deserializer. Type: string (or Expression with resultType string). | any |
serializer | Serializer. Type: string (or Expression with resultType string). | any |
type | Set to 'AvroFormat' for type AvroFormat. Set to 'JsonFormat' for type JsonFormat. Set to 'OrcFormat' for type OrcFormat. Set to 'ParquetFormat' for type ParquetFormat. Set to 'TextFormat' for type TextFormat. | 'AvroFormat' 'JsonFormat' 'OrcFormat' 'ParquetFormat' 'TextFormat' (required) |
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). | any |
table | The Db2 table name. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
compressionCodec | The data compressionCodec. Type: string (or Expression with resultType string). | any |
compressionLevel | The data compression method used for DelimitedText. | any |
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). | any |
escapeChar | The escape character. Type: string (or Expression with resultType string). | any |
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). | any |
location | The location of the delimited text storage. | DatasetLocation (required) |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
quoteChar | The quote character. Type: string (or Expression with resultType string). | any |
rowDelimiter | The row delimiter. Type: string (or Expression with resultType string). | any |
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). | any (required) |
DrillDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Drill. Type: string (or Expression with resultType string). | any |
table | The table name of the Drill. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
DrillTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'DrillTable' (required) |
typeProperties | Properties specific to this dataset type. | DrillDatasetTypeProperties |
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). | any (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). | any |
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). | any |
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). | any |
location | The location of the excel storage. | DatasetLocation (required) |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
range | The partial data of one sheet. Type: string (or Expression with resultType string). | any |
sheetIndex | The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer) | any |
sheetName | The sheet name of excel file. Type: string (or Expression with resultType string). | any |
FileServerLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'FileServerLocation' (required) |
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). | any |
fileName | The name of the on-premises file system. Type: string (or Expression with resultType string). | any |
folderPath | The path of the on-premises file system. Type: string (or Expression with resultType string). | any |
format | The format of the files. | DatasetStorageFormat |
modifiedDatetimeEnd | The end of file's modified datetime. Type: string (or Expression with resultType string). | any |
modifiedDatetimeStart | The start of file's modified datetime. Type: string (or Expression with resultType string). | any |
FtpServerLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'FtpServerLocation' (required) |
GenericDatasetTypeProperties
Name | Description | Value |
---|---|---|
tableName | The table name. Type: string (or Expression with resultType string). | any |
GoogleAdWordsObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GoogleAdWordsObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
GoogleBigQueryDatasetTypeProperties
Name | Description | Value |
---|---|---|
dataset | The database name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
table | The table name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using database + table properties instead. | any |
GoogleBigQueryObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GoogleBigQueryObject' (required) |
typeProperties | Properties specific to this dataset type. | GoogleBigQueryDatasetTypeProperties |
GoogleBigQueryV2DatasetTypeProperties
Name | Description | Value |
---|---|---|
dataset | The database name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
table | The table name of the Google BigQuery. Type: string (or Expression with resultType string). | any |
GoogleBigQueryV2ObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GoogleBigQueryV2Object' (required) |
typeProperties | Properties specific to this dataset type. | GoogleBigQueryV2DatasetTypeProperties |
GoogleCloudStorageLocation
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'GoogleCloudStorageLocation' (required) |
version | Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string). | any |
GreenplumDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of Greenplum. Type: string (or Expression with resultType string). | any |
table | The table name of Greenplum. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
GreenplumTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'GreenplumTable' (required) |
typeProperties | Properties specific to this dataset type. | GreenplumDatasetTypeProperties |
HBaseObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'HBaseObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
HdfsLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'HdfsLocation' (required) |
HiveDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Hive. Type: string (or Expression with resultType string). | any |
table | The table name of the Hive. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
HiveObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'HiveObject' (required) |
typeProperties | Properties specific to this dataset type. | HiveDatasetTypeProperties |
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). |
any |
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). | any |
requestBody | The body for the HTTP request. Type: string (or Expression with resultType string). | any |
requestMethod | The HTTP method for the HTTP request. Type: string (or Expression with resultType string). | any |
HttpServerLocation
Name | Description | Value |
---|---|---|
relativeUrl | Specify the relativeUrl of http server. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'HttpServerLocation' (required) |
HubspotObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'HubspotObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
IcebergDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'Iceberg' (required) |
typeProperties | Iceberg dataset properties. | IcebergDatasetTypeProperties |
IcebergDatasetTypeProperties
Name | Description | Value |
---|---|---|
location | The location of the iceberg storage. Setting a file name is not allowed for iceberg format. | DatasetLocation (required) |
ImpalaDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Impala. Type: string (or Expression with resultType string). | any |
table | The table name of the Impala. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
ImpalaObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'ImpalaObject' (required) |
typeProperties | Properties specific to this dataset type. | ImpalaDatasetTypeProperties |
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). | any |
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). | any |
location | The location of the json data storage. | DatasetLocation (required) |
JsonFormat
Name | Description | Value |
---|---|---|
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). | any |
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. | any |
jsonNodeReference | The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string). | any |
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). | any |
nestingSeparator | The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string). | any |
type | Type of dataset storage format. | 'JsonFormat' (required) |
LakeHouseLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'LakeHouseLocation' (required) |
LakeHouseTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'LakeHouseTable' (required) |
typeProperties | Microsoft Fabric LakeHouse Table dataset properties. | LakeHouseTableDatasetTypeProperties |
LakeHouseTableDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string). | any |
table | The name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string). | any |
LinkedServiceReference
Name | Description | Value |
---|---|---|
parameters | Arguments for LinkedService. | ParameterValueSpecification |
referenceName | Reference LinkedService name. | string (required) |
type | Linked service reference type. | 'LinkedServiceReference' (required) |
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 |
Microsoft.DataFactory/factories/datasets
Name | Description | Value |
---|---|---|
name | The resource name | string Constraints: Min length = 1 Max length = 260 Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required) |
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) |
type | The resource type | "Microsoft.DataFactory/factories/datasets@2018-06-01" |
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). | any |
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). | any (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). | any (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). | any (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). | any |
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). | any |
table | The table name of the Netezza. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
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). | any |
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). | any |
tableName | Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string). | any (required) |
OracleCloudStorageLocation
Name | Description | Value |
---|---|---|
bucketName | Specify the bucketName of Oracle Cloud Storage. Type: string (or Expression with resultType string) | any |
type | Type of dataset storage location. | 'OracleCloudStorageLocation' (required) |
version | Specify the version of Oracle Cloud Storage. Type: string (or Expression with resultType string). | any |
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). | any |
table | The table name of the on-premises Oracle database. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
OrcFormat
Name | Description | Value |
---|---|---|
type | Type of dataset storage format. | 'OrcFormat' (required) |
ParameterDefinitionSpecification
Name | Description | Value |
---|
ParameterSpecification
Name | Description | Value |
---|---|---|
defaultValue | Default value of parameter. | any |
type | Parameter type. | 'Array' 'Bool' 'Float' 'Int' 'Object' 'SecureString' 'String' (required) |
ParameterValueSpecification
Name | Description | Value |
---|
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). | any |
location | The location of the parquet storage. | DatasetLocation (required) |
ParquetFormat
Name | Description | Value |
---|---|---|
type | Type of dataset storage format. | 'ParquetFormat' (required) |
PaypalObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'PaypalObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |
PhoenixDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Phoenix. Type: string (or Expression with resultType string). | any |
table | The table name of the Phoenix. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
PhoenixObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'PhoenixObject' (required) |
typeProperties | Properties specific to this dataset type. | PhoenixDatasetTypeProperties |
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). | any |
table | The PostgreSQL table name. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
table | The PostgreSQL table name. Type: string (or Expression with resultType string). | any |
PrestoDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Presto. Type: string (or Expression with resultType string). | any |
table | The table name of the Presto. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
PrestoObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'PrestoObject' (required) |
typeProperties | Properties specific to this dataset type. | PrestoDatasetTypeProperties |
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). | any |
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). | any |
requestBody | The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string). | any |
requestMethod | The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string). | any |
RestResourceDatasetTypePropertiesAdditionalHeaders
Name | Description | Value |
---|
RestResourceDatasetTypePropertiesPaginationRules
Name | Description | Value |
---|
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). | any |
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). | any |
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). | any |
reportId | The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string). | any |
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). | any |
reportId | The Salesforce V2 report Id. Type: string (or Expression with resultType string). | any |
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). | any (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). | any (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). | any |
table | The table name of SAP HANA. Type: string (or Expression with resultType string). | any |
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). | any (required) |
objectName | The name of the SAP ODP Object. Type: string (or Expression with resultType string). | any (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 ). | any |
excludeLastRequest | Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
openHubDestinationName | The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string). | any (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). | any (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 |
SftpLocation
Name | Description | Value |
---|---|---|
type | Type of dataset storage location. | 'SftpLocation' (required) |
SharePointOnlineListDatasetTypeProperties
Name | Description | Value |
---|---|---|
listName | The name of the SharePoint Online list. Type: string (or Expression with resultType string). | any |
SharePointOnlineListResourceDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'SharePointOnlineListResource' (required) |
typeProperties | Sharepoint online list dataset properties. | SharePointOnlineListDatasetTypeProperties |
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). | any |
table | The table name of the Snowflake database. Type: string (or Expression with resultType string). | any |
SnowflakeV2Dataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'SnowflakeV2Table' (required) |
typeProperties | Snowflake dataset properties. | SnowflakeDatasetTypeProperties (required) |
SparkDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Spark. Type: string (or Expression with resultType string). | any |
table | The table name of the Spark. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
SparkObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'SparkObject' (required) |
typeProperties | Properties specific to this dataset type. | SparkDatasetTypeProperties |
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). | any |
table | The table name of the SQL Server dataset. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
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). | any |
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). | any |
table | The table name of Teradata. Type: string (or Expression with resultType string). | any |
TextFormat
Name | Description | Value |
---|---|---|
columnDelimiter | The column delimiter. Type: string (or Expression with resultType string). | any |
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). | any |
escapeChar | The escape character. Type: string (or Expression with resultType string). | any |
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). | any |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
quoteChar | The quote character. Type: string (or Expression with resultType string). | any |
rowDelimiter | The row delimiter. Type: string (or Expression with resultType string). | any |
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). | any |
treatEmptyAsNull | Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean). | any |
type | Type of dataset storage format. | 'TextFormat' (required) |
VerticaDatasetTypeProperties
Name | Description | Value |
---|---|---|
schema | The schema name of the Vertica. Type: string (or Expression with resultType string). | any |
table | The table name of the Vertica. Type: string (or Expression with resultType string). | any |
tableName | This property will be retired. Please consider using schema + table properties instead. | any |
VerticaTableDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'VerticaTable' (required) |
typeProperties | Properties specific to this dataset type. | VerticaDatasetTypeProperties |
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). | any |
table | The table name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). | any |
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. | any (required) |
path | The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string). | any |
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). | any |
location | The location of the json data storage. | DatasetLocation (required) |
nullValue | The null value string. Type: string (or Expression with resultType string). | any |
ZohoObjectDataset
Name | Description | Value |
---|---|---|
type | Type of dataset. | 'ZohoObject' (required) |
typeProperties | Properties specific to this dataset type. | GenericDatasetTypeProperties |