Azure.Analytics.Synapse.Artifacts.Models Namespace

Classes

Activity

A pipeline activity. Please note Activity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AppendVariableActivity, AzureDataExplorerCommandActivity, AzureFunctionActivity, AzureMLBatchExecutionActivity, AzureMLExecutePipelineActivity, AzureMLUpdateResourceActivity, ControlActivity, CopyActivity, CustomActivity, DataLakeAnalyticsUsqlActivity, DatabricksNotebookActivity, DatabricksSparkJarActivity, DatabricksSparkPythonActivity, DeleteActivity, ExecuteDataFlowActivity, ExecutePipelineActivity, ExecuteSsisPackageActivity, ExecutionActivity, FailActivity, FilterActivity, ForEachActivity, GetMetadataActivity, HDInsightHiveActivity, HDInsightMapReduceActivity, HDInsightPigActivity, HDInsightSparkActivity, HDInsightStreamingActivity, IfConditionActivity, LookupActivity, ScriptActivity, SetVariableActivity, SynapseSparkJobDefinitionActivity, SqlPoolStoredProcedureActivity, SqlServerStoredProcedureActivity, SwitchActivity, SynapseNotebookActivity, UntilActivity, ValidationActivity, WaitActivity, WebActivity and WebHookActivity.

ActivityDependency

Activity dependency information.

ActivityPolicy

Execution policy for an activity.

ActivityRun

Information about an activity run in a pipeline.

ActivityRunsQueryResponse

A list activity runs.

AddDataFlowToDebugSessionResponse

Response body structure for starting data flow debug session.

AmazonMWSLinkedService

Amazon Marketplace Web Service linked service.

AmazonMWSObjectDataset

Amazon Marketplace Web Service dataset.

AmazonMWSSource

A copy activity Amazon Marketplace Web Service source.

AmazonRdsForOracleLinkedService

AmazonRdsForOracle database.

AmazonRdsForOraclePartitionSettings

The settings that will be leveraged for AmazonRdsForOracle source partitioning.

AmazonRdsForOracleSource

A copy activity AmazonRdsForOracle source.

AmazonRdsForOracleTableDataset

The AmazonRdsForOracle database dataset.

AmazonRdsForSqlServerLinkedService

Amazon RDS for SQL Server linked service.

AmazonRdsForSqlServerSource

A copy activity Amazon RDS for SQL Server source.

AmazonRdsForSqlServerTableDataset

The Amazon RDS for SQL Server dataset.

AmazonRedshiftLinkedService

Linked service for Amazon Redshift.

AmazonRedshiftSource

A copy activity source for Amazon Redshift Source.

AmazonRedshiftTableDataset

The Amazon Redshift table dataset.

AmazonS3Dataset

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

AmazonS3LinkedService

Linked service for Amazon S3.

AmazonS3Location

The location of amazon S3 dataset.

AmazonS3ReadSettings

Azure data lake store read settings.

AnalyticsSynapseArtifactsModelFactory

Model factory for models.

AppendVariableActivity

Append value for a Variable of type Array.

AppFiguresLinkedService

Linked service for AppFigures.

ArtifactRenameRequest

Request body structure for rename artifact.

AsanaLinkedService

Linked service for Asana.

AutoPauseProperties

Auto-pausing properties of a Big Data pool powered by Apache Spark.

AutoScaleProperties

Auto-scaling properties of a Big Data pool powered by Apache Spark.

AvroDataset

Avro dataset.

AvroFormat

The data stored in Avro format.

AvroSink

A copy activity Avro sink.

AvroSource

A copy activity Avro source.

AvroWriteSettings

Avro write settings.

AzureBatchLinkedService

Azure Batch linked service.

AzureBlobDataset

The Azure Blob storage.

AzureBlobFSDataset

The Azure Data Lake Storage Gen2 storage.

AzureBlobFSLinkedService

Azure Data Lake Storage Gen2 linked service.

AzureBlobFSLocation

The location of azure blobFS dataset.

AzureBlobFSReadSettings

Azure blobFS read settings.

AzureBlobFSSink

A copy activity Azure Data Lake Storage Gen2 sink.

AzureBlobFSSource

A copy activity Azure BlobFS source.

AzureBlobFSWriteSettings

Azure blobFS write settings.

AzureBlobStorageLinkedService

The azure blob storage linked service.

AzureBlobStorageLocation

The location of azure blob dataset.

AzureBlobStorageReadSettings

Azure blob read settings.

AzureBlobStorageWriteSettings

Azure blob write settings.

AzureDatabricksDeltaLakeDataset

Azure Databricks Delta Lake dataset.

AzureDatabricksDeltaLakeExportCommand

Azure Databricks Delta Lake export command settings.

AzureDatabricksDeltaLakeImportCommand

Azure Databricks Delta Lake import command settings.

AzureDatabricksDeltaLakeLinkedService

Azure Databricks Delta Lake linked service.

AzureDatabricksDeltaLakeSink

A copy activity Azure Databricks Delta Lake sink.

AzureDatabricksDeltaLakeSource

A copy activity Azure Databricks Delta Lake source.

AzureDatabricksLinkedService

Azure Databricks linked service.

AzureDataExplorerCommandActivity

Azure Data Explorer command activity.

AzureDataExplorerLinkedService

Azure Data Explorer (Kusto) linked service.

AzureDataExplorerSink

A copy activity Azure Data Explorer sink.

AzureDataExplorerSource

A copy activity Azure Data Explorer (Kusto) source.

AzureDataExplorerTableDataset

The Azure Data Explorer (Kusto) dataset.

AzureDataLakeAnalyticsLinkedService

Azure Data Lake Analytics linked service.

AzureDataLakeStoreDataset

Azure Data Lake Store dataset.

AzureDataLakeStoreLinkedService

Azure Data Lake Store linked service.

AzureDataLakeStoreLocation

The location of azure data lake store dataset.

AzureDataLakeStoreReadSettings

Azure data lake store read settings.

AzureDataLakeStoreSink

A copy activity Azure Data Lake Store sink.

AzureDataLakeStoreSource

A copy activity Azure Data Lake source.

AzureDataLakeStoreWriteSettings

Azure data lake store write settings.

AzureEntityResource

The resource model definition for an Azure Resource Manager resource with an etag.

AzureFileStorageLinkedService

Azure File Storage linked service.

AzureFileStorageLocation

The location of file server dataset.

AzureFileStorageReadSettings

Azure File Storage read settings.

AzureFileStorageWriteSettings

Azure File Storage write settings.

AzureFunctionActivity

Azure Function activity.

AzureFunctionLinkedService

Azure Function linked service.

AzureKeyVaultLinkedService

Azure Key Vault linked service.

AzureKeyVaultSecretReference

Azure Key Vault secret reference.

AzureMariaDBLinkedService

Azure Database for MariaDB linked service.

AzureMariaDBSource

A copy activity Azure MariaDB source.

AzureMariaDBTableDataset

Azure Database for MariaDB dataset.

AzureMLBatchExecutionActivity

Azure ML Batch Execution activity.

AzureMLExecutePipelineActivity

Azure ML Execute Pipeline activity.

AzureMLLinkedService

Azure ML Studio Web Service linked service.

AzureMLServiceLinkedService

Azure ML Service linked service.

AzureMLUpdateResourceActivity

Azure ML Update Resource management activity.

AzureMLWebServiceFile

Azure ML WebService Input/Output file.

AzureMySqlLinkedService

Azure MySQL database linked service.

AzureMySqlSink

A copy activity Azure MySql sink.

AzureMySqlSource

A copy activity Azure MySQL source.

AzureMySqlTableDataset

The Azure MySQL database dataset.

AzurePostgreSqlLinkedService

Azure PostgreSQL linked service.

AzurePostgreSqlSink

A copy activity Azure PostgreSQL sink.

AzurePostgreSqlSource

A copy activity Azure PostgreSQL source.

AzurePostgreSqlTableDataset

Azure PostgreSQL dataset.

AzureQueueSink

A copy activity Azure Queue sink.

AzureSearchIndexDataset

The Azure Search Index.

AzureSearchIndexSink

A copy activity Azure Search Index sink.

AzureSearchLinkedService

Linked service for Windows Azure Search Service.

AzureSqlDatabaseLinkedService

Microsoft Azure SQL Database linked service.

AzureSqlDWLinkedService

Azure SQL Data Warehouse linked service.

AzureSqlDWTableDataset

The Azure SQL Data Warehouse dataset.

AzureSqlMILinkedService

Azure SQL Managed Instance linked service.

AzureSqlMITableDataset

The Azure SQL Managed Instance dataset.

AzureSqlSink

A copy activity Azure SQL sink.

AzureSqlSource

A copy activity Azure SQL source.

AzureSqlTableDataset

The Azure SQL Server database dataset.

AzureStorageLinkedService

The storage account linked service.

AzureSynapseArtifactsLinkedService

Azure Synapse Analytics (Artifacts) linked service.

AzureTableDataset

The Azure Table storage dataset.

AzureTableSink

A copy activity Azure Table sink.

AzureTableSource

A copy activity Azure Table source.

AzureTableStorageLinkedService

The azure table storage linked service.

BigDataPoolParametrizationReference

Big data pool reference type.

BigDataPoolReference

Big data pool reference.

BigDataPoolResourceInfo

A Big Data pool.

BigDataPoolResourceInfoListResult

Collection of Big Data pool information.

BinaryDataset

Binary dataset.

BinaryReadSettings

Binary read settings.

BinarySink

A copy activity Binary sink.

BinarySource

A copy activity Binary source.

BlobEventsTrigger

Trigger that runs every time a Blob event occurs.

BlobSink

A copy activity Azure Blob sink.

BlobSource

A copy activity Azure Blob source.

BlobTrigger

Trigger that runs every time the selected Blob container changes.

CassandraLinkedService

Linked service for Cassandra data source.

CassandraSource

A copy activity source for a Cassandra database.

CassandraTableDataset

The Cassandra database dataset.

ChainingTrigger

Trigger that allows the referenced pipeline to depend on other pipeline runs based on runDimension Name/Value pairs. Upstream pipelines should declare the same runDimension Name and their runs should have the values for those runDimensions. The referenced pipeline run would be triggered if the values for the runDimension match for all upstream pipeline runs.

CloudError

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

CommonDataServiceForAppsEntityDataset

The Common Data Service for Apps entity dataset.

CommonDataServiceForAppsLinkedService

Common Data Service for Apps linked service.

CommonDataServiceForAppsSink

A copy activity Common Data Service for Apps sink.

CommonDataServiceForAppsSource

A copy activity Common Data Service for Apps source.

CompressionReadSettings

Compression read settings. Please note CompressionReadSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include TarGZipReadSettings, TarReadSettings and ZipDeflateReadSettings.

ConcurLinkedService

Concur Service linked service.

ConcurObjectDataset

Concur Service dataset.

ConcurSource

A copy activity Concur Service source.

ControlActivity

Base class for all control activities like IfCondition, ForEach , Until. Please note ControlActivity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AppendVariableActivity, ExecutePipelineActivity, FailActivity, FilterActivity, ForEachActivity, IfConditionActivity, SetVariableActivity, SwitchActivity, UntilActivity, ValidationActivity, WaitActivity and WebHookActivity.

CopyActivity

Copy activity.

CopyActivityLogSettings

Settings for copy activity log.

CopySink

A copy activity sink. Please note CopySink is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AvroSink, AzureBlobFSSink, AzureDataExplorerSink, AzureDataLakeStoreSink, AzureDatabricksDeltaLakeSink, AzureMySqlSink, AzurePostgreSqlSink, AzureQueueSink, AzureSearchIndexSink, AzureSqlSink, AzureTableSink, BinarySink, BlobSink, CommonDataServiceForAppsSink, CosmosDbMongoDbApiSink, CosmosDbSqlApiSink, DelimitedTextSink, DocumentDbCollectionSink, DynamicsCrmSink, DynamicsSink, FileSystemSink, InformixSink, JsonSink, MicrosoftAccessSink, OdbcSink, OracleSink, OrcSink, ParquetSink, RestSink, SalesforceServiceCloudSink, SalesforceSink, SapCloudForCustomerSink, SnowflakeSink, SqlDWSink, SqlMISink, SqlServerSink and SqlSink.

CopySource

A copy activity source. Please note CopySource is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmazonMWSSource, AmazonRdsForOracleSource, AmazonRdsForSqlServerSource, AmazonRedshiftSource, AvroSource, AzureBlobFSSource, AzureDataExplorerSource, AzureDataLakeStoreSource, AzureDatabricksDeltaLakeSource, AzureMariaDBSource, AzureMySqlSource, AzurePostgreSqlSource, AzureSqlSource, AzureTableSource, BinarySource, BlobSource, CassandraSource, CommonDataServiceForAppsSource, ConcurSource, CosmosDbMongoDbApiSource, CosmosDbSqlApiSource, CouchbaseSource, Db2Source, DelimitedTextSource, DocumentDbCollectionSource, DrillSource, DynamicsAXSource, DynamicsCrmSource, DynamicsSource, EloquaSource, ExcelSource, FileSystemSource, GoogleAdWordsSource, GoogleBigQuerySource, GreenplumSource, HBaseSource, HdfsSource, HiveSource, HttpSource, HubspotSource, ImpalaSource, InformixSource, JiraSource, JsonSource, MagentoSource, MariaDBSource, MarketoSource, MicrosoftAccessSource, MongoDbAtlasSource, MongoDbSource, MongoDbV2Source, MySqlSource, NetezzaSource, ODataSource, OdbcSource, Office365Source, OracleServiceCloudSource, OracleSource, OrcSource, ParquetSource, PaypalSource, PhoenixSource, PostgreSqlSource, PrestoSource, QuickBooksSource, RelationalSource, ResponsysSource, RestSource, SalesforceMarketingCloudSource, SalesforceServiceCloudSource, SalesforceSource, SapBwSource, SapCloudForCustomerSource, SapEccSource, SapHanaSource, SapOdpSource, SapOpenHubSource, SapTableSource, ServiceNowSource, SharePointOnlineListSource, ShopifySource, SnowflakeSource, SparkSource, SqlDWSource, SqlMISource, SqlServerSource, SqlSource, SquareSource, SybaseSource, TabularSource, TeradataSource, VerticaSource, WebSource, XeroSource, XmlSource and ZohoSource.

CopyTranslator

A copy activity translator. Please note CopyTranslator is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include TabularTranslator.

CosmosDbLinkedService

Microsoft Azure Cosmos Database (CosmosDB) linked service.

CosmosDbMongoDbApiCollectionDataset

The CosmosDB (MongoDB API) database dataset.

CosmosDbMongoDbApiLinkedService

Linked service for CosmosDB (MongoDB API) data source.

CosmosDbMongoDbApiSink

A copy activity sink for a CosmosDB (MongoDB API) database.

CosmosDbMongoDbApiSource

A copy activity source for a CosmosDB (MongoDB API) database.

CosmosDbSqlApiCollectionDataset

Microsoft Azure CosmosDB (SQL API) Collection dataset.

CosmosDbSqlApiSink

A copy activity Azure CosmosDB (SQL API) Collection sink.

CosmosDbSqlApiSource

A copy activity Azure CosmosDB (SQL API) Collection source.

CouchbaseLinkedService

Couchbase server linked service.

CouchbaseSource

A copy activity Couchbase server source.

CouchbaseTableDataset

Couchbase server dataset.

CreateDataFlowDebugSessionRequest

Request body structure for creating data flow debug session.

CreateDataFlowDebugSessionResponse

Response body structure for creating data flow debug session.

CreateRunResponse

Response body with a run identifier.

CredentialReference

Credential reference type.

CustomActivity

Custom activity type.

CustomActivityReferenceObject

Reference objects for custom activity.

CustomDataset

The custom dataset.

CustomDataSourceLinkedService

Custom linked service.

CustomerManagedKeyDetails

Details of the customer managed key associated with the workspace.

CustomEventsTrigger

Trigger that runs every time a custom event is received.

CustomSetupBase

The base definition of the custom setup.

DatabricksNotebookActivity

DatabricksNotebook activity.

DatabricksSparkJarActivity

DatabricksSparkJar activity.

DatabricksSparkPythonActivity

DatabricksSparkPython activity.

DataFlow

Azure Synapse nested object which contains a flow with data movements and transformations. Please note DataFlow is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include Flowlet and MappingDataFlow.

DataFlowDebugCommandPayload

Structure of command payload.

DataFlowDebugCommandRequest

Request body structure for data flow expression preview.

DataFlowDebugCommandResponse

Response body structure of data flow result for data preview, statistics or expression preview.

DataFlowDebugPackage

Request body structure for starting data flow debug session.

DataFlowDebugPackageDebugSettings

Data flow debug settings.

DataFlowDebugPreviewDataRequest

Request body structure for data flow preview data.

DataFlowDebugQueryResponse

Response body structure of data flow query for data preview, statistics or expression preview.

DataFlowDebugResource

Data flow debug resource.

DataFlowDebugResultResponse

Response body structure of data flow result for data preview, statistics or expression preview.

DataFlowDebugSessionInfo

Data flow debug session info.

DataFlowDebugStatisticsRequest

Request body structure for data flow statistics.

DataFlowFolder

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

DataFlowReference

Data flow reference type.

DataFlowResource

Data flow resource type.

DataFlowSink

Transformation for data flow sink.

DataFlowSource

Transformation for data flow source.

DataFlowSourceSetting

Definition of data flow source setting for debug.

DataFlowStagingInfo

Staging info for execute data flow activity.

DataLakeAnalyticsUsqlActivity

Data Lake Analytics U-SQL activity.

DataLakeStorageAccountDetails

Details of the data lake storage account associated with the workspace.

Dataset

The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents. Please note Dataset is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmazonMWSObjectDataset, AmazonRdsForOracleTableDataset, AmazonRdsForSqlServerTableDataset, AmazonRedshiftTableDataset, AmazonS3Dataset, AvroDataset, AzureBlobDataset, AzureBlobFSDataset, AzureDataExplorerTableDataset, AzureDataLakeStoreDataset, AzureDatabricksDeltaLakeDataset, AzureMariaDBTableDataset, AzureMySqlTableDataset, AzurePostgreSqlTableDataset, AzureSearchIndexDataset, AzureSqlDWTableDataset, AzureSqlMITableDataset, AzureSqlTableDataset, AzureTableDataset, BinaryDataset, CassandraTableDataset, CommonDataServiceForAppsEntityDataset, ConcurObjectDataset, CosmosDbMongoDbApiCollectionDataset, CosmosDbSqlApiCollectionDataset, CouchbaseTableDataset, CustomDataset, Db2TableDataset, DelimitedTextDataset, DocumentDbCollectionDataset, DrillTableDataset, DynamicsAXResourceDataset, DynamicsCrmEntityDataset, DynamicsEntityDataset, EloquaObjectDataset, ExcelDataset, FileShareDataset, GoogleAdWordsObjectDataset, GoogleBigQueryObjectDataset, GreenplumTableDataset, HBaseObjectDataset, HiveObjectDataset, HttpDataset, HubspotObjectDataset, ImpalaObjectDataset, InformixTableDataset, JiraObjectDataset, JsonDataset, MagentoObjectDataset, MariaDBTableDataset, MarketoObjectDataset, MicrosoftAccessTableDataset, MongoDbAtlasCollectionDataset, MongoDbCollectionDataset, MongoDbV2CollectionDataset, MySqlTableDataset, NetezzaTableDataset, ODataResourceDataset, OdbcTableDataset, Office365Dataset, OracleServiceCloudObjectDataset, OracleTableDataset, OrcDataset, ParquetDataset, PaypalObjectDataset, PhoenixObjectDataset, PostgreSqlTableDataset, PrestoObjectDataset, QuickBooksObjectDataset, RelationalTableDataset, ResponsysObjectDataset, RestResourceDataset, SalesforceMarketingCloudObjectDataset, SalesforceObjectDataset, SalesforceServiceCloudObjectDataset, SapBwCubeDataset, SapCloudForCustomerResourceDataset, SapEccResourceDataset, SapHanaTableDataset, SapOdpResourceDataset, SapOpenHubTableDataset, SapTableResourceDataset, ServiceNowObjectDataset, SharePointOnlineListResourceDataset, ShopifyObjectDataset, SnowflakeDataset, SparkObjectDataset, SqlServerTableDataset, SquareObjectDataset, SybaseTableDataset, TeradataTableDataset, VerticaTableDataset, WebTableDataset, XeroObjectDataset, XmlDataset and ZohoObjectDataset.

DatasetCompression

The compression method used on a dataset.

DatasetDataElement

Columns that define the structure of the dataset.

DatasetDebugResource

Dataset debug resource.

DatasetFolder

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

DatasetLocation

Dataset location. Please note DatasetLocation is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmazonS3Location, AzureBlobFSLocation, AzureBlobStorageLocation, AzureDataLakeStoreLocation, AzureFileStorageLocation, FileServerLocation, FtpServerLocation, GoogleCloudStorageLocation, HdfsLocation, HttpServerLocation and SftpLocation.

DatasetReference

Dataset reference type.

DatasetResource

Dataset resource type.

DatasetSchemaDataElement

Columns that define the physical type schema of the dataset.

DatasetStorageFormat

The format definition of a storage. Please note DatasetStorageFormat is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AvroFormat, JsonFormat, OrcFormat, ParquetFormat and TextFormat.

DataworldLinkedService

Linked service for Dataworld.

Db2LinkedService

Linked service for DB2 data source.

Db2Source

A copy activity source for Db2 databases.

Db2TableDataset

The Db2 table dataset.

DeleteActivity

Delete activity.

DeleteDataFlowDebugSessionRequest

Request body structure for deleting data flow debug session.

DelimitedTextDataset

Delimited text dataset.

DelimitedTextReadSettings

Delimited text read settings.

DelimitedTextSink

A copy activity DelimitedText sink.

DelimitedTextSource

A copy activity DelimitedText source.

DelimitedTextWriteSettings

Delimited text write settings.

DependencyReference

Referenced dependency. Please note DependencyReference is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SelfDependencyTumblingWindowTriggerReference, TriggerDependencyReference and TumblingWindowTriggerDependencyReference.

DistcpSettings

Distcp settings.

DocumentDbCollectionDataset

Microsoft Azure Document Database Collection dataset.

DocumentDbCollectionSink

A copy activity Document Database Collection sink.

DocumentDbCollectionSource

A copy activity Document Database Collection source.

DrillLinkedService

Drill server linked service.

DrillSource

A copy activity Drill server source.

DrillTableDataset

Drill server dataset.

DWCopyCommandDefaultValue

Default value.

DWCopyCommandSettings

DW Copy Command settings.

DynamicExecutorAllocation

Dynamic Executor Allocation Properties.

DynamicsAXLinkedService

Dynamics AX linked service.

DynamicsAXResourceDataset

The path of the Dynamics AX OData entity.

DynamicsAXSource

A copy activity Dynamics AX source.

DynamicsCrmEntityDataset

The Dynamics CRM entity dataset.

DynamicsCrmLinkedService

Dynamics CRM linked service.

DynamicsCrmSink

A copy activity Dynamics CRM sink.

DynamicsCrmSource

A copy activity Dynamics CRM source.

DynamicsEntityDataset

The Dynamics entity dataset.

DynamicsLinkedService

Dynamics linked service.

DynamicsSink

A copy activity Dynamics sink.

DynamicsSource

A copy activity Dynamics source.

EditTablesRequest

The EditTablesRequest.

EloquaLinkedService

Eloqua server linked service.

EloquaObjectDataset

Eloqua server dataset.

EloquaSource

A copy activity Eloqua server source.

EncryptionDetails

Details of the encryption associated with the workspace.

EntityReference

The entity reference.

EvaluateDataFlowExpressionRequest

Request body structure for data flow expression preview.

ExcelDataset

Excel dataset.

ExcelSource

A copy activity excel source.

ExecuteDataFlowActivity

Execute data flow activity.

ExecuteDataFlowActivityTypePropertiesCompute

Compute properties for data flow activity.

ExecutePipelineActivity

Execute pipeline activity.

ExecuteSsisPackageActivity

Execute SSIS package activity.

ExecutionActivity

Base class for all execution activities. Please note ExecutionActivity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureDataExplorerCommandActivity, AzureFunctionActivity, AzureMLBatchExecutionActivity, AzureMLExecutePipelineActivity, AzureMLUpdateResourceActivity, CopyActivity, CustomActivity, DataLakeAnalyticsUsqlActivity, DatabricksNotebookActivity, DatabricksSparkJarActivity, DatabricksSparkPythonActivity, DeleteActivity, ExecuteDataFlowActivity, ExecuteSsisPackageActivity, GetMetadataActivity, HDInsightHiveActivity, HDInsightMapReduceActivity, HDInsightPigActivity, HDInsightSparkActivity, HDInsightStreamingActivity, LookupActivity, ScriptActivity, SynapseSparkJobDefinitionActivity, SqlServerStoredProcedureActivity, SynapseNotebookActivity and WebActivity.

ExportSettings

Export command settings. Please note ExportSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureDatabricksDeltaLakeExportCommand and SnowflakeExportCopyCommand.

ExposureControlRequest

The exposure control request.

ExposureControlResponse

The exposure control response.

Expression

Azure Synapse expression definition.

FailActivity

This activity will fail within its own scope and output a custom error message and error code. The error message and code can provided either as a string literal or as an expression that can be evaluated to a string at runtime. The activity scope can be the whole pipeline or a control activity (e.g. foreach, switch, until), if the fail activity is contained in it.

FileServerLinkedService

File system linked service.

FileServerLocation

The location of file server dataset.

FileServerReadSettings

File server read settings.

FileServerWriteSettings

File server write settings.

FileShareDataset

An on-premises file system dataset.

FileSystemSink

A copy activity file system sink.

FileSystemSource

A copy activity file system source.

FilterActivity

Filter and return results from input array based on the conditions.

Flowlet

Data flow flowlet.

ForEachActivity

This activity is used for iterating over a collection and execute given activities.

FormatReadSettings

Format read settings. Please note FormatReadSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BinaryReadSettings, JsonReadSettings, XmlReadSettings and DelimitedTextReadSettings.

FormatWriteSettings

Format write settings. Please note FormatWriteSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AvroWriteSettings, JsonWriteSettings, OrcWriteSettings, ParquetWriteSettings and DelimitedTextWriteSettings.

FtpReadSettings

Ftp read settings.

FtpServerLinkedService

A FTP server Linked Service.

FtpServerLocation

The location of ftp server dataset.

GetMetadataActivity

Activity to get metadata of dataset.

GetSsisObjectMetadataRequest

The request payload of get SSIS object metadata.

GitHubAccessTokenRequest

The GitHubAccessTokenRequest.

GitHubAccessTokenResponse

The GitHubAccessTokenResponse.

GitHubClientSecret

Client secret information for factory's bring your own app repository configuration.

GoogleAdWordsLinkedService

Google AdWords service linked service.

GoogleAdWordsObjectDataset

Google AdWords service dataset.

GoogleAdWordsSource

A copy activity Google AdWords service source.

GoogleBigQueryLinkedService

Google BigQuery service linked service.

GoogleBigQueryObjectDataset

Google BigQuery service dataset.

GoogleBigQuerySource

A copy activity Google BigQuery service source.

GoogleCloudStorageLinkedService

Linked service for Google Cloud Storage.

GoogleCloudStorageLocation

The location of Google Cloud Storage dataset.

GoogleCloudStorageReadSettings

Google Cloud Storage read settings.

GoogleSheetsLinkedService

Linked service for GoogleSheets.

GreenplumLinkedService

Greenplum Database linked service.

GreenplumSource

A copy activity Greenplum Database source.

GreenplumTableDataset

Greenplum Database dataset.

HBaseLinkedService

HBase server linked service.

HBaseObjectDataset

HBase server dataset.

HBaseSource

A copy activity HBase server source.

HdfsLinkedService

Hadoop Distributed File System (HDFS) linked service.

HdfsLocation

The location of HDFS.

HdfsReadSettings

HDFS read settings.

HdfsSource

A copy activity HDFS source.

HDInsightHiveActivity

HDInsight Hive activity type.

HDInsightLinkedService

HDInsight linked service.

HDInsightMapReduceActivity

HDInsight MapReduce activity type.

HDInsightOnDemandLinkedService

HDInsight ondemand linked service.

HDInsightPigActivity

HDInsight Pig activity type.

HDInsightSparkActivity

HDInsight Spark activity.

HDInsightStreamingActivity

HDInsight streaming activity type.

HiveLinkedService

Hive Server linked service.

HiveObjectDataset

Hive Server dataset.

HiveSource

A copy activity Hive Server source.

HttpDataset

A file in an HTTP web server.

HttpLinkedService

Linked service for an HTTP source.

HttpReadSettings

Http read settings.

HttpServerLocation

The location of http server.

HttpSource

A copy activity source for an HTTP file.

HubspotLinkedService

Hubspot Service linked service.

HubspotObjectDataset

Hubspot Service dataset.

HubspotSource

A copy activity Hubspot Service source.

IfConditionActivity

This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.

ImpalaLinkedService

Impala server linked service.

ImpalaObjectDataset

Impala server dataset.

ImpalaSource

A copy activity Impala server source.

ImportSettings

Import command settings. Please note ImportSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SnowflakeImportCopyCommand and AzureDatabricksDeltaLakeImportCommand.

InformixLinkedService

Informix linked service.

InformixSink

A copy activity Informix sink.

InformixSource

A copy activity source for Informix.

InformixTableDataset

The Informix table dataset.

IntegrationRuntime

Azure Synapse nested object which serves as a compute resource for activities. Please note IntegrationRuntime is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ManagedIntegrationRuntime and SelfHostedIntegrationRuntime.

IntegrationRuntimeComputeProperties

The compute resource properties for managed integration runtime.

IntegrationRuntimeCustomSetupScriptProperties

Custom setup script properties for a managed dedicated integration runtime.

IntegrationRuntimeDataFlowProperties

Data flow properties for managed integration runtime.

IntegrationRuntimeDataProxyProperties

Data proxy properties for a managed dedicated integration runtime.

IntegrationRuntimeDebugResource

Integration runtime debug resource.

IntegrationRuntimeListResponse

A list of integration runtime resources.

IntegrationRuntimeReference

Integration runtime reference type.

IntegrationRuntimeResource

Integration runtime resource type.

IntegrationRuntimeSsisCatalogInfo

Catalog information for managed dedicated integration runtime.

IntegrationRuntimeSsisProperties

SSIS properties for managed integration runtime.

IntegrationRuntimeVNetProperties

VNet properties for managed integration runtime.

JiraLinkedService

Jira Service linked service.

JiraObjectDataset

Jira Service dataset.

JiraSource

A copy activity Jira Service source.

JsonDataset

Json dataset.

JsonFormat

The data stored in JSON format.

JsonReadSettings

Json read settings.

JsonSink

A copy activity Json sink.

JsonSource

A copy activity Json source.

JsonWriteSettings

Json write settings.

KqlScript

The KqlScript.

KqlScriptContent

The KqlScriptContent.

KqlScriptContentCurrentConnection

The KqlScriptContentCurrentConnection.

KqlScriptContentMetadata

The KqlScriptContentMetadata.

KqlScriptResource

The KqlScriptResource.

LibraryInfo

Library/package information of a Big Data pool powered by Apache Spark.

LibraryRequirements

Library requirements for a Big Data pool powered by Apache Spark.

LibraryResource

Library response details.

LibraryResourceInfo

Library resource info.

LibraryResourceProperties

Library/package properties.

LinkConnection

The LinkConnection.

LinkConnectionCompute

The LinkConnectionCompute.

LinkConnectionDetailedStatus

The LinkConnectionDetailedStatus.

LinkConnectionLandingZone

The LinkConnectionLandingZone.

LinkConnectionQueryTableStatus

The LinkConnectionQueryTableStatus.

LinkConnectionRefreshStatus

The LinkConnectionRefreshStatus.

LinkConnectionResource

The LinkConnectionResource.

LinkConnectionSourceDatabase

The LinkConnectionSourceDatabase.

LinkConnectionSourceDatabaseTypeProperties

The LinkConnectionSourceDatabaseTypeProperties.

LinkConnectionTargetDatabase

The LinkConnectionTargetDatabase.

LinkConnectionTargetDatabaseTypeProperties

The LinkConnectionTargetDatabaseTypeProperties.

LinkedIntegrationRuntimeKeyAuthorization

The key authorization type integration runtime.

LinkedIntegrationRuntimeRbacAuthorization

The role based access control (RBAC) authorization type integration runtime.

LinkedIntegrationRuntimeType

The base definition of a linked integration runtime. Please note LinkedIntegrationRuntimeType is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include LinkedIntegrationRuntimeKeyAuthorization and LinkedIntegrationRuntimeRbacAuthorization.

LinkedService

The Azure Synapse nested object which contains the information and credential which can be used to connect with related store or compute resource. Please note LinkedService is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmazonMWSLinkedService, AmazonRdsForOracleLinkedService, AmazonRdsForSqlServerLinkedService, AmazonRedshiftLinkedService, AmazonS3LinkedService, AppFiguresLinkedService, AsanaLinkedService, AzureBatchLinkedService, AzureBlobFSLinkedService, AzureBlobStorageLinkedService, AzureDataExplorerLinkedService, AzureDataLakeAnalyticsLinkedService, AzureDataLakeStoreLinkedService, AzureDatabricksLinkedService, AzureDatabricksDeltaLakeLinkedService, AzureFileStorageLinkedService, AzureFunctionLinkedService, AzureKeyVaultLinkedService, AzureMLLinkedService, AzureMLServiceLinkedService, AzureMariaDBLinkedService, AzureMySqlLinkedService, AzurePostgreSqlLinkedService, AzureSearchLinkedService, AzureSqlDWLinkedService, AzureSqlDatabaseLinkedService, AzureSqlMILinkedService, AzureStorageLinkedService, AzureSynapseArtifactsLinkedService, AzureTableStorageLinkedService, CassandraLinkedService, CommonDataServiceForAppsLinkedService, ConcurLinkedService, CosmosDbLinkedService, CosmosDbMongoDbApiLinkedService, CouchbaseLinkedService, CustomDataSourceLinkedService, DataworldLinkedService, Db2LinkedService, DrillLinkedService, DynamicsLinkedService, DynamicsAXLinkedService, DynamicsCrmLinkedService, EloquaLinkedService, FileServerLinkedService, FtpServerLinkedService, GoogleAdWordsLinkedService, GoogleBigQueryLinkedService, GoogleCloudStorageLinkedService, GoogleSheetsLinkedService, GreenplumLinkedService, HBaseLinkedService, HDInsightLinkedService, HDInsightOnDemandLinkedService, HdfsLinkedService, HiveLinkedService, HttpLinkedService, HubspotLinkedService, ImpalaLinkedService, InformixLinkedService, JiraLinkedService, MagentoLinkedService, MariaDBLinkedService, MarketoLinkedService, MicrosoftAccessLinkedService, MongoDbLinkedService, MongoDbAtlasLinkedService, MongoDbV2LinkedService, MySqlLinkedService, NetezzaLinkedService, ODataLinkedService, OdbcLinkedService, Office365LinkedService, OracleLinkedService, OracleServiceCloudLinkedService, PaypalLinkedService, PhoenixLinkedService, PostgreSqlLinkedService, PowerBIWorkspaceLinkedService, PrestoLinkedService, QuickBooksLinkedService, QuickbaseLinkedService, ResponsysLinkedService, RestServiceLinkedService, SalesforceLinkedService, SalesforceMarketingCloudLinkedService, SalesforceServiceCloudLinkedService, SapBWLinkedService, SapCloudForCustomerLinkedService, SapEccLinkedService, SapHanaLinkedService, SapOdpLinkedService, SapOpenHubLinkedService, SapTableLinkedService, ServiceNowLinkedService, SftpServerLinkedService, SharePointOnlineListLinkedService, ShopifyLinkedService, SmartsheetLinkedService, SnowflakeLinkedService, SparkLinkedService, SqlServerLinkedService, SquareLinkedService, SybaseLinkedService, TeamDeskLinkedService, TeradataLinkedService, TwilioLinkedService, VerticaLinkedService, WebLinkedService, XeroLinkedService, ZendeskLinkedService and ZohoLinkedService.

LinkedServiceDebugResource

Linked service debug resource.

LinkedServiceReference

Linked service reference type.

LinkedServiceResource

Linked service resource type.

LinkTableListResponse

The LinkTableListResponse.

LinkTableRequest

The LinkTableRequest.

LinkTableRequestSource

The LinkTableRequestSource.

LinkTableRequestTarget

The LinkTableRequestTarget.

LinkTableRequestTargetDistributionOptions

The LinkTableRequestTargetDistributionOptions.

LinkTableRequestTargetStructureOptions

The LinkTableRequestTargetStructureOptions.

LinkTableResource

The LinkTableResource.

LinkTableStatus

The LinkTableStatus.

LogLocationSettings

Log location settings.

LogSettings

Log settings.

LogStorageSettings

(Deprecated. Please use LogSettings) Log storage settings.

LookupActivity

Lookup activity.

MagentoLinkedService

Magento server linked service.

MagentoObjectDataset

Magento server dataset.

MagentoSource

A copy activity Magento server source.

ManagedIdentity

The workspace managed identity.

ManagedIntegrationRuntime

Managed integration runtime, including managed elastic and managed dedicated integration runtimes.

ManagedVirtualNetworkReference

Managed Virtual Network reference type.

ManagedVirtualNetworkSettings

Managed Virtual Network Settings.

MappingDataFlow

Mapping data flow.

MariaDBLinkedService

MariaDB server linked service.

MariaDBSource

A copy activity MariaDB server source.

MariaDBTableDataset

MariaDB server dataset.

MarketoLinkedService

Marketo server linked service.

MarketoObjectDataset

Marketo server dataset.

MarketoSource

A copy activity Marketo server source.

MetastoreRegisterObject

The MetastoreRegisterObject.

MetastoreRegistrationResponse

The MetastoreRegistrationResponse.

MetastoreRequestSuccessResponse

The MetastoreRequestSuccessResponse.

MetastoreUpdateObject

The MetastoreUpdateObject.

MetastoreUpdationResponse

The MetastoreUpdationResponse.

MicrosoftAccessLinkedService

Microsoft Access linked service.

MicrosoftAccessSink

A copy activity Microsoft Access sink.

MicrosoftAccessSource

A copy activity source for Microsoft Access.

MicrosoftAccessTableDataset

The Microsoft Access table dataset.

MongoDbAtlasCollectionDataset

The MongoDB Atlas database dataset.

MongoDbAtlasLinkedService

Linked service for MongoDB Atlas data source.

MongoDbAtlasSource

A copy activity source for a MongoDB Atlas database.

MongoDbCollectionDataset

The MongoDB database dataset.

MongoDbCursorMethodsProperties

Cursor methods for Mongodb query.

MongoDbLinkedService

Linked service for MongoDb data source.

MongoDbSource

A copy activity source for a MongoDB database.

MongoDbV2CollectionDataset

The MongoDB database dataset.

MongoDbV2LinkedService

Linked service for MongoDB data source.

MongoDbV2Source

A copy activity source for a MongoDB database.

MultiplePipelineTrigger

Base class for all triggers that support one to many model for trigger to pipeline. Please note MultiplePipelineTrigger is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BlobEventsTrigger, BlobTrigger, CustomEventsTrigger and ScheduleTrigger.

MySqlLinkedService

Linked service for MySQL data source.

MySqlSource

A copy activity source for MySQL databases.

MySqlTableDataset

The MySQL table dataset.

NetezzaLinkedService

Netezza linked service.

NetezzaPartitionSettings

The settings that will be leveraged for Netezza source partitioning.

NetezzaSource

A copy activity Netezza source.

NetezzaTableDataset

Netezza dataset.

Notebook

Notebook.

NotebookCell

Notebook cell.

NotebookCellOutputItem

An item of the notebook cell execution output.

NotebookFolder

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

NotebookKernelSpec

Kernel information.

NotebookLanguageInfo

Language info.

NotebookMetadata

Notebook root-level metadata.

NotebookParameter

Notebook parameter.

NotebookResource

Notebook resource type.

NotebookSessionProperties

Session properties.

ODataLinkedService

Open Data Protocol (OData) linked service.

ODataResourceDataset

The Open Data Protocol (OData) resource dataset.

ODataSource

A copy activity source for OData source.

OdbcLinkedService

Open Database Connectivity (ODBC) linked service.

OdbcSink

A copy activity ODBC sink.

OdbcSource

A copy activity source for ODBC databases.

OdbcTableDataset

The ODBC table dataset.

Office365Dataset

The Office365 account.

Office365LinkedService

Office365 linked service.

Office365Source

A copy activity source for an Office 365 service.

OperationResult

Operation status for the operation.

OracleLinkedService

Oracle database.

OraclePartitionSettings

The settings that will be leveraged for Oracle source partitioning.

OracleServiceCloudLinkedService

Oracle Service Cloud linked service.

OracleServiceCloudObjectDataset

Oracle Service Cloud dataset.

OracleServiceCloudSource

A copy activity Oracle Service Cloud source.

OracleSink

A copy activity Oracle sink.

OracleSource

A copy activity Oracle source.

OracleTableDataset

The on-premises Oracle database dataset.

OrcDataset

ORC dataset.

OrcFormat

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

OrcSink

A copy activity ORC sink.

OrcSource

A copy activity ORC source.

OrcWriteSettings

Orc write settings.

ParameterSpecification

Definition of a single parameter for an entity.

ParquetDataset

Parquet dataset.

ParquetFormat

The data stored in Parquet format.

ParquetSink

A copy activity Parquet sink.

ParquetSource

A copy activity Parquet source.

ParquetWriteSettings

Parquet write settings.

PaypalLinkedService

Paypal Service linked service.

PaypalObjectDataset

Paypal Service dataset.

PaypalSource

A copy activity Paypal Service source.

PhoenixLinkedService

Phoenix server linked service.

PhoenixObjectDataset

Phoenix server dataset.

PhoenixSource

A copy activity Phoenix server source.

PipelineFolder

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

PipelineReference

Pipeline reference type.

PipelineResource

Pipeline resource type.

PipelineRun

Information about a pipeline run.

PipelineRunInvokedBy

Provides entity name and id that started the pipeline run.

PipelineRunsQueryResponse

A list pipeline runs.

PolybaseSettings

PolyBase settings.

PostgreSqlLinkedService

Linked service for PostgreSQL data source.

PostgreSqlSource

A copy activity source for PostgreSQL databases.

PostgreSqlTableDataset

The PostgreSQL table dataset.

PowerBIWorkspaceLinkedService

Power BI Workspace linked service.

PrestoLinkedService

Presto server linked service.

PrestoObjectDataset

Presto server dataset.

PrestoSource

A copy activity Presto server source.

PrivateEndpoint

Private endpoint details.

PrivateEndpointConnection

A private endpoint connection.

PrivateLinkServiceConnectionState

Connection state details of the private endpoint.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

PurviewConfiguration

Purview Configuration.

QueryTableStatusRequest

The QueryTableStatusRequest.

QuickbaseLinkedService

Linked service for Quickbase.

QuickBooksLinkedService

QuickBooks server linked service.

QuickBooksObjectDataset

QuickBooks server dataset.

QuickBooksSource

A copy activity QuickBooks server source.

RecurrenceSchedule

The recurrence schedule.

RecurrenceScheduleOccurrence

The recurrence schedule occurrence.

RedirectIncompatibleRowSettings

Redirect incompatible row settings.

RedshiftUnloadSettings

The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.

RelationalSource

A copy activity source for various relational databases.

RelationalTableDataset

The relational table dataset.

RerunTriggerListResponse

A list of rerun triggers.

RerunTriggerResource

RerunTrigger resource type.

RerunTumblingWindowTrigger

Trigger that schedules pipeline reruns for all fixed time interval windows from a requested start time to requested end time.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources.

ResponsysLinkedService

Responsys linked service.

ResponsysObjectDataset

Responsys dataset.

ResponsysSource

A copy activity Responsys source.

RestResourceDataset

A Rest service dataset.

RestServiceLinkedService

Rest Service linked service.

RestSink

A copy activity Rest service Sink.

RestSource

A copy activity Rest service source.

RetryPolicy

Execution policy for an activity.

RunFilterParameters

Query parameters for listing runs.

RunNotebookError

Run notebook error.

RunNotebookParameter

Run notebook parameter.

RunNotebookRequest

Run notebook request.

RunNotebookResponse

Run notebook response.

RunNotebookResult

Result of run notebook.

RunNotebookSnapshot

Run notebook snapshot.

RunNotebookSnapshotResponse

Run notebook snapshot response.

RunNotebookSnapshotResult

Run notebook snapshot result.

RunNotebookSparkSessionOptions

The RunNotebookSparkSessionOptions.

RunQueryFilter

Query filter option for listing runs.

RunQueryOrderBy

An object to provide order by options for listing runs.

SalesforceLinkedService

Linked service for Salesforce.

SalesforceMarketingCloudLinkedService

Salesforce Marketing Cloud linked service.

SalesforceMarketingCloudObjectDataset

Salesforce Marketing Cloud dataset.

SalesforceMarketingCloudSource

A copy activity Salesforce Marketing Cloud source.

SalesforceObjectDataset

The Salesforce object dataset.

SalesforceServiceCloudLinkedService

Linked service for Salesforce Service Cloud.

SalesforceServiceCloudObjectDataset

The Salesforce Service Cloud object dataset.

SalesforceServiceCloudSink

A copy activity Salesforce Service Cloud sink.

SalesforceServiceCloudSource

A copy activity Salesforce Service Cloud source.

SalesforceSink

A copy activity Salesforce sink.

SalesforceSource

A copy activity Salesforce source.

SapBwCubeDataset

The SAP BW cube dataset.

SapBWLinkedService

SAP Business Warehouse Linked Service.

SapBwSource

A copy activity source for SapBW server via MDX.

SapCloudForCustomerLinkedService

Linked service for SAP Cloud for Customer.

SapCloudForCustomerResourceDataset

The path of the SAP Cloud for Customer OData entity.

SapCloudForCustomerSink

A copy activity SAP Cloud for Customer sink.

SapCloudForCustomerSource

A copy activity source for SAP Cloud for Customer source.

SapEccLinkedService

Linked service for SAP ERP Central Component(SAP ECC).

SapEccResourceDataset

The path of the SAP ECC OData entity.

SapEccSource

A copy activity source for SAP ECC source.

SapHanaLinkedService

SAP HANA Linked Service.

SapHanaPartitionSettings

The settings that will be leveraged for SAP HANA source partitioning.

SapHanaSource

A copy activity source for SAP HANA source.

SapHanaTableDataset

SAP HANA Table properties.

SapOdpLinkedService

SAP ODP Linked Service.

SapOdpResourceDataset

SAP ODP Resource properties.

SapOdpSource

A copy activity source for SAP ODP source.

SapOpenHubLinkedService

SAP Business Warehouse Open Hub Destination Linked Service.

SapOpenHubSource

A copy activity source for SAP Business Warehouse Open Hub Destination source.

SapOpenHubTableDataset

Sap Business Warehouse Open Hub Destination Table properties.

SapTableLinkedService

SAP Table Linked Service.

SapTablePartitionSettings

The settings that will be leveraged for SAP table source partitioning.

SapTableResourceDataset

SAP Table Resource properties.

SapTableSource

A copy activity source for SAP Table source.

ScheduleTrigger

Trigger that creates pipeline runs periodically, on schedule.

ScheduleTriggerRecurrence

The workflow trigger recurrence.

ScriptAction

Custom script action to run on HDI ondemand cluster once it's up.

ScriptActivity

Script activity type.

ScriptActivityParameter

Parameters of a script block.

ScriptActivityScriptBlock

Script block of scripts.

ScriptActivityTypePropertiesLogSettings

Log settings of script activity.

SecretBase

The base definition of a secret type. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

SecureInputOutputPolicy

Execution policy for an activity that supports secure input and output.

SecureString

Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.

SelfDependencyTumblingWindowTriggerReference

Self referenced tumbling window trigger dependency.

SelfHostedIntegrationRuntime

Self-hosted integration runtime.

ServiceNowLinkedService

ServiceNow server linked service.

ServiceNowObjectDataset

ServiceNow server dataset.

ServiceNowSource

A copy activity ServiceNow server source.

SetVariableActivity

Set value for a Variable.

SftpLocation

The location of SFTP dataset.

SftpReadSettings

Sftp read settings.

SftpServerLinkedService

A linked service for an SSH File Transfer Protocol (SFTP) server.

SftpWriteSettings

Sftp write settings.

SharePointOnlineListLinkedService

SharePoint Online List linked service.

SharePointOnlineListResourceDataset

The sharepoint online list resource dataset.

SharePointOnlineListSource

A copy activity source for sharePoint online list source.

ShopifyLinkedService

Shopify Service linked service.

ShopifyObjectDataset

Shopify Service dataset.

ShopifySource

A copy activity Shopify Service source.

SkipErrorFile

Skip error file.

Sku

SQL pool SKU.

SmartsheetLinkedService

Linked service for Smartsheet.

SnowflakeDataset

The snowflake dataset.

SnowflakeExportCopyCommand

Snowflake export command settings.

SnowflakeImportCopyCommand

Snowflake import command settings.

SnowflakeLinkedService

Snowflake linked service.

SnowflakeSink

A copy activity snowflake sink.

SnowflakeSource

A copy activity snowflake source.

SparkBatchJob

The SparkBatchJob.

SparkBatchJobState

The SparkBatchJobState.

SparkConfiguration

SparkConfiguration Artifact information.

SparkConfigurationParametrizationReference

Spark configuration reference.

SparkConfigurationReference

Spark configuration reference.

SparkConfigurationResource

Spark Configuration resource type.

SparkJobDefinition

Spark job definition.

SparkJobDefinitionFolder

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

SparkJobDefinitionResource

Spark job definition resource type.

SparkJobProperties

The properties of the Spark job.

SparkLinkedService

Spark Server linked service.

SparkObjectDataset

Spark Server dataset.

SparkRequest

The SparkRequest.

SparkScheduler

The SparkScheduler.

SparkServiceError

The SparkServiceError.

SparkServicePlugin

The SparkServicePlugin.

SparkSource

A copy activity Spark Server source.

SqlAlwaysEncryptedProperties

Sql always encrypted properties.

SqlConnection

The connection used to execute the SQL script.

SqlDWSink

A copy activity SQL Data Warehouse sink.

SqlDWSource

A copy activity SQL Data Warehouse source.

SqlMISink

A copy activity Azure SQL Managed Instance sink.

SqlMISource

A copy activity Azure SQL Managed Instance source.

SqlPartitionSettings

The settings that will be leveraged for Sql source partitioning.

SqlPool

A SQL Analytics pool.

SqlPoolInfoListResult

List of SQL pools.

SqlPoolReference

SQL pool reference type.

SqlPoolStoredProcedureActivity

Execute SQL pool stored procedure activity.

SqlScript

SQL script.

SqlScriptContent

The content of the SQL script.

SqlScriptFolder

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

SqlScriptMetadata

The metadata of the SQL script.

SqlScriptResource

Sql Script resource type.

SqlServerLinkedService

SQL Server linked service.

SqlServerSink

A copy activity SQL server sink.

SqlServerSource

A copy activity SQL server source.

SqlServerStoredProcedureActivity

SQL stored procedure activity type.

SqlServerTableDataset

The on-premises SQL Server dataset.

SqlSink

A copy activity SQL sink.

SqlSource

A copy activity SQL source.

SquareLinkedService

Square Service linked service.

SquareObjectDataset

Square Service dataset.

SquareSource

A copy activity Square Service source.

SsisAccessCredential

SSIS access credential.

SsisChildPackage

SSIS embedded child package.

SsisExecutionCredential

SSIS package execution credential.

SsisExecutionParameter

SSIS execution parameter.

SsisLogLocation

SSIS package execution log location.

SsisObjectMetadataStatusResponse

The status of the operation.

SsisPackageLocation

SSIS package location.

SsisPropertyOverride

SSIS property override.

StagingSettings

Staging settings.

StartDataFlowDebugSessionRequest

Request body structure for starting data flow debug session.

StartDataFlowDebugSessionResponse

Response body structure for starting data flow debug session.

StoreReadSettings

Connector read setting. Please note StoreReadSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmazonS3ReadSettings, AzureBlobFSReadSettings, AzureBlobStorageReadSettings, AzureDataLakeStoreReadSettings, AzureFileStorageReadSettings, FileServerReadSettings, FtpReadSettings, GoogleCloudStorageReadSettings, HdfsReadSettings, HttpReadSettings and SftpReadSettings.

StoreWriteSettings

Connector write settings. Please note StoreWriteSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureBlobFSWriteSettings, AzureBlobStorageWriteSettings, AzureDataLakeStoreWriteSettings, AzureFileStorageWriteSettings, FileServerWriteSettings and SftpWriteSettings.

SubResource

Azure Synapse nested resource, which belongs to a workspace.

SubResourceDebugResource

Azure Synapse nested debug resource.

SwitchActivity

This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.

SwitchCase

Switch cases with have a value and corresponding activities.

SybaseLinkedService

Linked service for Sybase data source.

SybaseSource

A copy activity source for Sybase databases.

SybaseTableDataset

The Sybase table dataset.

SynapseNotebookActivity

Execute Synapse notebook activity.

SynapseNotebookReference

Synapse notebook reference type.

SynapseSparkJobDefinitionActivity

Execute spark job activity.

SynapseSparkJobReference

Synapse spark job reference type.

TabularSource

Copy activity sources of tabular type. Please note TabularSource is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmazonMWSSource, AmazonRdsForSqlServerSource, AmazonRedshiftSource, AzureMariaDBSource, AzureMySqlSource, AzurePostgreSqlSource, AzureSqlSource, AzureTableSource, CassandraSource, ConcurSource, CouchbaseSource, Db2Source, DrillSource, DynamicsAXSource, EloquaSource, GoogleAdWordsSource, GoogleBigQuerySource, GreenplumSource, HBaseSource, HiveSource, HubspotSource, ImpalaSource, InformixSource, JiraSource, MagentoSource, MariaDBSource, MarketoSource, MySqlSource, NetezzaSource, OdbcSource, OracleServiceCloudSource, PaypalSource, PhoenixSource, PostgreSqlSource, PrestoSource, QuickBooksSource, ResponsysSource, SalesforceMarketingCloudSource, SalesforceSource, SapBwSource, SapCloudForCustomerSource, SapEccSource, SapHanaSource, SapOdpSource, SapOpenHubSource, SapTableSource, ServiceNowSource, ShopifySource, SparkSource, SqlDWSource, SqlMISource, SqlServerSource, SqlSource, SquareSource, SybaseSource, TeradataSource, VerticaSource, XeroSource and ZohoSource.

TabularTranslator

A copy activity tabular translator.

TarGZipReadSettings

The TarGZip compression read settings.

TarReadSettings

The Tar compression read settings.

TeamDeskLinkedService

Linked service for TeamDesk.

TeradataLinkedService

Linked service for Teradata data source.

TeradataPartitionSettings

The settings that will be leveraged for teradata source partitioning.

TeradataSource

A copy activity Teradata source.

TeradataTableDataset

The Teradata database dataset.

TextFormat

The data stored in text format.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'.

Transformation

A data flow transformation.

Trigger

Azure Synapse nested object which contains information about creating pipeline run Please note Trigger is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BlobEventsTrigger, BlobTrigger, ChainingTrigger, CustomEventsTrigger, MultiplePipelineTrigger, RerunTumblingWindowTrigger, ScheduleTrigger and TumblingWindowTrigger.

TriggerDependencyProvisioningStatus

Defines the response of a provision trigger dependency operation.

TriggerDependencyReference

Trigger referenced dependency. Please note TriggerDependencyReference is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include TumblingWindowTriggerDependencyReference.

TriggerPipelineReference

Pipeline that needs to be triggered with the given parameters.

TriggerReference

Trigger reference type.

TriggerResource

Trigger resource type.

TriggerRun

Trigger runs.

TriggerRunsQueryResponse

A list of trigger runs.

TriggerSubscriptionOperationStatus

Defines the response of a trigger subscription operation.

TumblingWindowTrigger

Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).

TumblingWindowTriggerDependencyReference

Referenced tumbling window trigger dependency.

TwilioLinkedService

Linked service for Twilio.

TypeConversionSettings

Type conversion settings.

UntilActivity

This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.

UpdateLandingZoneCredential

The UpdateLandingZoneCredential.

UserProperty

User property.

ValidationActivity

This activity verifies that an external resource exists.

VariableSpecification

Definition of a single variable for a Pipeline.

VerticaLinkedService

Vertica linked service.

VerticaSource

A copy activity Vertica source.

VerticaTableDataset

Vertica dataset.

VirtualNetworkProfile

Virtual Network Profile.

WaitActivity

This activity suspends pipeline execution for the specified interval.

WebActivity

Web activity.

WebActivityAuthentication

Web activity authentication properties.

WebAnonymousAuthentication

A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.

WebBasicAuthentication

A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.

WebClientCertificateAuthentication

A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.

WebHookActivity

WebHook activity.

WebLinkedService

Web linked service.

WebLinkedServiceTypeProperties

Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models. Please note WebLinkedServiceTypeProperties is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WebAnonymousAuthentication, WebBasicAuthentication and WebClientCertificateAuthentication.

WebSource

A copy activity source for web page table.

WebTableDataset

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

Workspace

A workspace.

WorkspaceIdentity

Identity properties of the workspace resource.

WorkspaceKeyDetails

Details of the customer managed key associated with the workspace.

WorkspaceRepositoryConfiguration

Git integration settings.

WorkspaceUpdateParameters

Parameters for updating a workspace resource.

XeroLinkedService

Xero Service linked service.

XeroObjectDataset

Xero Service dataset.

XeroSource

A copy activity Xero Service source.

XmlDataset

Xml dataset.

XmlReadSettings

Xml read settings.

XmlSource

A copy activity Xml source.

ZendeskLinkedService

Linked service for Zendesk.

ZipDeflateReadSettings

The ZipDeflate compression read settings.

ZohoLinkedService

Zoho server linked service.

ZohoObjectDataset

Zoho server dataset.

ZohoSource

A copy activity Zoho server source.

Structs

ActionOnExistingTargetTable

Action on existing target table. If not specified, 'FailOnNonEmptyTable' action is used.

ActivityOnInactiveMarkAs

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

ActivityState

Activity state. This is an optional property and if not provided, the state will be Active by default.

AzureFunctionActivityMethod

The list of HTTP methods supported by a AzureFunctionActivity.

AzureSearchIndexWriteBehaviorType

Specify the write behavior when upserting documents into Azure Search Index.

AzureStorageAuthenticationType

The type used for authentication. Type: string.

BigDataPoolReferenceType

Big data pool reference type.

BlobEventType

The BlobEventType.

CassandraSourceReadConsistencyLevels

The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive.

CellOutputType

Execution, display, or stream outputs.

ConfigurationType

The type of the spark config.

CreateMode

Specifies the mode of sql pool creation.

Default: regular sql pool creation.

PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

CredentialReferenceType

Credential reference type.

DataFlowComputeType

Compute type of the cluster which will execute data flow job.

DataFlowDebugCommandType

The command type.

DataFlowReferenceType

Data flow reference type.

DatasetReferenceType

Dataset reference type.

Db2AuthenticationType

AuthenticationType to be used for connection. It is mutually exclusive with connectionString property.

DependencyCondition

The DependencyCondition.

DynamicsSinkWriteBehavior

Defines values for DynamicsSinkWriteBehavior.

EventSubscriptionStatus

Event Subscription Status.

ExpressionType

Expression type.

FtpAuthenticationType

The authentication type to be used to connect to the FTP server.

GoogleAdWordsAuthenticationType

The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.

GoogleBigQueryAuthenticationType

The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.

HBaseAuthenticationType

The authentication mechanism to use to connect to the HBase server.

HDInsightActivityDebugInfoOption

The HDInsightActivityDebugInfoOption settings to use.

HiveAuthenticationType

The authentication method used to access the Hive server.

HiveServerType

The type of Hive server.

HiveThriftTransportProtocol

The transport protocol to use in the Thrift layer.

HttpAuthenticationType

The authentication type to be used to connect to the HTTP server.

ImpalaAuthenticationType

The authentication type to use.

IntegrationRuntimeEdition

The edition for the SSIS Integration Runtime.

IntegrationRuntimeEntityReferenceType

The type of this referenced entity.

IntegrationRuntimeLicenseType

License type for bringing your own license scenario.

IntegrationRuntimeReferenceType

Type of integration runtime.

IntegrationRuntimeSsisCatalogPricingTier

The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/.

IntegrationRuntimeState

The state of integration runtime.

IntegrationRuntimeType

The type of integration runtime.

LivyStates

The batch state.

ManagedVirtualNetworkReferenceType

Managed Virtual Network reference type.

MongoDbAuthenticationType

The authentication type to be used to connect to the MongoDB database.

NetezzaPartitionOption

The partition mechanism that will be used for Netezza read in parallel.

NodeSize

The level of compute power that each node in the Big Data pool has.

NodeSizeFamily

The kind of nodes that the Big Data pool provides.

NotebookParameterType

Notebook parameter type.

NotebookReferenceType

Synapse notebook reference type.

ODataAadServicePrincipalCredentialType

Specify the credential type (key or cert) is used for service principal.

ODataAuthenticationType

Type of authentication used to connect to the OData service.

OraclePartitionOption

The partition mechanism that will be used for Oracle read in parallel.

ParameterType

Parameter type.

PhoenixAuthenticationType

The authentication mechanism used to connect to the Phoenix server.

PipelineReferenceType

Pipeline reference type.

PluginCurrentState

The PluginCurrentState.

PolybaseSettingsRejectType

Indicates whether the RejectValue property is specified as a literal value or a percentage.

PrestoAuthenticationType

The authentication mechanism used to connect to the Presto server.

RecurrenceFrequency

Enumerates possible frequency option for the schedule trigger.

RequestStatus

Enumerates possible request statuses.

ResourceStatus

Enumerates possible Status of the resource.

RestServiceAuthenticationType

Type of authentication used to connect to the REST service.

RunQueryFilterOperand

Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.

RunQueryFilterOperator

Operator to be used for filter.

RunQueryOrder

Sorting order of the parameter.

RunQueryOrderByField

Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.

SalesforceSinkWriteBehavior

The write behavior for the operation. Default is Insert.

SapCloudForCustomerSinkWriteBehavior

The write behavior for the operation. Default is 'Insert'.

SapHanaAuthenticationType

The authentication type to be used to connect to the SAP HANA server.

SchedulerCurrentState

The SchedulerCurrentState.

ScriptActivityLogDestination

The destination of logs. Type: string.

ScriptActivityParameterDirection

The direction of the parameter.

ScriptActivityParameterType

The type of the parameter.

ScriptType

The type of the query. Type: string.

ServiceNowAuthenticationType

The authentication type to use.

SftpAuthenticationType

The authentication type to be used to connect to the FTP server.

SparkAuthenticationType

The authentication method used to access the Spark server.

SparkBatchJobResultType

The Spark batch job result.

SparkConfigurationReferenceType

Spark configuration reference type.

SparkErrorSource

The SparkErrorSource.

SparkJobReferenceType

Synapse spark job reference type.

SparkJobType

The job type.

SparkServerType

The type of Spark server.

SparkThriftTransportProtocol

The transport protocol to use in the Thrift layer.

SqlAlwaysEncryptedAkvAuthType

Sql always encrypted AKV authentication type. Type: string.

SqlConnectionType

The type of the connection.

SqlPoolReferenceType

SQL pool reference type.

SqlScriptType

The type of the SQL script.

SsisLogLocationType

The type of SSIS log location.

SsisPackageLocationType

The type of SSIS package location.

SybaseAuthenticationType

AuthenticationType to be used for connection.

TeamDeskAuthenticationType

The authentication type to use.

TeradataAuthenticationType

AuthenticationType to be used for connection.

TeradataPartitionOption

The partition mechanism that will be used for teradata read in parallel.

TriggerReferenceType

Trigger reference type.

TriggerRunStatus

Trigger run status.

TriggerRuntimeState

Enumerates possible state of Triggers.

TumblingWindowFrequency

Enumerates possible frequency option for the tumbling window trigger.

VariableType

Variable type.

WebActivityMethod

The list of HTTP methods supported by a WebActivity.

WebAuthenticationType

Type of authentication used to connect to the web table source.

WebHookActivityMethod

The list of HTTP methods supported by a WebHook activity.

WorkspaceIdentityType

The identity type. Currently the only supported type is 'SystemAssigned'.

ZendeskAuthenticationType

The authentication type to use.

Enums

DayOfWeek

The DayOfWeek.

ResourceIdentityType

The type of managed identity for the workspace.