Package version:

Interface Dataset

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

interface Dataset {
    annotations?: any[];
    description?: string;
    folder?: DatasetFolder;
    linkedServiceName: LinkedServiceReference;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    schema?: any;
    structure?: any;
    type:
        | "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: string]: any;
}

Hierarchy (view full)

Indexable

  • [property: string]: any

    Describes unknown properties. The value of an unknown property can be of "any" type.

Properties

annotations? description? folder? linkedServiceName parameters? schema? structure? type

Properties

Optionalannotations

annotations?: any[]

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

Optionaldescription

description?: string

Dataset description.

Optionalfolder

folder?: DatasetFolder

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

linkedServiceName

linkedServiceName: LinkedServiceReference

Linked service reference.

Optionalparameters

parameters?: {
    [propertyName: string]: ParameterSpecification;
}

Parameters for dataset.

Optionalschema

schema?: any

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

Optionalstructure

structure?: any

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

type

type:
    | "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"

Polymorphic discriminator, which specifies the different types this object can be

Settings

Member Visibility