Share via


Datasets - Get

Gets a dataset.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}?api-version=2018-06-01

URI Parameters

Name In Required Type Description
datasetName
path True

string

minLength: 1
maxLength: 260
pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$

The dataset name.

factoryName
path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

The factory name.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string (uuid)

The ID of the target subscription. The value must be an UUID.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Request Header

Name Required Type Description
if-none-match

string

ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Responses

Name Type Description
200 OK

DatasetResource

Azure operation completed successfully.

Other Status Codes

The client has made a conditional request and the resource has not been modified.

Other Status Codes

CloudError

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Datasets_Get

Sample request

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset?api-version=2018-06-01

Sample response

Date: Mon, 22 Apr 2019 18:33:50 GMT
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: 48983fb5-612a-44c6-8158-add7ffebb32b
x-ms-ratelimit-remaining-subscription-reads: 11993
x-ms-request-id: 48983fb5-612a-44c6-8158-add7ffebb32b
{
  "name": "exampleDataset",
  "type": "Microsoft.DataFactory/factories/datasets",
  "etag": "15004c4f-0000-0200-0000-5cbe090e0000",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset",
  "properties": {
    "type": "AzureBlob",
    "description": "Example description",
    "linkedServiceName": {
      "type": "LinkedServiceReference",
      "referenceName": "exampleLinkedService"
    },
    "parameters": {
      "MyFileName": {
        "type": "String"
      },
      "MyFolderPath": {
        "type": "String"
      }
    },
    "typeProperties": {
      "format": {
        "type": "TextFormat"
      },
      "fileName": {
        "type": "Expression",
        "value": "@dataset().MyFileName"
      },
      "folderPath": {
        "type": "Expression",
        "value": "@dataset().MyFolderPath"
      }
    }
  }
}

Definitions

Name Description
AmazonMWSObjectDataset

Amazon Marketplace Web Service dataset.

AmazonRdsForOracleTableDataset

The AmazonRdsForOracle database dataset.

AmazonRdsForSqlServerTableDataset

The Amazon RDS for SQL Server dataset.

AmazonRedshiftTableDataset

The Amazon Redshift table dataset.

AmazonS3CompatibleLocation

The location of Amazon S3 Compatible dataset.

AmazonS3Dataset

A single Amazon Simple Storage Service (S3) object or a set of S3 objects.

AmazonS3Location

The location of amazon S3 dataset.

AvroDataset

Avro dataset.

AvroFormat

The data stored in Avro format.

AzureBlobDataset

The Azure Blob storage.

AzureBlobFSDataset

The Azure Data Lake Storage Gen2 storage.

AzureBlobFSLocation

The location of azure blobFS dataset.

AzureBlobStorageLocation

The location of azure blob dataset.

AzureDatabricksDeltaLakeDataset

Azure Databricks Delta Lake dataset.

AzureDataExplorerTableDataset

The Azure Data Explorer (Kusto) dataset.

AzureDataLakeStoreDataset

Azure Data Lake Store dataset.

AzureDataLakeStoreLocation

The location of azure data lake store dataset.

AzureFileStorageLocation

The location of file server dataset.

AzureMariaDBTableDataset

Azure Database for MariaDB dataset.

AzureMySqlTableDataset

The Azure MySQL database dataset.

AzurePostgreSqlTableDataset

Azure PostgreSQL dataset.

AzureSearchIndexDataset

The Azure Search Index.

AzureSqlDWTableDataset

The Azure SQL Data Warehouse dataset.

AzureSqlMITableDataset

The Azure SQL Managed Instance dataset.

AzureSqlTableDataset

The Azure SQL Server database dataset.

AzureTableDataset

The Azure Table storage dataset.

BinaryDataset

Binary dataset.

CassandraTableDataset

The Cassandra database dataset.

CloudError

The object that defines the structure of an Azure Data Factory error response.

CommonDataServiceForAppsEntityDataset

The Common Data Service for Apps entity dataset.

ConcurObjectDataset

Concur Service dataset.

CosmosDbMongoDbApiCollectionDataset

The CosmosDB (MongoDB API) database dataset.

CosmosDbSqlApiCollectionDataset

Microsoft Azure CosmosDB (SQL API) Collection dataset.

CouchbaseTableDataset

Couchbase server dataset.

createdByType

The type of identity that created the resource.

CustomDataset

The custom dataset.

DatasetCompression

The compression method used on a dataset.

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

DatasetResource

Dataset resource type.

Db2TableDataset

The Db2 table dataset.

DelimitedTextDataset

Delimited text dataset.

DocumentDbCollectionDataset

Microsoft Azure Document Database Collection dataset.

DrillTableDataset

Drill server dataset.

DynamicsAXResourceDataset

The path of the Dynamics AX OData entity.

DynamicsCrmEntityDataset

The Dynamics CRM entity dataset.

DynamicsEntityDataset

The Dynamics entity dataset.

EloquaObjectDataset

Eloqua server dataset.

ExcelDataset

Excel dataset.

FileServerLocation

The location of file server dataset.

FileShareDataset

An on-premises file system dataset.

FtpServerLocation

The location of ftp server dataset.

GoogleAdWordsObjectDataset

Google AdWords service dataset.

GoogleBigQueryObjectDataset

Google BigQuery service dataset.

GoogleBigQueryV2ObjectDataset

Google BigQuery service dataset.

GoogleCloudStorageLocation

The location of Google Cloud Storage dataset.

GreenplumTableDataset

Greenplum Database dataset.

HBaseObjectDataset

HBase server dataset.

HdfsLocation

The location of HDFS.

HiveObjectDataset

Hive Server dataset.

HttpDataset

A file in an HTTP web server.

HttpServerLocation

The location of http server.

HubspotObjectDataset

Hubspot Service dataset.

IcebergDataset

Iceberg dataset.

ImpalaObjectDataset

Impala server dataset.

InformixTableDataset

The Informix table dataset.

JiraObjectDataset

Jira Service dataset.

JsonDataset

Json dataset.

JsonFormat

The data stored in JSON format.

LakeHouseLocation

The location of Microsoft Fabric Lakehouse Files dataset.

LakeHouseTableDataset

Microsoft Fabric Lakehouse Table.

LinkedServiceReference

Linked service reference type.

MagentoObjectDataset

Magento server dataset.

MariaDBTableDataset

MariaDB server dataset.

MarketoObjectDataset

Marketo server dataset.

MicrosoftAccessTableDataset

The Microsoft Access table dataset.

MongoDbAtlasCollectionDataset

The MongoDB Atlas database dataset.

MongoDbCollectionDataset

The MongoDB database dataset.

MongoDbV2CollectionDataset

The MongoDB database dataset.

MySqlTableDataset

The MySQL table dataset.

NetezzaTableDataset

Netezza dataset.

ODataResourceDataset

The Open Data Protocol (OData) resource dataset.

OdbcTableDataset

The ODBC table dataset.

Office365Dataset

The Office365 account.

OracleCloudStorageLocation

The location of Oracle Cloud Storage dataset.

OracleServiceCloudObjectDataset

Oracle Service Cloud dataset.

OracleTableDataset

The on-premises Oracle database dataset.

OrcDataset

ORC dataset.

OrcFormat

The data stored in Optimized Row Columnar (ORC) format.

ParameterSpecification

Definition of a single parameter for an entity.

ParameterType

Parameter type.

ParquetDataset

Parquet dataset.

ParquetFormat

The data stored in Parquet format.

PaypalObjectDataset

Paypal Service dataset.

PhoenixObjectDataset

Phoenix server dataset.

PostgreSqlTableDataset

The PostgreSQL table dataset.

PostgreSqlV2TableDataset

The PostgreSQLV2 table dataset.

PrestoObjectDataset

Presto server dataset.

QuickBooksObjectDataset

QuickBooks server dataset.

RelationalTableDataset

The relational table dataset.

ResponsysObjectDataset

Responsys dataset.

RestResourceDataset

A Rest service dataset.

SalesforceMarketingCloudObjectDataset

Salesforce Marketing Cloud dataset.

SalesforceObjectDataset

The Salesforce object dataset.

SalesforceServiceCloudObjectDataset

The Salesforce Service Cloud object dataset.

SalesforceServiceCloudV2ObjectDataset

The Salesforce Service Cloud V2 object dataset.

SalesforceV2ObjectDataset

The Salesforce V2 object dataset.

SapBwCubeDataset

The SAP BW cube dataset.

SapCloudForCustomerResourceDataset

The path of the SAP Cloud for Customer OData entity.

SapEccResourceDataset

The path of the SAP ECC OData entity.

SapHanaTableDataset

SAP HANA Table properties.

SapOdpResourceDataset

SAP ODP Resource properties.

SapOpenHubTableDataset

Sap Business Warehouse Open Hub Destination Table properties.

SapTableResourceDataset

SAP Table Resource properties.

ServiceNowObjectDataset

ServiceNow server dataset.

ServiceNowV2ObjectDataset

ServiceNowV2 server dataset.

SftpLocation

The location of SFTP dataset.

SharePointOnlineListResourceDataset

The sharepoint online list resource dataset.

ShopifyObjectDataset

Shopify Service dataset.

SnowflakeDataset

The snowflake dataset.

SnowflakeV2Dataset

The snowflake dataset.

SparkObjectDataset

Spark Server dataset.

SqlServerTableDataset

The on-premises SQL Server dataset.

SquareObjectDataset

Square Service dataset.

SybaseTableDataset

The Sybase table dataset.

systemData

Metadata pertaining to creation and last modification of the resource.

TeradataTableDataset

The Teradata database dataset.

TextFormat

The data stored in text format.

Type

Linked service reference type.

ValueType

Type of value copied from source.

VerticaTableDataset

Vertica dataset.

WarehouseTableDataset

Microsoft Fabric Warehouse dataset.

WebTableDataset

The dataset points to a HTML table in the web page.

XeroObjectDataset

Xero Service dataset.

XmlDataset

Xml dataset.

ZohoObjectDataset

Zoho server dataset.

AmazonMWSObjectDataset

Amazon Marketplace Web Service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AmazonMWSObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

AmazonRdsForOracleTableDataset

The AmazonRdsForOracle database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AmazonRdsForOracleTable

Type of dataset.

typeProperties.schema

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

typeProperties.table

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

AmazonRdsForSqlServerTableDataset

The Amazon RDS for SQL Server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AmazonRdsForSqlServerTable

Type of dataset.

typeProperties.schema

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

typeProperties.table

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

AmazonRedshiftTableDataset

The Amazon Redshift table dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AmazonRedshiftTable

Type of dataset.

typeProperties.schema

The Amazon Redshift schema name. Type: string (or Expression with resultType string).

typeProperties.table

The Amazon Redshift table name. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

AmazonS3CompatibleLocation

The location of Amazon S3 Compatible dataset.

Name Type Description
bucketName

Specify the bucketName of Amazon S3 Compatible. Type: string (or Expression with resultType string)

fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

AmazonS3CompatibleLocation

Type of dataset storage location.

version

Specify the version of Amazon S3 Compatible. Type: string (or Expression with resultType string).

AmazonS3Dataset

A single Amazon Simple Storage Service (S3) object or a set of S3 objects.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AmazonS3Object

Type of dataset.

typeProperties.bucketName

The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).

typeProperties.compression

DatasetCompression

The data compression method used for the Amazon S3 object.

typeProperties.format DatasetStorageFormat:

The format of files.

typeProperties.key

The key of the Amazon S3 object. Type: string (or Expression with resultType string).

typeProperties.modifiedDatetimeEnd

The end of S3 object's modified datetime. Type: string (or Expression with resultType string).

typeProperties.modifiedDatetimeStart

The start of S3 object's modified datetime. Type: string (or Expression with resultType string).

typeProperties.prefix

The prefix filter for the S3 object name. Type: string (or Expression with resultType string).

typeProperties.version

The version for the S3 object. Type: string (or Expression with resultType string).

AmazonS3Location

The location of amazon S3 dataset.

Name Type Description
bucketName

Specify the bucketName of amazon S3. Type: string (or Expression with resultType string)

fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

AmazonS3Location

Type of dataset storage location.

version

Specify the version of amazon S3. Type: string (or Expression with resultType string).

AvroDataset

Avro dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

Avro

Type of dataset.

typeProperties.avroCompressionCodec

The data avroCompressionCodec. Type: string (or Expression with resultType string).

typeProperties.avroCompressionLevel

integer (int32)

minimum: 1
maximum: 9
typeProperties.location DatasetLocation:

The location of the avro storage.

AvroFormat

The data stored in Avro format.

Name Type Description
deserializer

Deserializer. Type: string (or Expression with resultType string).

serializer

Serializer. Type: string (or Expression with resultType string).

type string:

AvroFormat

Type of dataset storage format.

AzureBlobDataset

The Azure Blob storage.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureBlob

Type of dataset.

typeProperties.compression

DatasetCompression

The data compression method used for the blob storage.

typeProperties.fileName

The name of the Azure Blob. Type: string (or Expression with resultType string).

typeProperties.folderPath

The path of the Azure Blob storage. Type: string (or Expression with resultType string).

typeProperties.format DatasetStorageFormat:

The format of the Azure Blob storage.

typeProperties.modifiedDatetimeEnd

The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string).

typeProperties.modifiedDatetimeStart

The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string).

typeProperties.tableRootLocation

The root of blob path. Type: string (or Expression with resultType string).

AzureBlobFSDataset

The Azure Data Lake Storage Gen2 storage.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureBlobFSFile

Type of dataset.

typeProperties.compression

DatasetCompression

The data compression method used for the blob storage.

typeProperties.fileName

The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string).

typeProperties.folderPath

The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string).

typeProperties.format DatasetStorageFormat:

The format of the Azure Data Lake Storage Gen2 storage.

AzureBlobFSLocation

The location of azure blobFS dataset.

Name Type Description
fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

fileSystem

Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

AzureBlobFSLocation

Type of dataset storage location.

AzureBlobStorageLocation

The location of azure blob dataset.

Name Type Description
container

Specify the container of azure blob. Type: string (or Expression with resultType string).

fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

AzureBlobStorageLocation

Type of dataset storage location.

AzureDatabricksDeltaLakeDataset

Azure Databricks Delta Lake dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureDatabricksDeltaLakeDataset

Type of dataset.

typeProperties.database

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

typeProperties.table

The name of delta table. Type: string (or Expression with resultType string).

AzureDataExplorerTableDataset

The Azure Data Explorer (Kusto) dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureDataExplorerTable

Type of dataset.

typeProperties.table

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

AzureDataLakeStoreDataset

Azure Data Lake Store dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureDataLakeStoreFile

Type of dataset.

typeProperties.compression

DatasetCompression

The data compression method used for the item(s) in the Azure Data Lake Store.

typeProperties.fileName

The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string).

typeProperties.folderPath

Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).

typeProperties.format DatasetStorageFormat:

The format of the Data Lake Store.

AzureDataLakeStoreLocation

The location of azure data lake store dataset.

Name Type Description
fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

AzureDataLakeStoreLocation

Type of dataset storage location.

AzureFileStorageLocation

The location of file server dataset.

Name Type Description
fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

AzureFileStorageLocation

Type of dataset storage location.

AzureMariaDBTableDataset

Azure Database for MariaDB dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureMariaDBTable

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

AzureMySqlTableDataset

The Azure MySQL database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureMySqlTable

Type of dataset.

typeProperties.table

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

typeProperties.tableName

The Azure MySQL database table name. Type: string (or Expression with resultType string).

AzurePostgreSqlTableDataset

Azure PostgreSQL dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzurePostgreSqlTable

Type of dataset.

typeProperties.schema

The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).

typeProperties.tableName

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

AzureSearchIndexDataset

The Azure Search Index.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureSearchIndex

Type of dataset.

typeProperties.indexName

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

AzureSqlDWTableDataset

The Azure SQL Data Warehouse dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureSqlDWTable

Type of dataset.

typeProperties.schema

The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

AzureSqlMITableDataset

The Azure SQL Managed Instance dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureSqlMITable

Type of dataset.

typeProperties.schema

The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

AzureSqlTableDataset

The Azure SQL Server database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureSqlTable

Type of dataset.

typeProperties.schema

The schema name of the Azure SQL database. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Azure SQL database. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

AzureTableDataset

The Azure Table storage dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

AzureTable

Type of dataset.

typeProperties.tableName

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

BinaryDataset

Binary dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

Binary

Type of dataset.

typeProperties.compression

DatasetCompression

The data compression method used for the binary dataset.

typeProperties.location DatasetLocation:

The location of the Binary storage.

CassandraTableDataset

The Cassandra database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

CassandraTable

Type of dataset.

typeProperties.keyspace

The keyspace of the Cassandra database. Type: string (or Expression with resultType string).

typeProperties.tableName

The table name of the Cassandra database. Type: string (or Expression with resultType string).

CloudError

The object that defines the structure of an Azure Data Factory error response.

Name Type Description
error.code

string

Error code.

error.details

CloudError[]

Array with additional error details.

error.message

string

Error message.

error.target

string

Property name/path in request associated with error.

CommonDataServiceForAppsEntityDataset

The Common Data Service for Apps entity dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

CommonDataServiceForAppsEntity

Type of dataset.

typeProperties.entityName

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

ConcurObjectDataset

Concur Service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

ConcurObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

CosmosDbMongoDbApiCollectionDataset

The CosmosDB (MongoDB API) database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

CosmosDbMongoDbApiCollection

Type of dataset.

typeProperties.collection

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

CosmosDbSqlApiCollectionDataset

Microsoft Azure CosmosDB (SQL API) Collection dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

CosmosDbSqlApiCollection

Type of dataset.

typeProperties.collectionName

CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string).

CouchbaseTableDataset

Couchbase server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

CouchbaseTable

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

CustomDataset

The custom dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

CustomDataset

Type of dataset.

DatasetCompression

The compression method used on a dataset.

Name Type Description
level

The dataset compression level. Type: string (or Expression with resultType string).

type

Type of dataset compression. Type: string (or Expression with resultType string).

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Name Type Description
name

string

The name of the folder that this Dataset is in.

DatasetResource

Dataset resource type.

Name Type Description
etag

string

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")

id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

The name of the resource

properties Dataset:

Dataset properties.

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Db2TableDataset

The Db2 table dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

Db2Table

Type of dataset.

typeProperties.schema

The Db2 schema name. Type: string (or Expression with resultType string).

typeProperties.table

The Db2 table name. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

DelimitedTextDataset

Delimited text dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

DelimitedText

Type of dataset.

typeProperties.columnDelimiter

The column delimiter. Type: string (or Expression with resultType string).

typeProperties.compressionCodec

The data compressionCodec. Type: string (or Expression with resultType string).

typeProperties.compressionLevel

The data compression method used for DelimitedText.

typeProperties.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).

typeProperties.escapeChar

The escape character. Type: string (or Expression with resultType string).

typeProperties.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).

typeProperties.location DatasetLocation:

The location of the delimited text storage.

typeProperties.nullValue

The null value string. Type: string (or Expression with resultType string).

typeProperties.quoteChar

The quote character. Type: string (or Expression with resultType string).

typeProperties.rowDelimiter

The row delimiter. Type: string (or Expression with resultType string).

DocumentDbCollectionDataset

Microsoft Azure Document Database Collection dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

DocumentDbCollection

Type of dataset.

typeProperties.collectionName

Document Database collection name. Type: string (or Expression with resultType string).

DrillTableDataset

Drill server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

DrillTable

Type of dataset.

typeProperties.schema

The schema name of the Drill. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Drill. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

DynamicsAXResourceDataset

The path of the Dynamics AX OData entity.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

DynamicsAXResource

Type of dataset.

typeProperties.path

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

DynamicsCrmEntityDataset

The Dynamics CRM entity dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

DynamicsCrmEntity

Type of dataset.

typeProperties.entityName

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

DynamicsEntityDataset

The Dynamics entity dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

DynamicsEntity

Type of dataset.

typeProperties.entityName

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

EloquaObjectDataset

Eloqua server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

EloquaObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

ExcelDataset

Excel dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

Excel

Type of dataset.

typeProperties.compression

DatasetCompression

The data compression method used for the json dataset.

typeProperties.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).

typeProperties.location DatasetLocation:

The location of the excel storage.

typeProperties.nullValue

The null value string. Type: string (or Expression with resultType string).

typeProperties.range

The partial data of one sheet. Type: string (or Expression with resultType string).

typeProperties.sheetIndex

The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer)

typeProperties.sheetName

The sheet name of excel file. Type: string (or Expression with resultType string).

FileServerLocation

The location of file server dataset.

Name Type Description
fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

FileServerLocation

Type of dataset storage location.

FileShareDataset

An on-premises file system dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

FileShare

Type of dataset.

typeProperties.compression

DatasetCompression

The data compression method used for the file system.

typeProperties.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).

typeProperties.fileName

The name of the on-premises file system. Type: string (or Expression with resultType string).

typeProperties.folderPath

The path of the on-premises file system. Type: string (or Expression with resultType string).

typeProperties.format DatasetStorageFormat:

The format of the files.

typeProperties.modifiedDatetimeEnd

The end of file's modified datetime. Type: string (or Expression with resultType string).

typeProperties.modifiedDatetimeStart

The start of file's modified datetime. Type: string (or Expression with resultType string).

FtpServerLocation

The location of ftp server dataset.

Name Type Description
fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

FtpServerLocation

Type of dataset storage location.

GoogleAdWordsObjectDataset

Google AdWords service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

GoogleAdWordsObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

GoogleBigQueryObjectDataset

Google BigQuery service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

GoogleBigQueryObject

Type of dataset.

typeProperties.dataset

The database name of the Google BigQuery. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Google BigQuery. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using database + table properties instead.

GoogleBigQueryV2ObjectDataset

Google BigQuery service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

GoogleBigQueryV2Object

Type of dataset.

typeProperties.dataset

The database name of the Google BigQuery. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Google BigQuery. Type: string (or Expression with resultType string).

GoogleCloudStorageLocation

The location of Google Cloud Storage dataset.

Name Type Description
bucketName

Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string)

fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

GoogleCloudStorageLocation

Type of dataset storage location.

version

Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string).

GreenplumTableDataset

Greenplum Database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

GreenplumTable

Type of dataset.

typeProperties.schema

The schema name of Greenplum. Type: string (or Expression with resultType string).

typeProperties.table

The table name of Greenplum. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

HBaseObjectDataset

HBase server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

HBaseObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

HdfsLocation

The location of HDFS.

Name Type Description
fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

HdfsLocation

Type of dataset storage location.

HiveObjectDataset

Hive Server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

HiveObject

Type of dataset.

typeProperties.schema

The schema name of the Hive. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Hive. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

HttpDataset

A file in an HTTP web server.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

HttpFile

Type of dataset.

typeProperties.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).

typeProperties.compression

DatasetCompression

The data compression method used on files.

typeProperties.format DatasetStorageFormat:

The format of files.

typeProperties.relativeUrl

The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).

typeProperties.requestBody

The body for the HTTP request. Type: string (or Expression with resultType string).

typeProperties.requestMethod

The HTTP method for the HTTP request. Type: string (or Expression with resultType string).

HttpServerLocation

The location of http server.

Name Type Description
fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

relativeUrl

Specify the relativeUrl of http server. Type: string (or Expression with resultType string)

type string:

HttpServerLocation

Type of dataset storage location.

HubspotObjectDataset

Hubspot Service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

HubspotObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

IcebergDataset

Iceberg dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

Iceberg

Type of dataset.

typeProperties.location DatasetLocation:

The location of the iceberg storage. Setting a file name is not allowed for iceberg format.

ImpalaObjectDataset

Impala server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

ImpalaObject

Type of dataset.

typeProperties.schema

The schema name of the Impala. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Impala. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

InformixTableDataset

The Informix table dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

InformixTable

Type of dataset.

typeProperties.tableName

The Informix table name. Type: string (or Expression with resultType string).

JiraObjectDataset

Jira Service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

JiraObject

Type of dataset.

typeProperties.schema

The schema name of the Jira, applies only for Jira V2 dataset. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Jira, applies only for Jira V2 dataset. Type: string (or Expression with resultType string).

typeProperties.tableName

This property is only supported in Jira V1 Dataset, please consider upgrading to V2 dataset.

JsonDataset

Json dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

Json

Type of dataset.

typeProperties.compression

DatasetCompression

The data compression method used for the json dataset.

typeProperties.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).

typeProperties.location DatasetLocation:

The location of the json data storage.

JsonFormat

The data stored in JSON format.

Name Type Description
deserializer

Deserializer. Type: string (or Expression with resultType string).

encodingName

The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).

filePattern

File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.

jsonNodeReference

The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).

jsonPathDefinition

The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object).

nestingSeparator

The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).

serializer

Serializer. Type: string (or Expression with resultType string).

type string:

JsonFormat

Type of dataset storage format.

LakeHouseLocation

The location of Microsoft Fabric Lakehouse Files dataset.

Name Type Description
fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

LakeHouseLocation

Type of dataset storage location.

LakeHouseTableDataset

Microsoft Fabric Lakehouse Table.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

LakehouseTable

Type of dataset.

typeProperties.schema

The schema name of Microsoft Fabric Lakehouse Table. Type: string (or Expression with resultType string).

typeProperties.table

The name of Microsoft Fabric Lakehouse Table. Type: string (or Expression with resultType string).

LinkedServiceReference

Linked service reference type.

Name Type Description
parameters

Arguments for LinkedService.

referenceName

string

Reference LinkedService name.

type

Type

Linked service reference type.

MagentoObjectDataset

Magento server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

MagentoObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

MariaDBTableDataset

MariaDB server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

MariaDBTable

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

MarketoObjectDataset

Marketo server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

MarketoObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

MicrosoftAccessTableDataset

The Microsoft Access table dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

MicrosoftAccessTable

Type of dataset.

typeProperties.tableName

The Microsoft Access table name. Type: string (or Expression with resultType string).

MongoDbAtlasCollectionDataset

The MongoDB Atlas database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

MongoDbAtlasCollection

Type of dataset.

typeProperties.collection

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

MongoDbCollectionDataset

The MongoDB database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

MongoDbCollection

Type of dataset.

typeProperties.collectionName

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

MongoDbV2CollectionDataset

The MongoDB database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

MongoDbV2Collection

Type of dataset.

typeProperties.collection

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

MySqlTableDataset

The MySQL table dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

MySqlTable

Type of dataset.

typeProperties.tableName

The MySQL table name. Type: string (or Expression with resultType string).

NetezzaTableDataset

Netezza dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

NetezzaTable

Type of dataset.

typeProperties.schema

The schema name of the Netezza. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Netezza. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

ODataResourceDataset

The Open Data Protocol (OData) resource dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

ODataResource

Type of dataset.

typeProperties.path

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

OdbcTableDataset

The ODBC table dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

OdbcTable

Type of dataset.

typeProperties.tableName

The ODBC table name. Type: string (or Expression with resultType string).

Office365Dataset

The Office365 account.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

Office365Table

Type of dataset.

typeProperties.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).

typeProperties.tableName

Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string).

OracleCloudStorageLocation

The location of Oracle Cloud Storage dataset.

Name Type Description
bucketName

Specify the bucketName of Oracle Cloud Storage. Type: string (or Expression with resultType string)

fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

OracleCloudStorageLocation

Type of dataset storage location.

version

Specify the version of Oracle Cloud Storage. Type: string (or Expression with resultType string).

OracleServiceCloudObjectDataset

Oracle Service Cloud dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

OracleServiceCloudObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

OracleTableDataset

The on-premises Oracle database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

OracleTable

Type of dataset.

typeProperties.schema

The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

OrcDataset

ORC dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

Orc

Type of dataset.

typeProperties.location DatasetLocation:

The location of the ORC data storage.

typeProperties.orcCompressionCodec

The data orcCompressionCodec. Type: string (or Expression with resultType string).

OrcFormat

The data stored in Optimized Row Columnar (ORC) format.

Name Type Description
deserializer

Deserializer. Type: string (or Expression with resultType string).

serializer

Serializer. Type: string (or Expression with resultType string).

type string:

OrcFormat

Type of dataset storage format.

ParameterSpecification

Definition of a single parameter for an entity.

Name Type Description
defaultValue

Default value of parameter.

type

ParameterType

Parameter type.

ParameterType

Parameter type.

Value Description
Object

Object

String

String

Int

Int

Float

Float

Bool

Bool

Array

Array

SecureString

SecureString

ParquetDataset

Parquet dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

Parquet

Type of dataset.

typeProperties.compressionCodec

The data compressionCodec. Type: string (or Expression with resultType string).

typeProperties.location DatasetLocation:

The location of the parquet storage.

ParquetFormat

The data stored in Parquet format.

Name Type Description
deserializer

Deserializer. Type: string (or Expression with resultType string).

serializer

Serializer. Type: string (or Expression with resultType string).

type string:

ParquetFormat

Type of dataset storage format.

PaypalObjectDataset

Paypal Service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

PaypalObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

PhoenixObjectDataset

Phoenix server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

PhoenixObject

Type of dataset.

typeProperties.schema

The schema name of the Phoenix. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Phoenix. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

PostgreSqlTableDataset

The PostgreSQL table dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

PostgreSqlTable

Type of dataset.

typeProperties.schema

The PostgreSQL schema name. Type: string (or Expression with resultType string).

typeProperties.table

The PostgreSQL table name. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

PostgreSqlV2TableDataset

The PostgreSQLV2 table dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

PostgreSqlV2Table

Type of dataset.

typeProperties.schema

The PostgreSQL schema name. Type: string (or Expression with resultType string).

typeProperties.table

The PostgreSQL table name. Type: string (or Expression with resultType string).

PrestoObjectDataset

Presto server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

PrestoObject

Type of dataset.

typeProperties.schema

The schema name of the Presto. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Presto. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

QuickBooksObjectDataset

QuickBooks server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

QuickBooksObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

RelationalTableDataset

The relational table dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

RelationalTable

Type of dataset.

typeProperties.tableName

The relational table name. Type: string (or Expression with resultType string).

ResponsysObjectDataset

Responsys dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

ResponsysObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

RestResourceDataset

A Rest service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

RestResource

Type of dataset.

typeProperties.additionalHeaders

The additional HTTP headers in the request to the RESTful API.

typeProperties.paginationRules

The pagination rules to compose next page requests.

typeProperties.relativeUrl

The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).

typeProperties.requestBody

The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

typeProperties.requestMethod

The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

SalesforceMarketingCloudObjectDataset

Salesforce Marketing Cloud dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SalesforceMarketingCloudObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

SalesforceObjectDataset

The Salesforce object dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SalesforceObject

Type of dataset.

typeProperties.objectApiName

The Salesforce object API name. Type: string (or Expression with resultType string).

SalesforceServiceCloudObjectDataset

The Salesforce Service Cloud object dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SalesforceServiceCloudObject

Type of dataset.

typeProperties.objectApiName

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

SalesforceServiceCloudV2ObjectDataset

The Salesforce Service Cloud V2 object dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SalesforceServiceCloudV2Object

Type of dataset.

typeProperties.objectApiName

The Salesforce Service Cloud V2 object API name. Type: string (or Expression with resultType string).

typeProperties.reportId

The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string).

SalesforceV2ObjectDataset

The Salesforce V2 object dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SalesforceV2Object

Type of dataset.

typeProperties.objectApiName

The Salesforce V2 object API name. Type: string (or Expression with resultType string).

typeProperties.reportId

The Salesforce V2 report Id. Type: string (or Expression with resultType string).

SapBwCubeDataset

The SAP BW cube dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SapBwCube

Type of dataset.

SapCloudForCustomerResourceDataset

The path of the SAP Cloud for Customer OData entity.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SapCloudForCustomerResource

Type of dataset.

typeProperties.path

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

SapEccResourceDataset

The path of the SAP ECC OData entity.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SapEccResource

Type of dataset.

typeProperties.path

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

SapHanaTableDataset

SAP HANA Table properties.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SapHanaTable

Type of dataset.

typeProperties.schema

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

typeProperties.table

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

SapOdpResourceDataset

SAP ODP Resource properties.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SapOdpResource

Type of dataset.

typeProperties.context

The context of the SAP ODP Object. Type: string (or Expression with resultType string).

typeProperties.objectName

The name of the SAP ODP Object. Type: string (or Expression with resultType string).

SapOpenHubTableDataset

Sap Business Warehouse Open Hub Destination Table properties.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SapOpenHubTable

Type of dataset.

typeProperties.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 ).

typeProperties.excludeLastRequest

Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).

typeProperties.openHubDestinationName

The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string).

SapTableResourceDataset

SAP Table Resource properties.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SapTableResource

Type of dataset.

typeProperties.tableName

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

ServiceNowObjectDataset

ServiceNow server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

ServiceNowObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

ServiceNowV2ObjectDataset

ServiceNowV2 server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

ServiceNowV2Object

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

typeProperties.valueType

ValueType

Type of value copied from source.

SftpLocation

The location of SFTP dataset.

Name Type Description
fileName

Specify the file name of dataset. Type: string (or Expression with resultType string).

folderPath

Specify the folder path of dataset. Type: string (or Expression with resultType string)

type string:

SftpLocation

Type of dataset storage location.

SharePointOnlineListResourceDataset

The sharepoint online list resource dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SharePointOnlineListResource

Type of dataset.

typeProperties.listName

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

ShopifyObjectDataset

Shopify Service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

ShopifyObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

SnowflakeDataset

The snowflake dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SnowflakeTable

Type of dataset.

typeProperties.schema

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

typeProperties.table

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

SnowflakeV2Dataset

The snowflake dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SnowflakeV2Table

Type of dataset.

typeProperties.schema

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

typeProperties.table

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

SparkObjectDataset

Spark Server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SparkObject

Type of dataset.

typeProperties.schema

The schema name of the Spark. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Spark. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

SqlServerTableDataset

The on-premises SQL Server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SqlServerTable

Type of dataset.

typeProperties.schema

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

typeProperties.table

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

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

SquareObjectDataset

Square Service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SquareObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

SybaseTableDataset

The Sybase table dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

SybaseTable

Type of dataset.

typeProperties.tableName

The Sybase table name. Type: string (or Expression with resultType string).

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

TeradataTableDataset

The Teradata database dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

TeradataTable

Type of dataset.

typeProperties.database

The database name of Teradata. Type: string (or Expression with resultType string).

typeProperties.table

The table name of Teradata. Type: string (or Expression with resultType string).

TextFormat

The data stored in text format.

Name Type Description
columnDelimiter

The column delimiter. Type: string (or Expression with resultType string).

deserializer

Deserializer. Type: string (or Expression with resultType string).

encodingName

The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

escapeChar

The escape character. Type: string (or Expression with resultType string).

firstRowAsHeader

When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

nullValue

The null value string. Type: string (or Expression with resultType string).

quoteChar

The quote character. Type: string (or Expression with resultType string).

rowDelimiter

The row delimiter. Type: string (or Expression with resultType string).

serializer

Serializer. Type: string (or Expression with resultType string).

skipLineCount

The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).

treatEmptyAsNull

Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).

type string:

TextFormat

Type of dataset storage format.

Type

Linked service reference type.

Value Description
LinkedServiceReference

LinkedServiceReference

ValueType

Type of value copied from source.

Value Description
actual

actual

display

display

VerticaTableDataset

Vertica dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

VerticaTable

Type of dataset.

typeProperties.schema

The schema name of the Vertica. Type: string (or Expression with resultType string).

typeProperties.table

The table name of the Vertica. Type: string (or Expression with resultType string).

typeProperties.tableName

This property will be retired. Please consider using schema + table properties instead.

WarehouseTableDataset

Microsoft Fabric Warehouse dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

WarehouseTable

Type of dataset.

typeProperties.schema

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

typeProperties.table

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

WebTableDataset

The dataset points to a HTML table in the web page.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

WebTable

Type of dataset.

typeProperties.index

The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0.

typeProperties.path

The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string).

XeroObjectDataset

Xero Service dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

XeroObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).

XmlDataset

Xml dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

Xml

Type of dataset.

typeProperties.compression

DatasetCompression

The data compression method used for the json dataset.

typeProperties.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).

typeProperties.location DatasetLocation:

The location of the json data storage.

typeProperties.nullValue

The null value string. Type: string (or Expression with resultType string).

ZohoObjectDataset

Zoho server dataset.

Name Type Description
annotations

Dataset.Annotations[]

List of tags that can be used for describing the Dataset.

description

string

Dataset description.

folder

DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

LinkedServiceReference

Linked service reference.

parameters

<string,  ParameterSpecification>

Parameters for dataset.

schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type string:

ZohoObject

Type of dataset.

typeProperties.tableName

The table name. Type: string (or Expression with resultType string).