Dataset interface

The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.

Properties

additionalProperties

Additional properties

annotations

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

description

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

Parameters for dataset.

schema

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

structure

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

type

The discriminator possible values: AmazonS3Object, Avro, Excel, Parquet, DelimitedText, Json, Xml, Orc, Binary, Iceberg, AzureBlob, AzureTable, AzureSqlTable, AzureSqlMITable, AzureSqlDWTable, CassandraTable, CustomDataset, CosmosDbSqlApiCollection, DocumentDbCollection, DynamicsEntity, DynamicsCrmEntity, CommonDataServiceForAppsEntity, AzureDataLakeStoreFile, AzureBlobFSFile, Office365Table, FileShare, MongoDbCollection, MongoDbAtlasCollection, MongoDbV2Collection, CosmosDbMongoDbApiCollection, ODataResource, OracleTable, AmazonRdsForOracleTable, TeradataTable, AzureMySqlTable, AmazonRedshiftTable, Db2Table, RelationalTable, InformixTable, OdbcTable, MySqlTable, PostgreSqlTable, PostgreSqlV2Table, MicrosoftAccessTable, SalesforceObject, SalesforceServiceCloudObject, SybaseTable, SapBwCube, SapCloudForCustomerResource, SapEccResource, SapHanaTable, SapOpenHubTable, SqlServerTable, AmazonRdsForSqlServerTable, RestResource, SapTableResource, SapOdpResource, WebTable, AzureSearchIndex, HttpFile, AmazonMWSObject, AzurePostgreSqlTable, ConcurObject, CouchbaseTable, DrillTable, EloquaObject, GoogleBigQueryObject, GoogleBigQueryV2Object, GreenplumTable, HBaseObject, HiveObject, HubspotObject, ImpalaObject, JiraObject, MagentoObject, MariaDBTable, AzureMariaDBTable, MarketoObject, PaypalObject, PhoenixObject, PrestoObject, QuickBooksObject, ServiceNowObject, ShopifyObject, SparkObject, SquareObject, XeroObject, ZohoObject, NetezzaTable, VerticaTable, SalesforceMarketingCloudObject, ResponsysObject, DynamicsAXResource, OracleServiceCloudObject, AzureDataExplorerTable, GoogleAdWordsObject, SnowflakeTable, SnowflakeV2Table, SharePointOnlineListResource, AzureDatabricksDeltaLakeDataset, LakehouseTable, SalesforceV2Object, SalesforceServiceCloudV2Object, WarehouseTable, ServiceNowV2Object

Property Details

additionalProperties

Additional properties

additionalProperties?: Record<string, any>

Property Value

Record<string, any>

annotations

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

annotations?: any[]

Property Value

any[]

description

Dataset description.

description?: string

Property Value

string

folder

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

folder?: DatasetFolder

Property Value

linkedServiceName

Linked service reference.

linkedServiceName: LinkedServiceReference

Property Value

parameters

Parameters for dataset.

parameters?: Record<string, ParameterSpecification>

Property Value

Record<string, ParameterSpecification>

schema

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

schema?: any

Property Value

any

structure

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

structure?: any

Property Value

any

type

The discriminator possible values: AmazonS3Object, Avro, Excel, Parquet, DelimitedText, Json, Xml, Orc, Binary, Iceberg, AzureBlob, AzureTable, AzureSqlTable, AzureSqlMITable, AzureSqlDWTable, CassandraTable, CustomDataset, CosmosDbSqlApiCollection, DocumentDbCollection, DynamicsEntity, DynamicsCrmEntity, CommonDataServiceForAppsEntity, AzureDataLakeStoreFile, AzureBlobFSFile, Office365Table, FileShare, MongoDbCollection, MongoDbAtlasCollection, MongoDbV2Collection, CosmosDbMongoDbApiCollection, ODataResource, OracleTable, AmazonRdsForOracleTable, TeradataTable, AzureMySqlTable, AmazonRedshiftTable, Db2Table, RelationalTable, InformixTable, OdbcTable, MySqlTable, PostgreSqlTable, PostgreSqlV2Table, MicrosoftAccessTable, SalesforceObject, SalesforceServiceCloudObject, SybaseTable, SapBwCube, SapCloudForCustomerResource, SapEccResource, SapHanaTable, SapOpenHubTable, SqlServerTable, AmazonRdsForSqlServerTable, RestResource, SapTableResource, SapOdpResource, WebTable, AzureSearchIndex, HttpFile, AmazonMWSObject, AzurePostgreSqlTable, ConcurObject, CouchbaseTable, DrillTable, EloquaObject, GoogleBigQueryObject, GoogleBigQueryV2Object, GreenplumTable, HBaseObject, HiveObject, HubspotObject, ImpalaObject, JiraObject, MagentoObject, MariaDBTable, AzureMariaDBTable, MarketoObject, PaypalObject, PhoenixObject, PrestoObject, QuickBooksObject, ServiceNowObject, ShopifyObject, SparkObject, SquareObject, XeroObject, ZohoObject, NetezzaTable, VerticaTable, SalesforceMarketingCloudObject, ResponsysObject, DynamicsAXResource, OracleServiceCloudObject, AzureDataExplorerTable, GoogleAdWordsObject, SnowflakeTable, SnowflakeV2Table, SharePointOnlineListResource, AzureDatabricksDeltaLakeDataset, LakehouseTable, SalesforceV2Object, SalesforceServiceCloudV2Object, WarehouseTable, ServiceNowV2Object

type: string

Property Value

string