Microsoft.DataFactory factories/datasets 2017-09-01-preview

• Latest
• 2018-06-01
• 2017-09-01-preview

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@2017-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    annotations: [
      any(...)
    ]
    description: 'string'
    linkedServiceName: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    parameters: {
      {customized property}: {
        defaultValue: any(...)
        type: 'string'
      }
    }
    structure: any(...)
    type: 'string'
    // For remaining properties, see Dataset objects
  }
}

DatasetStorageFormat objects

Set the type property to specify the type of object.

DatasetCompression objects

Set the type property to specify the type of object.

For BZip2, use:

{
  type: 'BZip2'
}

For Deflate, use:

{
  level: 'string'
  type: 'Deflate'
}

For GZip, use:

{
  level: 'string'
  type: 'GZip'
}

For ZipDeflate, use:

{
  level: 'string'
  type: 'ZipDeflate'
}

Dataset objects

Set the type property to specify the type of object.

For AmazonMWSObject, use:

{
  type: 'AmazonMWSObject'
}

For AmazonS3Object, use:

{
  type: 'AmazonS3Object'
  typeProperties: {
    bucketName: any(...)
    compression: {
      type: 'string'
      // For remaining properties, see DatasetCompression objects
    }
    format: {
      deserializer: any(...)
      serializer: any(...)
      type: 'string'
      // For remaining properties, see DatasetStorageFormat objects
    }
    key: any(...)
    prefix: any(...)
    version: any(...)
  }
}

For AzureBlob, use:

{
  type: 'AzureBlob'
  typeProperties: {
    compression: {
      type: 'string'
      // For remaining properties, see DatasetCompression objects
    }
    fileName: any(...)
    folderPath: any(...)
    format: {
      deserializer: any(...)
      serializer: any(...)
      type: 'string'
      // For remaining properties, see DatasetStorageFormat objects
    }
    tableRootLocation: any(...)
  }
}

For AzureDataLakeStoreFile, use:

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

For AzureMySqlTable, use:

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

For AzurePostgreSqlTable, use:

{
  type: 'AzurePostgreSqlTable'
}

For AzureSearchIndex, use:

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

For AzureSqlDWTable, use:

{
  type: 'AzureSqlDWTable'
  typeProperties: {
    tableName: any(...)
  }
}

For AzureSqlTable, use:

{
  type: 'AzureSqlTable'
  typeProperties: {
    tableName: any(...)
  }
}

For AzureTable, use:

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

For CassandraTable, use:

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

For ConcurObject, use:

{
  type: 'ConcurObject'
}

For CouchbaseTable, use:

{
  type: 'CouchbaseTable'
}

For DocumentDbCollection, use:

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

For DrillTable, use:

{
  type: 'DrillTable'
}

For DynamicsEntity, use:

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

For EloquaObject, use:

{
  type: 'EloquaObject'
}

For FileShare, use:

{
  type: 'FileShare'
  typeProperties: {
    compression: {
      type: 'string'
      // For remaining properties, see DatasetCompression objects
    }
    fileFilter: any(...)
    fileName: any(...)
    folderPath: any(...)
    format: {
      deserializer: any(...)
      serializer: any(...)
      type: 'string'
      // For remaining properties, see DatasetStorageFormat objects
    }
  }
}

For GoogleBigQueryObject, use:

{
  type: 'GoogleBigQueryObject'
}

For GreenplumTable, use:

{
  type: 'GreenplumTable'
}

For HBaseObject, use:

{
  type: 'HBaseObject'
}

For HiveObject, use:

{
  type: 'HiveObject'
}

For HttpFile, use:

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

For HubspotObject, use:

{
  type: 'HubspotObject'
}

For ImpalaObject, use:

{
  type: 'ImpalaObject'
}

For JiraObject, use:

{
  type: 'JiraObject'
}

For MagentoObject, use:

{
  type: 'MagentoObject'
}

For MariaDBTable, use:

{
  type: 'MariaDBTable'
}

For MarketoObject, use:

{
  type: 'MarketoObject'
}

For MongoDbCollection, use:

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

For NetezzaTable, use:

{
  type: 'NetezzaTable'
}

For ODataResource, use:

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

For OracleTable, use:

{
  type: 'OracleTable'
  typeProperties: {
    tableName: any(...)
  }
}

For PaypalObject, use:

{
  type: 'PaypalObject'
}

For PhoenixObject, use:

{
  type: 'PhoenixObject'
}

For PrestoObject, use:

{
  type: 'PrestoObject'
}

For QuickBooksObject, use:

{
  type: 'QuickBooksObject'
}

For RelationalTable, use:

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

For ResponsysObject, use:

{
  type: 'ResponsysObject'
}

For SalesforceMarketingCloudObject, use:

{
  type: 'SalesforceMarketingCloudObject'
}

For SalesforceObject, use:

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

For SapCloudForCustomerResource, use:

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

For SapEccResource, use:

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

For ServiceNowObject, use:

{
  type: 'ServiceNowObject'
}

For ShopifyObject, use:

{
  type: 'ShopifyObject'
}

For SparkObject, use:

{
  type: 'SparkObject'
}

For SqlServerTable, use:

{
  type: 'SqlServerTable'
  typeProperties: {
    tableName: any(...)
  }
}

For SquareObject, use:

{
  type: 'SquareObject'
}

For VerticaTable, use:

{
  type: 'VerticaTable'
}

For WebTable, use:

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

For XeroObject, use:

{
  type: 'XeroObject'
}

For ZohoObject, use:

{
  type: 'ZohoObject'
}

Property Values

AmazonMWSObjectDataset

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

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
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

AzureBlobDataset

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

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
tableRootLocation	The root of blob path. Type: string (or Expression with resultType string).	any

AzureDataLakeStoreDataset

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

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 (required)
format	The format of the Data Lake Store.	DatasetStorageFormat

AzureMySqlTableDataset

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

AzureMySqlTableDatasetTypeProperties

Name	Description	Value
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)

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 (required)

AzureSqlDWTableDatasetTypeProperties

Name	Description	Value
tableName	The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).	any (required)

AzureSqlTableDataset

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

AzureSqlTableDatasetTypeProperties

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

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)

CassandraTableDataset

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

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

ConcurObjectDataset

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

CouchbaseTableDataset

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

Dataset

Name	Description	Value
annotations	List of tags that can be used for describing the Dataset.	any[]
description	Dataset description.	string
linkedServiceName	Linked service reference.	LinkedServiceReference (required)
parameters	Parameters for dataset.	ParameterDefinitionSpecification
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 'AmazonS3Object' for type AmazonS3Dataset. Set to 'AzureBlob' for type AzureBlobDataset. Set to 'AzureDataLakeStoreFile' for type AzureDataLakeStoreDataset. 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 'AzureSqlTable' for type AzureSqlTableDataset. Set to 'AzureTable' for type AzureTableDataset. Set to 'CassandraTable' for type CassandraTableDataset. Set to 'ConcurObject' for type ConcurObjectDataset. Set to 'CouchbaseTable' for type CouchbaseTableDataset. Set to 'DocumentDbCollection' for type DocumentDbCollectionDataset. Set to 'DrillTable' for type DrillTableDataset. Set to 'DynamicsEntity' for type DynamicsEntityDataset. Set to 'EloquaObject' for type EloquaObjectDataset. Set to 'FileShare' for type FileShareDataset. Set to 'GoogleBigQueryObject' for type GoogleBigQueryObjectDataset. 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 'ImpalaObject' for type ImpalaObjectDataset. Set to 'JiraObject' for type JiraObjectDataset. Set to 'MagentoObject' for type MagentoObjectDataset. Set to 'MariaDBTable' for type MariaDBTableDataset. Set to 'MarketoObject' for type MarketoObjectDataset. Set to 'MongoDbCollection' for type MongoDbCollectionDataset. Set to 'NetezzaTable' for type NetezzaTableDataset. Set to 'ODataResource' for type ODataResourceDataset. Set to 'OracleTable' for type OracleTableDataset. Set to 'PaypalObject' for type PaypalObjectDataset. Set to 'PhoenixObject' for type PhoenixObjectDataset. 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 'SalesforceMarketingCloudObject' for type SalesforceMarketingCloudObjectDataset. Set to 'SalesforceObject' for type SalesforceObjectDataset. Set to 'SapCloudForCustomerResource' for type SapCloudForCustomerResourceDataset. Set to 'SapEccResource' for type SapEccResourceDataset. Set to 'ServiceNowObject' for type ServiceNowObjectDataset. Set to 'ShopifyObject' for type ShopifyObjectDataset. Set to 'SparkObject' for type SparkObjectDataset. Set to 'SqlServerTable' for type SqlServerTableDataset. Set to 'SquareObject' for type SquareObjectDataset. Set to 'VerticaTable' for type VerticaTableDataset. Set to 'WebTable' for type WebTableDataset. Set to 'XeroObject' for type XeroObjectDataset. Set to 'ZohoObject' for type ZohoObjectDataset.	'AmazonMWSObject' 'AmazonS3Object' 'AzureBlob' 'AzureDataLakeStoreFile' 'AzureMySqlTable' 'AzurePostgreSqlTable' 'AzureSearchIndex' 'AzureSqlDWTable' 'AzureSqlTable' 'AzureTable' 'CassandraTable' 'ConcurObject' 'CouchbaseTable' 'DocumentDbCollection' 'DrillTable' 'DynamicsEntity' 'EloquaObject' 'FileShare' 'GoogleBigQueryObject' 'GreenplumTable' 'HBaseObject' 'HiveObject' 'HttpFile' 'HubspotObject' 'ImpalaObject' 'JiraObject' 'MagentoObject' 'MariaDBTable' 'MarketoObject' 'MongoDbCollection' 'NetezzaTable' 'ODataResource' 'OracleTable' 'PaypalObject' 'PhoenixObject' 'PrestoObject' 'QuickBooksObject' 'RelationalTable' 'ResponsysObject' 'SalesforceMarketingCloudObject' 'SalesforceObject' 'SapCloudForCustomerResource' 'SapEccResource' 'ServiceNowObject' 'ShopifyObject' 'SparkObject' 'SqlServerTable' 'SquareObject' 'VerticaTable' 'WebTable' 'XeroObject' 'ZohoObject' (required)

DatasetBZip2Compression

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

DatasetCompression

Name	Description	Value
type	Set to 'BZip2' for type DatasetBZip2Compression. Set to 'Deflate' for type DatasetDeflateCompression. Set to 'GZip' for type DatasetGZipCompression. Set to 'ZipDeflate' for type DatasetZipDeflateCompression.	'BZip2' 'Deflate' 'GZip' 'ZipDeflate' (required)

DatasetDeflateCompression

Name	Description	Value
level	The Deflate compression level.	'Fastest' 'Optimal'
type	Type of dataset compression.	'Deflate' (required)

DatasetGZipCompression

Name	Description	Value
level	The GZip compression level.	'Fastest' 'Optimal'
type	Type of dataset compression.	'GZip' (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		(required)

DatasetZipDeflateCompression

Name	Description	Value
level	The ZipDeflate compression level.	'Fastest' 'Optimal'
type	Type of dataset compression.	'ZipDeflate' (required)

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)

DrillTableDataset

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

DynamicsEntityDataset

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

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)

FileShareDataset

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

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

GoogleBigQueryObjectDataset

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

GreenplumTableDataset

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

HBaseObjectDataset

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

HiveObjectDataset

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

HttpDataset

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

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

HubspotObjectDataset

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

ImpalaObjectDataset

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

JiraObjectDataset

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

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)

MariaDBTableDataset

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

MarketoObjectDataset

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

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)

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)

NetezzaTableDataset

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

ODataResourceDataset

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

ODataResourceDatasetTypeProperties

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

OracleTableDataset

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

OracleTableDatasetTypeProperties

Name	Description	Value
tableName	The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).	any (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

PaypalObjectDataset

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

PhoenixObjectDataset

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

PrestoObjectDataset

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

QuickBooksObjectDataset

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

RelationalTableDataset

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

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)

SalesforceMarketingCloudObjectDataset

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

SalesforceObjectDataset

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

SalesforceObjectDatasetTypeProperties

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

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)

ServiceNowObjectDataset

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

ShopifyObjectDataset

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

SparkObjectDataset

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

SqlServerTableDataset

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

SqlServerTableDatasetTypeProperties

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

SquareObjectDataset

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

VerticaTableDataset

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

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)

ZohoObjectDataset

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

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying 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": "2017-09-01-preview",
  "name": "string",
  "properties": {
    "annotations": [ {} ],
    "description": "string",
    "linkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "string"
    },
    "parameters": {
      "{customized property}": {
        "defaultValue": {},
        "type": "string"
      }
    },
    "structure": {},
    "type": "string"
    // For remaining properties, see Dataset objects
  }
}

DatasetStorageFormat objects

Set the type property to specify the type of object.

DatasetCompression objects

Set the type property to specify the type of object.

For BZip2, use:

{
  "type": "BZip2"
}

For Deflate, use:

{
  "level": "string",
  "type": "Deflate"
}

For GZip, use:

{
  "level": "string",
  "type": "GZip"
}

For ZipDeflate, use:

{
  "level": "string",
  "type": "ZipDeflate"
}

Dataset objects

Set the type property to specify the type of object.

For AmazonMWSObject, use:

{
  "type": "AmazonMWSObject"
}

For AmazonS3Object, use:

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

For AzureBlob, use:

{
  "type": "AzureBlob",
  "typeProperties": {
    "compression": {
      "type": "string"
      // For remaining properties, see DatasetCompression objects
    },
    "fileName": {},
    "folderPath": {},
    "format": {
      "deserializer": {},
      "serializer": {},
      "type": "string"
      // For remaining properties, see DatasetStorageFormat objects
    },
    "tableRootLocation": {}
  }
}

For AzureDataLakeStoreFile, use:

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

For AzureMySqlTable, use:

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

For AzurePostgreSqlTable, use:

{
  "type": "AzurePostgreSqlTable"
}

For AzureSearchIndex, use:

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

For AzureSqlDWTable, use:

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

For AzureSqlTable, use:

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

For AzureTable, use:

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

For CassandraTable, use:

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

For ConcurObject, use:

{
  "type": "ConcurObject"
}

For CouchbaseTable, use:

{
  "type": "CouchbaseTable"
}

For DocumentDbCollection, use:

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

For DrillTable, use:

{
  "type": "DrillTable"
}

For DynamicsEntity, use:

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

For EloquaObject, use:

{
  "type": "EloquaObject"
}

For FileShare, use:

{
  "type": "FileShare",
  "typeProperties": {
    "compression": {
      "type": "string"
      // For remaining properties, see DatasetCompression objects
    },
    "fileFilter": {},
    "fileName": {},
    "folderPath": {},
    "format": {
      "deserializer": {},
      "serializer": {},
      "type": "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }
}

For GoogleBigQueryObject, use:

{
  "type": "GoogleBigQueryObject"
}

For GreenplumTable, use:

{
  "type": "GreenplumTable"
}

For HBaseObject, use:

{
  "type": "HBaseObject"
}

For HiveObject, use:

{
  "type": "HiveObject"
}

For HttpFile, use:

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

For HubspotObject, use:

{
  "type": "HubspotObject"
}

For ImpalaObject, use:

{
  "type": "ImpalaObject"
}

For JiraObject, use:

{
  "type": "JiraObject"
}

For MagentoObject, use:

{
  "type": "MagentoObject"
}

For MariaDBTable, use:

{
  "type": "MariaDBTable"
}

For MarketoObject, use:

{
  "type": "MarketoObject"
}

For MongoDbCollection, use:

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

For NetezzaTable, use:

{
  "type": "NetezzaTable"
}

For ODataResource, use:

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

For OracleTable, use:

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

For PaypalObject, use:

{
  "type": "PaypalObject"
}

For PhoenixObject, use:

{
  "type": "PhoenixObject"
}

For PrestoObject, use:

{
  "type": "PrestoObject"
}

For QuickBooksObject, use:

{
  "type": "QuickBooksObject"
}

For RelationalTable, use:

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

For ResponsysObject, use:

{
  "type": "ResponsysObject"
}

For SalesforceMarketingCloudObject, use:

{
  "type": "SalesforceMarketingCloudObject"
}

For SalesforceObject, use:

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

For SapCloudForCustomerResource, use:

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

For SapEccResource, use:

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

For ServiceNowObject, use:

{
  "type": "ServiceNowObject"
}

For ShopifyObject, use:

{
  "type": "ShopifyObject"
}

For SparkObject, use:

{
  "type": "SparkObject"
}

For SqlServerTable, use:

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

For SquareObject, use:

{
  "type": "SquareObject"
}

For VerticaTable, use:

{
  "type": "VerticaTable"
}

For WebTable, use:

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

For XeroObject, use:

{
  "type": "XeroObject"
}

For ZohoObject, use:

{
  "type": "ZohoObject"
}

Property Values

AmazonMWSObjectDataset

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

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
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

AzureBlobDataset

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

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
tableRootLocation	The root of blob path. Type: string (or Expression with resultType string).	any

AzureDataLakeStoreDataset

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

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 (required)
format	The format of the Data Lake Store.	DatasetStorageFormat

AzureMySqlTableDataset

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

AzureMySqlTableDatasetTypeProperties

Name	Description	Value
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)

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 (required)

AzureSqlDWTableDatasetTypeProperties

Name	Description	Value
tableName	The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).	any (required)

AzureSqlTableDataset

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

AzureSqlTableDatasetTypeProperties

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

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)

CassandraTableDataset

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

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

ConcurObjectDataset

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

CouchbaseTableDataset

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

Dataset

Name	Description	Value
annotations	List of tags that can be used for describing the Dataset.	any[]
description	Dataset description.	string
linkedServiceName	Linked service reference.	LinkedServiceReference (required)
parameters	Parameters for dataset.	ParameterDefinitionSpecification
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 'AmazonS3Object' for type AmazonS3Dataset. Set to 'AzureBlob' for type AzureBlobDataset. Set to 'AzureDataLakeStoreFile' for type AzureDataLakeStoreDataset. 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 'AzureSqlTable' for type AzureSqlTableDataset. Set to 'AzureTable' for type AzureTableDataset. Set to 'CassandraTable' for type CassandraTableDataset. Set to 'ConcurObject' for type ConcurObjectDataset. Set to 'CouchbaseTable' for type CouchbaseTableDataset. Set to 'DocumentDbCollection' for type DocumentDbCollectionDataset. Set to 'DrillTable' for type DrillTableDataset. Set to 'DynamicsEntity' for type DynamicsEntityDataset. Set to 'EloquaObject' for type EloquaObjectDataset. Set to 'FileShare' for type FileShareDataset. Set to 'GoogleBigQueryObject' for type GoogleBigQueryObjectDataset. 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 'ImpalaObject' for type ImpalaObjectDataset. Set to 'JiraObject' for type JiraObjectDataset. Set to 'MagentoObject' for type MagentoObjectDataset. Set to 'MariaDBTable' for type MariaDBTableDataset. Set to 'MarketoObject' for type MarketoObjectDataset. Set to 'MongoDbCollection' for type MongoDbCollectionDataset. Set to 'NetezzaTable' for type NetezzaTableDataset. Set to 'ODataResource' for type ODataResourceDataset. Set to 'OracleTable' for type OracleTableDataset. Set to 'PaypalObject' for type PaypalObjectDataset. Set to 'PhoenixObject' for type PhoenixObjectDataset. 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 'SalesforceMarketingCloudObject' for type SalesforceMarketingCloudObjectDataset. Set to 'SalesforceObject' for type SalesforceObjectDataset. Set to 'SapCloudForCustomerResource' for type SapCloudForCustomerResourceDataset. Set to 'SapEccResource' for type SapEccResourceDataset. Set to 'ServiceNowObject' for type ServiceNowObjectDataset. Set to 'ShopifyObject' for type ShopifyObjectDataset. Set to 'SparkObject' for type SparkObjectDataset. Set to 'SqlServerTable' for type SqlServerTableDataset. Set to 'SquareObject' for type SquareObjectDataset. Set to 'VerticaTable' for type VerticaTableDataset. Set to 'WebTable' for type WebTableDataset. Set to 'XeroObject' for type XeroObjectDataset. Set to 'ZohoObject' for type ZohoObjectDataset.	'AmazonMWSObject' 'AmazonS3Object' 'AzureBlob' 'AzureDataLakeStoreFile' 'AzureMySqlTable' 'AzurePostgreSqlTable' 'AzureSearchIndex' 'AzureSqlDWTable' 'AzureSqlTable' 'AzureTable' 'CassandraTable' 'ConcurObject' 'CouchbaseTable' 'DocumentDbCollection' 'DrillTable' 'DynamicsEntity' 'EloquaObject' 'FileShare' 'GoogleBigQueryObject' 'GreenplumTable' 'HBaseObject' 'HiveObject' 'HttpFile' 'HubspotObject' 'ImpalaObject' 'JiraObject' 'MagentoObject' 'MariaDBTable' 'MarketoObject' 'MongoDbCollection' 'NetezzaTable' 'ODataResource' 'OracleTable' 'PaypalObject' 'PhoenixObject' 'PrestoObject' 'QuickBooksObject' 'RelationalTable' 'ResponsysObject' 'SalesforceMarketingCloudObject' 'SalesforceObject' 'SapCloudForCustomerResource' 'SapEccResource' 'ServiceNowObject' 'ShopifyObject' 'SparkObject' 'SqlServerTable' 'SquareObject' 'VerticaTable' 'WebTable' 'XeroObject' 'ZohoObject' (required)

DatasetBZip2Compression

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

DatasetCompression

Name	Description	Value
type	Set to 'BZip2' for type DatasetBZip2Compression. Set to 'Deflate' for type DatasetDeflateCompression. Set to 'GZip' for type DatasetGZipCompression. Set to 'ZipDeflate' for type DatasetZipDeflateCompression.	'BZip2' 'Deflate' 'GZip' 'ZipDeflate' (required)

DatasetDeflateCompression

Name	Description	Value
level	The Deflate compression level.	'Fastest' 'Optimal'
type	Type of dataset compression.	'Deflate' (required)

DatasetGZipCompression

Name	Description	Value
level	The GZip compression level.	'Fastest' 'Optimal'
type	Type of dataset compression.	'GZip' (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		(required)

DatasetZipDeflateCompression

Name	Description	Value
level	The ZipDeflate compression level.	'Fastest' 'Optimal'
type	Type of dataset compression.	'ZipDeflate' (required)

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)

DrillTableDataset

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

DynamicsEntityDataset

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

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)

FileShareDataset

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

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

GoogleBigQueryObjectDataset

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

GreenplumTableDataset

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

HBaseObjectDataset

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

HiveObjectDataset

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

HttpDataset

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

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

HubspotObjectDataset

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

ImpalaObjectDataset

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

JiraObjectDataset

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

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)

MariaDBTableDataset

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

MarketoObjectDataset

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

Microsoft.DataFactory/factories/datasets

Name	Description	Value
apiVersion	The api version	'2017-09-01-preview'
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'

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)

NetezzaTableDataset

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

ODataResourceDataset

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

ODataResourceDatasetTypeProperties

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

OracleTableDataset

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

OracleTableDatasetTypeProperties

Name	Description	Value
tableName	The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).	any (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

PaypalObjectDataset

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

PhoenixObjectDataset

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

PrestoObjectDataset

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

QuickBooksObjectDataset

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

RelationalTableDataset

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

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)

SalesforceMarketingCloudObjectDataset

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

SalesforceObjectDataset

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

SalesforceObjectDatasetTypeProperties

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

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)

ServiceNowObjectDataset

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

ShopifyObjectDataset

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

SparkObjectDataset

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

SqlServerTableDataset

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

SqlServerTableDatasetTypeProperties

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

SquareObjectDataset

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

VerticaTableDataset

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

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)

ZohoObjectDataset

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

Usage Examples

Azure Quickstart Templates

The following Azure 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@2017-09-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      annotations = [
        ?
      ]
      description = "string"
      linkedServiceName = {
        parameters = {
          {customized property} = ?
        }
        referenceName = "string"
        type = "string"
      }
      parameters = {
        {customized property} = {
          defaultValue = ?
          type = "string"
        }
      }
      structure = ?
      type = "string"
      // For remaining properties, see Dataset objects
    }
  })
}

DatasetStorageFormat objects

Set the type property to specify the type of object.

DatasetCompression objects

Set the type property to specify the type of object.

For BZip2, use:

{
  type = "BZip2"
}

For Deflate, use:

{
  level = "string"
  type = "Deflate"
}

For GZip, use:

{
  level = "string"
  type = "GZip"
}

For ZipDeflate, use:

{
  level = "string"
  type = "ZipDeflate"
}

Dataset objects

Set the type property to specify the type of object.

For AmazonMWSObject, use:

{
  type = "AmazonMWSObject"
}

For AmazonS3Object, use:

{
  type = "AmazonS3Object"
  typeProperties = {
    bucketName = ?
    compression = {
      type = "string"
      // For remaining properties, see DatasetCompression objects
    }
    format = {
      deserializer = ?
      serializer = ?
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
    key = ?
    prefix = ?
    version = ?
  }
}

For AzureBlob, use:

{
  type = "AzureBlob"
  typeProperties = {
    compression = {
      type = "string"
      // For remaining properties, see DatasetCompression objects
    }
    fileName = ?
    folderPath = ?
    format = {
      deserializer = ?
      serializer = ?
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
    tableRootLocation = ?
  }
}

For AzureDataLakeStoreFile, use:

{
  type = "AzureDataLakeStoreFile"
  typeProperties = {
    compression = {
      type = "string"
      // For remaining properties, see DatasetCompression objects
    }
    fileName = ?
    folderPath = ?
    format = {
      deserializer = ?
      serializer = ?
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }
}

For AzureMySqlTable, use:

{
  type = "AzureMySqlTable"
  typeProperties = {
    tableName = ?
  }
}

For AzurePostgreSqlTable, use:

{
  type = "AzurePostgreSqlTable"
}

For AzureSearchIndex, use:

{
  type = "AzureSearchIndex"
  typeProperties = {
    indexName = ?
  }
}

For AzureSqlDWTable, use:

{
  type = "AzureSqlDWTable"
  typeProperties = {
    tableName = ?
  }
}

For AzureSqlTable, use:

{
  type = "AzureSqlTable"
  typeProperties = {
    tableName = ?
  }
}

For AzureTable, use:

{
  type = "AzureTable"
  typeProperties = {
    tableName = ?
  }
}

For CassandraTable, use:

{
  type = "CassandraTable"
  typeProperties = {
    keyspace = ?
    tableName = ?
  }
}

For ConcurObject, use:

{
  type = "ConcurObject"
}

For CouchbaseTable, use:

{
  type = "CouchbaseTable"
}

For DocumentDbCollection, use:

{
  type = "DocumentDbCollection"
  typeProperties = {
    collectionName = ?
  }
}

For DrillTable, use:

{
  type = "DrillTable"
}

For DynamicsEntity, use:

{
  type = "DynamicsEntity"
  typeProperties = {
    entityName = ?
  }
}

For EloquaObject, use:

{
  type = "EloquaObject"
}

For FileShare, use:

{
  type = "FileShare"
  typeProperties = {
    compression = {
      type = "string"
      // For remaining properties, see DatasetCompression objects
    }
    fileFilter = ?
    fileName = ?
    folderPath = ?
    format = {
      deserializer = ?
      serializer = ?
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
  }
}

For GoogleBigQueryObject, use:

{
  type = "GoogleBigQueryObject"
}

For GreenplumTable, use:

{
  type = "GreenplumTable"
}

For HBaseObject, use:

{
  type = "HBaseObject"
}

For HiveObject, use:

{
  type = "HiveObject"
}

For HttpFile, use:

{
  type = "HttpFile"
  typeProperties = {
    additionalHeaders = ?
    compression = {
      type = "string"
      // For remaining properties, see DatasetCompression objects
    }
    format = {
      deserializer = ?
      serializer = ?
      type = "string"
      // For remaining properties, see DatasetStorageFormat objects
    }
    relativeUrl = ?
    requestBody = ?
    requestMethod = ?
  }
}

For HubspotObject, use:

{
  type = "HubspotObject"
}

For ImpalaObject, use:

{
  type = "ImpalaObject"
}

For JiraObject, use:

{
  type = "JiraObject"
}

For MagentoObject, use:

{
  type = "MagentoObject"
}

For MariaDBTable, use:

{
  type = "MariaDBTable"
}

For MarketoObject, use:

{
  type = "MarketoObject"
}

For MongoDbCollection, use:

{
  type = "MongoDbCollection"
  typeProperties = {
    collectionName = ?
  }
}

For NetezzaTable, use:

{
  type = "NetezzaTable"
}

For ODataResource, use:

{
  type = "ODataResource"
  typeProperties = {
    path = ?
  }
}

For OracleTable, use:

{
  type = "OracleTable"
  typeProperties = {
    tableName = ?
  }
}

For PaypalObject, use:

{
  type = "PaypalObject"
}

For PhoenixObject, use:

{
  type = "PhoenixObject"
}

For PrestoObject, use:

{
  type = "PrestoObject"
}

For QuickBooksObject, use:

{
  type = "QuickBooksObject"
}

For RelationalTable, use:

{
  type = "RelationalTable"
  typeProperties = {
    tableName = ?
  }
}

For ResponsysObject, use:

{
  type = "ResponsysObject"
}

For SalesforceMarketingCloudObject, use:

{
  type = "SalesforceMarketingCloudObject"
}

For SalesforceObject, use:

{
  type = "SalesforceObject"
  typeProperties = {
    objectApiName = ?
  }
}

For SapCloudForCustomerResource, use:

{
  type = "SapCloudForCustomerResource"
  typeProperties = {
    path = ?
  }
}

For SapEccResource, use:

{
  type = "SapEccResource"
  typeProperties = {
    path = ?
  }
}

For ServiceNowObject, use:

{
  type = "ServiceNowObject"
}

For ShopifyObject, use:

{
  type = "ShopifyObject"
}

For SparkObject, use:

{
  type = "SparkObject"
}

For SqlServerTable, use:

{
  type = "SqlServerTable"
  typeProperties = {
    tableName = ?
  }
}

For SquareObject, use:

{
  type = "SquareObject"
}

For VerticaTable, use:

{
  type = "VerticaTable"
}

For WebTable, use:

{
  type = "WebTable"
  typeProperties = {
    index = ?
    path = ?
  }
}

For XeroObject, use:

{
  type = "XeroObject"
}

For ZohoObject, use:

{
  type = "ZohoObject"
}

Property Values

AmazonMWSObjectDataset

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

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
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

AzureBlobDataset

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

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
tableRootLocation	The root of blob path. Type: string (or Expression with resultType string).	any

AzureDataLakeStoreDataset

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

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 (required)
format	The format of the Data Lake Store.	DatasetStorageFormat

AzureMySqlTableDataset

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

AzureMySqlTableDatasetTypeProperties

Name	Description	Value
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)

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 (required)

AzureSqlDWTableDatasetTypeProperties

Name	Description	Value
tableName	The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).	any (required)

AzureSqlTableDataset

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

AzureSqlTableDatasetTypeProperties

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

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)

CassandraTableDataset

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

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

ConcurObjectDataset

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

CouchbaseTableDataset

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

Dataset

Name	Description	Value
annotations	List of tags that can be used for describing the Dataset.	any[]
description	Dataset description.	string
linkedServiceName	Linked service reference.	LinkedServiceReference (required)
parameters	Parameters for dataset.	ParameterDefinitionSpecification
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 'AmazonS3Object' for type AmazonS3Dataset. Set to 'AzureBlob' for type AzureBlobDataset. Set to 'AzureDataLakeStoreFile' for type AzureDataLakeStoreDataset. 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 'AzureSqlTable' for type AzureSqlTableDataset. Set to 'AzureTable' for type AzureTableDataset. Set to 'CassandraTable' for type CassandraTableDataset. Set to 'ConcurObject' for type ConcurObjectDataset. Set to 'CouchbaseTable' for type CouchbaseTableDataset. Set to 'DocumentDbCollection' for type DocumentDbCollectionDataset. Set to 'DrillTable' for type DrillTableDataset. Set to 'DynamicsEntity' for type DynamicsEntityDataset. Set to 'EloquaObject' for type EloquaObjectDataset. Set to 'FileShare' for type FileShareDataset. Set to 'GoogleBigQueryObject' for type GoogleBigQueryObjectDataset. 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 'ImpalaObject' for type ImpalaObjectDataset. Set to 'JiraObject' for type JiraObjectDataset. Set to 'MagentoObject' for type MagentoObjectDataset. Set to 'MariaDBTable' for type MariaDBTableDataset. Set to 'MarketoObject' for type MarketoObjectDataset. Set to 'MongoDbCollection' for type MongoDbCollectionDataset. Set to 'NetezzaTable' for type NetezzaTableDataset. Set to 'ODataResource' for type ODataResourceDataset. Set to 'OracleTable' for type OracleTableDataset. Set to 'PaypalObject' for type PaypalObjectDataset. Set to 'PhoenixObject' for type PhoenixObjectDataset. 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 'SalesforceMarketingCloudObject' for type SalesforceMarketingCloudObjectDataset. Set to 'SalesforceObject' for type SalesforceObjectDataset. Set to 'SapCloudForCustomerResource' for type SapCloudForCustomerResourceDataset. Set to 'SapEccResource' for type SapEccResourceDataset. Set to 'ServiceNowObject' for type ServiceNowObjectDataset. Set to 'ShopifyObject' for type ShopifyObjectDataset. Set to 'SparkObject' for type SparkObjectDataset. Set to 'SqlServerTable' for type SqlServerTableDataset. Set to 'SquareObject' for type SquareObjectDataset. Set to 'VerticaTable' for type VerticaTableDataset. Set to 'WebTable' for type WebTableDataset. Set to 'XeroObject' for type XeroObjectDataset. Set to 'ZohoObject' for type ZohoObjectDataset.	'AmazonMWSObject' 'AmazonS3Object' 'AzureBlob' 'AzureDataLakeStoreFile' 'AzureMySqlTable' 'AzurePostgreSqlTable' 'AzureSearchIndex' 'AzureSqlDWTable' 'AzureSqlTable' 'AzureTable' 'CassandraTable' 'ConcurObject' 'CouchbaseTable' 'DocumentDbCollection' 'DrillTable' 'DynamicsEntity' 'EloquaObject' 'FileShare' 'GoogleBigQueryObject' 'GreenplumTable' 'HBaseObject' 'HiveObject' 'HttpFile' 'HubspotObject' 'ImpalaObject' 'JiraObject' 'MagentoObject' 'MariaDBTable' 'MarketoObject' 'MongoDbCollection' 'NetezzaTable' 'ODataResource' 'OracleTable' 'PaypalObject' 'PhoenixObject' 'PrestoObject' 'QuickBooksObject' 'RelationalTable' 'ResponsysObject' 'SalesforceMarketingCloudObject' 'SalesforceObject' 'SapCloudForCustomerResource' 'SapEccResource' 'ServiceNowObject' 'ShopifyObject' 'SparkObject' 'SqlServerTable' 'SquareObject' 'VerticaTable' 'WebTable' 'XeroObject' 'ZohoObject' (required)

DatasetBZip2Compression

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

DatasetCompression

Name	Description	Value
type	Set to 'BZip2' for type DatasetBZip2Compression. Set to 'Deflate' for type DatasetDeflateCompression. Set to 'GZip' for type DatasetGZipCompression. Set to 'ZipDeflate' for type DatasetZipDeflateCompression.	'BZip2' 'Deflate' 'GZip' 'ZipDeflate' (required)

DatasetDeflateCompression

Name	Description	Value
level	The Deflate compression level.	'Fastest' 'Optimal'
type	Type of dataset compression.	'Deflate' (required)

DatasetGZipCompression

Name	Description	Value
level	The GZip compression level.	'Fastest' 'Optimal'
type	Type of dataset compression.	'GZip' (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		(required)

DatasetZipDeflateCompression

Name	Description	Value
level	The ZipDeflate compression level.	'Fastest' 'Optimal'
type	Type of dataset compression.	'ZipDeflate' (required)

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)

DrillTableDataset

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

DynamicsEntityDataset

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

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)

FileShareDataset

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

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

GoogleBigQueryObjectDataset

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

GreenplumTableDataset

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

HBaseObjectDataset

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

HiveObjectDataset

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

HttpDataset

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

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

HubspotObjectDataset

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

ImpalaObjectDataset

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

JiraObjectDataset

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

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)

MariaDBTableDataset

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

MarketoObjectDataset

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

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@2017-09-01-preview"

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)

NetezzaTableDataset

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

ODataResourceDataset

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

ODataResourceDatasetTypeProperties

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

OracleTableDataset

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

OracleTableDatasetTypeProperties

Name	Description	Value
tableName	The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).	any (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

PaypalObjectDataset

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

PhoenixObjectDataset

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

PrestoObjectDataset

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

QuickBooksObjectDataset

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

RelationalTableDataset

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

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)

SalesforceMarketingCloudObjectDataset

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

SalesforceObjectDataset

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

SalesforceObjectDatasetTypeProperties

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

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)

ServiceNowObjectDataset

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

ShopifyObjectDataset

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

SparkObjectDataset

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

SqlServerTableDataset

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

SqlServerTableDatasetTypeProperties

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

SquareObjectDataset

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

VerticaTableDataset

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

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)

ZohoObjectDataset

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