Datasets - Create Or Update
Creates or updates a dataset.
PUT 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 |
---|---|---|---|---|
dataset
|
path | True |
string |
The dataset name. Regex pattern: |
factory
|
path | True |
string |
The factory name. Regex pattern: |
resource
|
path | True |
string |
The resource group name. Regex pattern: |
subscription
|
path | True |
string |
The subscription identifier. |
api-version
|
query | True |
string |
The API version. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
If-Match |
string |
ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. |
Request Body
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
An error response received from the Azure Data Factory service. |
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_Create |
Datasets_Update |
Datasets_Create
Sample request
PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset?api-version=2018-06-01
{
"properties": {
"type": "AzureBlob",
"typeProperties": {
"folderPath": {
"value": "@dataset().MyFolderPath",
"type": "Expression"
},
"fileName": {
"value": "@dataset().MyFileName",
"type": "Expression"
},
"format": {
"type": "TextFormat"
}
},
"linkedServiceName": {
"referenceName": "exampleLinkedService",
"type": "LinkedServiceReference"
},
"parameters": {
"MyFolderPath": {
"type": "String"
},
"MyFileName": {
"type": "String"
}
}
}
}
Sample response
Date: Sat, 16 Jun 2018 00:37:38 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1194
x-ms-request-id: ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0
x-ms-correlation-request-id: ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0
{
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset",
"name": "exampleDataset",
"type": "Microsoft.DataFactory/factories/datasets",
"properties": {
"type": "AzureBlob",
"schema": [
{
"name": "col1",
"type": "INT_32"
},
{
"name": "col2",
"type": "Decimal",
"precision": "38",
"scale": "2"
}
],
"typeProperties": {
"folderPath": {
"value": "@dataset().MyFolderPath",
"type": "Expression"
},
"fileName": {
"value": "@dataset().MyFileName",
"type": "Expression"
},
"format": {
"type": "TextFormat"
}
},
"linkedServiceName": {
"referenceName": "exampleLinkedService",
"type": "LinkedServiceReference"
},
"parameters": {
"MyFolderPath": {
"type": "String"
},
"MyFileName": {
"type": "String"
}
}
},
"etag": "0a0066d4-0000-0000-0000-5b245bd20000"
}
Datasets_Update
Sample request
PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset?api-version=2018-06-01
{
"properties": {
"type": "AzureBlob",
"typeProperties": {
"folderPath": {
"value": "@dataset().MyFolderPath",
"type": "Expression"
},
"fileName": {
"value": "@dataset().MyFileName",
"type": "Expression"
},
"format": {
"type": "TextFormat"
}
},
"description": "Example description",
"linkedServiceName": {
"referenceName": "exampleLinkedService",
"type": "LinkedServiceReference"
},
"parameters": {
"MyFolderPath": {
"type": "String"
},
"MyFileName": {
"type": "String"
}
}
}
}
Sample response
Date: Sat, 16 Jun 2018 00:37:39 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1193
x-ms-request-id: e2e7f6be-e7ee-4aae-943f-6ff799e034f2
x-ms-correlation-request-id: e2e7f6be-e7ee-4aae-943f-6ff799e034f2
{
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset",
"name": "exampleDataset",
"type": "Microsoft.DataFactory/factories/datasets",
"properties": {
"type": "AzureBlob",
"typeProperties": {
"folderPath": {
"value": "@dataset().MyFolderPath",
"type": "Expression"
},
"fileName": {
"value": "@dataset().MyFileName",
"type": "Expression"
},
"format": {
"type": "TextFormat"
}
},
"description": "Example description",
"linkedServiceName": {
"referenceName": "exampleLinkedService",
"type": "LinkedServiceReference"
},
"parameters": {
"MyFolderPath": {
"type": "String"
},
"MyFileName": {
"type": "String"
}
}
},
"etag": "0a0068d4-0000-0000-0000-5b245bd30000"
}
Definitions
Name | Description |
---|---|
Amazon |
Amazon Marketplace Web Service dataset. |
Amazon |
The AmazonRdsForOracle database dataset. |
Amazon |
The Amazon RDS for SQL Server dataset. |
Amazon |
The Amazon Redshift table dataset. |
AmazonS3Dataset |
A single Amazon Simple Storage Service (S3) object or a set of S3 objects. |
Avro |
Avro dataset. |
Azure |
The Azure Blob storage. |
Azure |
The Azure Data Lake Storage Gen2 storage. |
Azure |
Azure Databricks Delta Lake dataset. |
Azure |
The Azure Data Explorer (Kusto) dataset. |
Azure |
Azure Data Lake Store dataset. |
Azure |
Azure Database for MariaDB dataset. |
Azure |
The Azure MySQL database dataset. |
Azure |
Azure PostgreSQL dataset. |
Azure |
The Azure Search Index. |
Azure |
The Azure SQL Data Warehouse dataset. |
Azure |
The Azure SQL Managed Instance dataset. |
Azure |
The Azure SQL Server database dataset. |
Azure |
The Azure Table storage dataset. |
Binary |
Binary dataset. |
Cassandra |
The Cassandra database dataset. |
Cloud |
The object that defines the structure of an Azure Data Factory error response. |
Common |
The Common Data Service for Apps entity dataset. |
Concur |
Concur Service dataset. |
Cosmos |
The CosmosDB (MongoDB API) database dataset. |
Cosmos |
Microsoft Azure CosmosDB (SQL API) Collection dataset. |
Couchbase |
Couchbase server dataset. |
Dataset |
The compression method used on a dataset. |
Dataset |
Dataset resource type. |
Db2Table |
The Db2 table dataset. |
Delimited |
Delimited text dataset. |
Document |
Microsoft Azure Document Database Collection dataset. |
Drill |
Drill server dataset. |
Dynamics |
The path of the Dynamics AX OData entity. |
Dynamics |
The Dynamics CRM entity dataset. |
Dynamics |
The Dynamics entity dataset. |
Eloqua |
Eloqua server dataset. |
Excel |
Excel dataset. |
File |
An on-premises file system dataset. |
Folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
Google |
Google AdWords service dataset. |
Google |
Google BigQuery service dataset. |
Google |
Google BigQuery service dataset. |
Greenplum |
Greenplum Database dataset. |
HBase |
HBase server dataset. |
Hive |
Hive Server dataset. |
Http |
A file in an HTTP web server. |
Hubspot |
Hubspot Service dataset. |
Iceberg |
Iceberg dataset. |
Impala |
Impala server dataset. |
Informix |
The Informix table dataset. |
Jira |
Jira Service dataset. |
Json |
Json dataset. |
Lake |
Microsoft Fabric LakeHouse Table. |
Linked |
Linked service reference type. |
Magento |
Magento server dataset. |
Maria |
MariaDB server dataset. |
Marketo |
Marketo server dataset. |
Microsoft |
The Microsoft Access table dataset. |
Mongo |
The MongoDB Atlas database dataset. |
Mongo |
The MongoDB database dataset. |
Mongo |
The MongoDB database dataset. |
My |
The MySQL table dataset. |
Netezza |
Netezza dataset. |
OData |
The Open Data Protocol (OData) resource dataset. |
Odbc |
The ODBC table dataset. |
Office365Dataset |
The Office365 account. |
Oracle |
Oracle Service Cloud dataset. |
Oracle |
The on-premises Oracle database dataset. |
Orc |
ORC dataset. |
Parameter |
Definition of a single parameter for an entity. |
Parameter |
Parameter type. |
Parquet |
Parquet dataset. |
Paypal |
Paypal Service dataset. |
Phoenix |
Phoenix server dataset. |
Postgre |
The PostgreSQL table dataset. |
Postgre |
The PostgreSQLV2 table dataset. |
Presto |
Presto server dataset. |
Quick |
QuickBooks server dataset. |
Relational |
The relational table dataset. |
Responsys |
Responsys dataset. |
Rest |
A Rest service dataset. |
Salesforce |
Salesforce Marketing Cloud dataset. |
Salesforce |
The Salesforce object dataset. |
Salesforce |
The Salesforce Service Cloud object dataset. |
Salesforce |
The Salesforce Service Cloud V2 object dataset. |
SalesforceV2Object |
The Salesforce V2 object dataset. |
Sap |
The SAP BW cube dataset. |
Sap |
The path of the SAP Cloud for Customer OData entity. |
Sap |
The path of the SAP ECC OData entity. |
Sap |
SAP HANA Table properties. |
Sap |
SAP ODP Resource properties. |
Sap |
Sap Business Warehouse Open Hub Destination Table properties. |
Sap |
SAP Table Resource properties. |
Service |
ServiceNow server dataset. |
Service |
ServiceNowV2 server dataset. |
Share |
The sharepoint online list resource dataset. |
Shopify |
Shopify Service dataset. |
Snowflake |
The snowflake dataset. |
SnowflakeV2Dataset |
The snowflake dataset. |
Spark |
Spark Server dataset. |
Sql |
The on-premises SQL Server dataset. |
Square |
Square Service dataset. |
Sybase |
The Sybase table dataset. |
Teradata |
The Teradata database dataset. |
Type |
Linked service reference type. |
Vertica |
Vertica dataset. |
Warehouse |
Microsoft Fabric Warehouse dataset. |
Web |
The dataset points to a HTML table in the web page. |
Xero |
Xero Service dataset. |
Xml |
Xml dataset. |
Zoho |
Zoho server dataset. |
AmazonMWSObjectDataset
Amazon Marketplace Web Service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Amazon |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
AmazonRdsForOracleTableDataset
The AmazonRdsForOracle database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Amazon |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Amazon |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the SQL Server dataset. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Amazon |
Type of dataset. |
typeProperties.schema |
object |
The Amazon Redshift schema name. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The Amazon Redshift table name. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
AmazonS3Dataset
A single Amazon Simple Storage Service (S3) object or a set of S3 objects.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
object |
The name of the Amazon S3 bucket. Type: string (or Expression with resultType string). |
typeProperties.compression |
The data compression method used for the Amazon S3 object. |
|
typeProperties.format |
Dataset |
The format of files. |
typeProperties.key |
object |
The key of the Amazon S3 object. Type: string (or Expression with resultType string). |
typeProperties.modifiedDatetimeEnd |
object |
The end of S3 object's modified datetime. Type: string (or Expression with resultType string). |
typeProperties.modifiedDatetimeStart |
object |
The start of S3 object's modified datetime. Type: string (or Expression with resultType string). |
typeProperties.prefix |
object |
The prefix filter for the S3 object name. Type: string (or Expression with resultType string). |
typeProperties.version |
object |
The version for the S3 object. Type: string (or Expression with resultType string). |
AvroDataset
Avro dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
object |
The data avroCompressionCodec. Type: string (or Expression with resultType string). |
typeProperties.avroCompressionLevel |
integer |
|
typeProperties.location |
Dataset |
The location of the avro storage. |
AzureBlobDataset
The Azure Blob storage.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.compression |
The data compression method used for the blob storage. |
|
typeProperties.fileName |
object |
The name of the Azure Blob. Type: string (or Expression with resultType string). |
typeProperties.folderPath |
object |
The path of the Azure Blob storage. Type: string (or Expression with resultType string). |
typeProperties.format |
Dataset |
The format of the Azure Blob storage. |
typeProperties.modifiedDatetimeEnd |
object |
The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string). |
typeProperties.modifiedDatetimeStart |
object |
The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string). |
typeProperties.tableRootLocation |
object |
The root of blob path. Type: string (or Expression with resultType string). |
AzureBlobFSDataset
The Azure Data Lake Storage Gen2 storage.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.compression |
The data compression method used for the blob storage. |
|
typeProperties.fileName |
object |
The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string). |
typeProperties.folderPath |
object |
The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string). |
typeProperties.format |
Dataset |
The format of the Azure Data Lake Storage Gen2 storage. |
AzureDatabricksDeltaLakeDataset
Azure Databricks Delta Lake dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type | string: |
Type of dataset. |
typeProperties.database |
object |
The database name of delta table. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The name of delta table. Type: string (or Expression with resultType string). |
AzureDataExplorerTableDataset
The Azure Data Explorer (Kusto) dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.table |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.compression |
The data compression method used for the item(s) in the Azure Data Lake Store. |
|
typeProperties.fileName |
object |
The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string). |
typeProperties.folderPath |
object |
Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string). |
typeProperties.format |
Dataset |
The format of the Data Lake Store. |
AzureMariaDBTableDataset
Azure Database for MariaDB dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
AzureMySqlTableDataset
The Azure MySQL database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.table |
object |
The name of Azure MySQL database table. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
The Azure MySQL database table name. Type: string (or Expression with resultType string). |
AzurePostgreSqlTableDataset
Azure PostgreSQL dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.indexName |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
AzureSqlMITableDataset
The Azure SQL Managed Instance dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
AzureSqlTableDataset
The Azure SQL Server database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Azure SQL database. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Azure SQL database. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
AzureTableDataset
The Azure Table storage dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Azure |
Type of dataset. |
typeProperties.tableName |
object |
The table name of the Azure Table storage. Type: string (or Expression with resultType string). |
BinaryDataset
Binary dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
The data compression method used for the binary dataset. |
|
typeProperties.location |
Dataset |
The location of the Binary storage. |
CassandraTableDataset
The Cassandra database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Cassandra |
Type of dataset. |
typeProperties.keyspace |
object |
The keyspace of the Cassandra database. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
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 |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Common |
Type of dataset. |
typeProperties.entityName |
object |
The logical name of the entity. Type: string (or Expression with resultType string). |
ConcurObjectDataset
Concur Service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Concur |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
CosmosDbMongoDbApiCollectionDataset
The CosmosDB (MongoDB API) database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Cosmos |
Type of dataset. |
typeProperties.collection |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Cosmos |
Type of dataset. |
typeProperties.collectionName |
object |
CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string). |
CouchbaseTableDataset
Couchbase server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Couchbase |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
DatasetCompression
The compression method used on a dataset.
Name | Type | Description |
---|---|---|
level |
object |
The dataset compression level. Type: string (or Expression with resultType string). |
type |
object |
Type of dataset compression. Type: string (or Expression with resultType string). |
DatasetResource
Dataset resource type.
Db2TableDataset
The Db2 table dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
object |
The Db2 schema name. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The Db2 table name. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
DelimitedTextDataset
Delimited text dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Delimited |
Type of dataset. |
typeProperties.columnDelimiter |
object |
The column delimiter. Type: string (or Expression with resultType string). |
typeProperties.compressionCodec |
object |
The data compressionCodec. Type: string (or Expression with resultType string). |
typeProperties.compressionLevel |
object |
The data compression method used for DelimitedText. |
typeProperties.encodingName |
object |
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 |
object |
The escape character. Type: string (or Expression with resultType string). |
typeProperties.firstRowAsHeader |
object |
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 |
Dataset |
The location of the delimited text storage. |
typeProperties.nullValue |
object |
The null value string. Type: string (or Expression with resultType string). |
typeProperties.quoteChar |
object |
The quote character. Type: string (or Expression with resultType string). |
typeProperties.rowDelimiter |
object |
The row delimiter. Type: string (or Expression with resultType string). |
DocumentDbCollectionDataset
Microsoft Azure Document Database Collection dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Document |
Type of dataset. |
typeProperties.collectionName |
object |
Document Database collection name. Type: string (or Expression with resultType string). |
DrillTableDataset
Drill server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Drill |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Drill. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Drill. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Dynamics |
Type of dataset. |
typeProperties.path |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Dynamics |
Type of dataset. |
typeProperties.entityName |
object |
The logical name of the entity. Type: string (or Expression with resultType string). |
DynamicsEntityDataset
The Dynamics entity dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Dynamics |
Type of dataset. |
typeProperties.entityName |
object |
The logical name of the entity. Type: string (or Expression with resultType string). |
EloquaObjectDataset
Eloqua server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Eloqua |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
ExcelDataset
Excel dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
The data compression method used for the json dataset. |
|
typeProperties.firstRowAsHeader |
object |
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 |
Dataset |
The location of the excel storage. |
typeProperties.nullValue |
object |
The null value string. Type: string (or Expression with resultType string). |
typeProperties.range |
object |
The partial data of one sheet. Type: string (or Expression with resultType string). |
typeProperties.sheetIndex |
object |
The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer) |
typeProperties.sheetName |
object |
The sheet name of excel file. Type: string (or Expression with resultType string). |
FileShareDataset
An on-premises file system dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
File |
Type of dataset. |
typeProperties.compression |
The data compression method used for the file system. |
|
typeProperties.fileFilter |
object |
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 |
object |
The name of the on-premises file system. Type: string (or Expression with resultType string). |
typeProperties.folderPath |
object |
The path of the on-premises file system. Type: string (or Expression with resultType string). |
typeProperties.format |
Dataset |
The format of the files. |
typeProperties.modifiedDatetimeEnd |
object |
The end of file's modified datetime. Type: string (or Expression with resultType string). |
typeProperties.modifiedDatetimeStart |
object |
The start of file's modified datetime. Type: string (or Expression with resultType string). |
Folder
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. |
GoogleAdWordsObjectDataset
Google AdWords service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Google |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
GoogleBigQueryObjectDataset
Google BigQuery service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Google |
Type of dataset. |
typeProperties.dataset |
object |
The database name of the Google BigQuery. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Google BigQuery. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using database + table properties instead. |
GoogleBigQueryV2ObjectDataset
Google BigQuery service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Google |
Type of dataset. |
typeProperties.dataset |
object |
The database name of the Google BigQuery. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Google BigQuery. Type: string (or Expression with resultType string). |
GreenplumTableDataset
Greenplum Database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Greenplum |
Type of dataset. |
typeProperties.schema |
object |
The schema name of Greenplum. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of Greenplum. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
HBaseObjectDataset
HBase server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
HBase |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
HiveObjectDataset
Hive Server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Hive |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Hive. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Hive. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
HttpDataset
A file in an HTTP web server.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Http |
Type of dataset. |
typeProperties.additionalHeaders |
object |
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 |
The data compression method used on files. |
|
typeProperties.format |
Dataset |
The format of files. |
typeProperties.relativeUrl |
object |
The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string). |
typeProperties.requestBody |
object |
The body for the HTTP request. Type: string (or Expression with resultType string). |
typeProperties.requestMethod |
object |
The HTTP method for the HTTP request. Type: string (or Expression with resultType string). |
HubspotObjectDataset
Hubspot Service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Hubspot |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
IcebergDataset
Iceberg dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
Dataset |
The location of the iceberg storage. Setting a file name is not allowed for iceberg format. |
ImpalaObjectDataset
Impala server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Impala |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Impala. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Impala. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
InformixTableDataset
The Informix table dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Informix |
Type of dataset. |
typeProperties.tableName |
object |
The Informix table name. Type: string (or Expression with resultType string). |
JiraObjectDataset
Jira Service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Jira |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
JsonDataset
Json dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
The data compression method used for the json dataset. |
|
typeProperties.encodingName |
object |
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 |
Dataset |
The location of the json data storage. |
LakeHouseTableDataset
Microsoft Fabric LakeHouse Table.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Lake |
Type of dataset. |
typeProperties.schema |
object |
The schema name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string). |
LinkedServiceReference
Linked service reference type.
Name | Type | Description |
---|---|---|
parameters |
object |
Arguments for LinkedService. |
referenceName |
string |
Reference LinkedService name. |
type |
Linked service reference type. |
MagentoObjectDataset
Magento server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Magento |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
MariaDBTableDataset
MariaDB server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Maria |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
MarketoObjectDataset
Marketo server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Marketo |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
MicrosoftAccessTableDataset
The Microsoft Access table dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Microsoft |
Type of dataset. |
typeProperties.tableName |
object |
The Microsoft Access table name. Type: string (or Expression with resultType string). |
MongoDbAtlasCollectionDataset
The MongoDB Atlas database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Mongo |
Type of dataset. |
typeProperties.collection |
object |
The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string). |
MongoDbCollectionDataset
The MongoDB database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Mongo |
Type of dataset. |
typeProperties.collectionName |
object |
The table name of the MongoDB database. Type: string (or Expression with resultType string). |
MongoDbV2CollectionDataset
The MongoDB database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Mongo |
Type of dataset. |
typeProperties.collection |
object |
The collection name of the MongoDB database. Type: string (or Expression with resultType string). |
MySqlTableDataset
The MySQL table dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
My |
Type of dataset. |
typeProperties.tableName |
object |
The MySQL table name. Type: string (or Expression with resultType string). |
NetezzaTableDataset
Netezza dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Netezza |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Netezza. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Netezza. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
ODataResourceDataset
The Open Data Protocol (OData) resource dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
OData |
Type of dataset. |
typeProperties.path |
object |
The OData resource path. Type: string (or Expression with resultType string). |
OdbcTableDataset
The ODBC table dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Odbc |
Type of dataset. |
typeProperties.tableName |
object |
The ODBC table name. Type: string (or Expression with resultType string). |
Office365Dataset
The Office365 account.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
object |
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 |
object |
Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string). |
OracleServiceCloudObjectDataset
Oracle Service Cloud dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Oracle |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
OracleTableDataset
The on-premises Oracle database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Oracle |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the on-premises Oracle database. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
OrcDataset
ORC dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
Dataset |
The location of the ORC data storage. |
typeProperties.orcCompressionCodec |
object |
The data orcCompressionCodec. Type: string (or Expression with resultType string). |
ParameterSpecification
Definition of a single parameter for an entity.
Name | Type | Description |
---|---|---|
defaultValue |
object |
Default value of parameter. |
type |
Parameter type. |
ParameterType
Parameter type.
Name | Type | Description |
---|---|---|
Array |
string |
|
Bool |
string |
|
Float |
string |
|
Int |
string |
|
Object |
string |
|
SecureString |
string |
|
String |
string |
ParquetDataset
Parquet dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
object |
The data compressionCodec. Type: string (or Expression with resultType string). |
typeProperties.location |
Dataset |
The location of the parquet storage. |
PaypalObjectDataset
Paypal Service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Paypal |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
PhoenixObjectDataset
Phoenix server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Phoenix |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Phoenix. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Phoenix. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
PostgreSqlTableDataset
The PostgreSQL table dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Postgre |
Type of dataset. |
typeProperties.schema |
object |
The PostgreSQL schema name. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The PostgreSQL table name. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
PostgreSqlV2TableDataset
The PostgreSQLV2 table dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Postgre |
Type of dataset. |
typeProperties.schema |
object |
The PostgreSQL schema name. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The PostgreSQL table name. Type: string (or Expression with resultType string). |
PrestoObjectDataset
Presto server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Presto |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Presto. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Presto. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
QuickBooksObjectDataset
QuickBooks server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Quick |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
RelationalTableDataset
The relational table dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Relational |
Type of dataset. |
typeProperties.tableName |
object |
The relational table name. Type: string (or Expression with resultType string). |
ResponsysObjectDataset
Responsys dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Responsys |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
RestResourceDataset
A Rest service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Rest |
Type of dataset. |
typeProperties.additionalHeaders |
object |
The additional HTTP headers in the request to the RESTful API. |
typeProperties.paginationRules |
object |
The pagination rules to compose next page requests. |
typeProperties.relativeUrl |
object |
The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string). |
typeProperties.requestBody |
object |
The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string). |
typeProperties.requestMethod |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Salesforce |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
SalesforceObjectDataset
The Salesforce object dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Salesforce |
Type of dataset. |
typeProperties.objectApiName |
object |
The Salesforce object API name. Type: string (or Expression with resultType string). |
SalesforceServiceCloudObjectDataset
The Salesforce Service Cloud object dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Salesforce |
Type of dataset. |
typeProperties.objectApiName |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Salesforce |
Type of dataset. |
typeProperties.objectApiName |
object |
The Salesforce Service Cloud V2 object API name. Type: string (or Expression with resultType string). |
typeProperties.reportId |
object |
The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string). |
SalesforceV2ObjectDataset
The Salesforce V2 object dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
object |
The Salesforce V2 object API name. Type: string (or Expression with resultType string). |
typeProperties.reportId |
object |
The Salesforce V2 report Id. Type: string (or Expression with resultType string). |
SapBwCubeDataset
The SAP BW cube dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Sap |
Type of dataset. |
SapCloudForCustomerResourceDataset
The path of the SAP Cloud for Customer OData entity.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Sap |
Type of dataset. |
typeProperties.path |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Sap |
Type of dataset. |
typeProperties.path |
object |
The path of the SAP ECC OData entity. Type: string (or Expression with resultType string). |
SapHanaTableDataset
SAP HANA Table properties.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Sap |
Type of dataset. |
typeProperties.schema |
object |
The schema name of SAP HANA. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of SAP HANA. Type: string (or Expression with resultType string). |
SapOdpResourceDataset
SAP ODP Resource properties.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Sap |
Type of dataset. |
typeProperties.context |
object |
The context of the SAP ODP Object. Type: string (or Expression with resultType string). |
typeProperties.objectName |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Sap |
Type of dataset. |
typeProperties.baseRequestId |
object |
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 |
object |
Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean). |
typeProperties.openHubDestinationName |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Sap |
Type of dataset. |
typeProperties.tableName |
object |
The name of the SAP Table. Type: string (or Expression with resultType string). |
ServiceNowObjectDataset
ServiceNow server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Service |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
ServiceNowV2ObjectDataset
ServiceNowV2 server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Service |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
SharePointOnlineListResourceDataset
The sharepoint online list resource dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Share |
Type of dataset. |
typeProperties.listName |
object |
The name of the SharePoint Online list. Type: string (or Expression with resultType string). |
ShopifyObjectDataset
Shopify Service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Shopify |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
SnowflakeDataset
The snowflake dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Snowflake |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Snowflake database. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Snowflake database. Type: string (or Expression with resultType string). |
SnowflakeV2Dataset
The snowflake dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
object |
The schema name of the Snowflake database. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Snowflake database. Type: string (or Expression with resultType string). |
SparkObjectDataset
Spark Server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Spark |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Spark. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Spark. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
SqlServerTableDataset
The on-premises SQL Server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Sql |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the SQL Server dataset. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the SQL Server dataset. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
SquareObjectDataset
Square Service dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Square |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
SybaseTableDataset
The Sybase table dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Sybase |
Type of dataset. |
typeProperties.tableName |
object |
The Sybase table name. Type: string (or Expression with resultType string). |
TeradataTableDataset
The Teradata database dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Teradata |
Type of dataset. |
typeProperties.database |
object |
The database name of Teradata. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of Teradata. Type: string (or Expression with resultType string). |
Type
Linked service reference type.
Name | Type | Description |
---|---|---|
LinkedServiceReference |
string |
VerticaTableDataset
Vertica dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Vertica |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Vertica. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
The table name of the Vertica. Type: string (or Expression with resultType string). |
typeProperties.tableName |
object |
This property will be retired. Please consider using schema + table properties instead. |
WarehouseTableDataset
Microsoft Fabric Warehouse dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Warehouse |
Type of dataset. |
typeProperties.schema |
object |
The schema name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). |
typeProperties.table |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Web |
Type of dataset. |
typeProperties.index |
object |
The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0. |
typeProperties.path |
object |
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 |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Xero |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |
XmlDataset
Xml dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
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 |
The data compression method used for the json dataset. |
|
typeProperties.encodingName |
object |
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 |
Dataset |
The location of the json data storage. |
typeProperties.nullValue |
object |
The null value string. Type: string (or Expression with resultType string). |
ZohoObjectDataset
Zoho server dataset.
Name | Type | Description |
---|---|---|
annotations |
object[] |
List of tags that can be used for describing the Dataset. |
description |
string |
Dataset description. |
folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
linkedServiceName |
Linked service reference. |
|
parameters |
<string,
Parameter |
Parameters for dataset. |
schema |
object |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
structure |
object |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
type |
string:
Zoho |
Type of dataset. |
typeProperties.tableName |
object |
The table name. Type: string (or Expression with resultType string). |