models Package

Classes

Activity

A pipeline activity.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AppendVariableActivity, ControlActivity, ExecutePipelineActivity, ExecutionActivity, FilterActivity, ForEachActivity, IfConditionActivity, SetVariableActivity, SwitchActivity, UntilActivity, ValidationActivity, WaitActivity, WebHookActivity.

All required parameters must be populated in order to send to Azure.

ActivityDependency

Activity dependency information.

All required parameters must be populated in order to send to Azure.

ActivityPolicy

Execution policy for an activity.

ActivityRun

Information about an activity run in a pipeline.

Variables are only populated by the server, and will be ignored when sending a request.

ActivityRunsQueryResponse

A list activity runs.

All required parameters must be populated in order to send to Azure.

AddDataFlowToDebugSessionResponse

Response body structure for starting data flow debug session.

AmazonMWSLinkedService

Amazon Marketplace Web Service linked service.

All required parameters must be populated in order to send to Azure.

AmazonMWSObjectDataset

Amazon Marketplace Web Service dataset.

All required parameters must be populated in order to send to Azure.

AmazonRedshiftLinkedService

Linked service for Amazon Redshift.

All required parameters must be populated in order to send to Azure.

AmazonRedshiftTableDataset

The Amazon Redshift table dataset.

All required parameters must be populated in order to send to Azure.

AmazonS3LinkedService

Linked service for Amazon S3.

All required parameters must be populated in order to send to Azure.

AppendVariableActivity

Append value for a Variable of type Array.

All required parameters must be populated in order to send to Azure.

AvroDataset

Avro dataset.

All required parameters must be populated in order to send to Azure.

AzureBatchLinkedService

Azure Batch linked service.

All required parameters must be populated in order to send to Azure.

AzureBlobFSLinkedService

Azure Data Lake Storage Gen2 linked service.

All required parameters must be populated in order to send to Azure.

AzureBlobStorageLinkedService

The azure blob storage linked service.

All required parameters must be populated in order to send to Azure.

AzureDataExplorerCommandActivity

Azure Data Explorer command activity.

All required parameters must be populated in order to send to Azure.

AzureDataExplorerLinkedService

Azure Data Explorer (Kusto) linked service.

All required parameters must be populated in order to send to Azure.

AzureDataExplorerTableDataset

The Azure Data Explorer (Kusto) dataset.

All required parameters must be populated in order to send to Azure.

AzureDataLakeAnalyticsLinkedService

Azure Data Lake Analytics linked service.

All required parameters must be populated in order to send to Azure.

AzureDataLakeStoreLinkedService

Azure Data Lake Store linked service.

All required parameters must be populated in order to send to Azure.

AzureDatabricksLinkedService

Azure Databricks linked service.

All required parameters must be populated in order to send to Azure.

AzureFileStorageLinkedService

Azure File Storage linked service.

All required parameters must be populated in order to send to Azure.

AzureFunctionActivity

Azure Function activity.

All required parameters must be populated in order to send to Azure.

AzureFunctionLinkedService

Azure Function linked service.

All required parameters must be populated in order to send to Azure.

AzureKeyVaultLinkedService

Azure Key Vault linked service.

All required parameters must be populated in order to send to Azure.

AzureKeyVaultSecretReference

Azure Key Vault secret reference.

All required parameters must be populated in order to send to Azure.

AzureMLBatchExecutionActivity

Azure ML Batch Execution activity.

All required parameters must be populated in order to send to Azure.

AzureMLExecutePipelineActivity

Azure ML Execute Pipeline activity.

All required parameters must be populated in order to send to Azure.

AzureMLLinkedService

Azure ML Studio Web Service linked service.

All required parameters must be populated in order to send to Azure.

AzureMLServiceLinkedService

Azure ML Service linked service.

All required parameters must be populated in order to send to Azure.

AzureMLUpdateResourceActivity

Azure ML Update Resource management activity.

All required parameters must be populated in order to send to Azure.

AzureMLWebServiceFile

Azure ML WebService Input/Output file.

All required parameters must be populated in order to send to Azure.

AzureMariaDBLinkedService

Azure Database for MariaDB linked service.

All required parameters must be populated in order to send to Azure.

AzureMariaDBTableDataset

Azure Database for MariaDB dataset.

All required parameters must be populated in order to send to Azure.

AzureMySqlLinkedService

Azure MySQL database linked service.

All required parameters must be populated in order to send to Azure.

AzureMySqlTableDataset

The Azure MySQL database dataset.

All required parameters must be populated in order to send to Azure.

AzurePostgreSqlLinkedService

Azure PostgreSQL linked service.

All required parameters must be populated in order to send to Azure.

AzurePostgreSqlTableDataset

Azure PostgreSQL dataset.

All required parameters must be populated in order to send to Azure.

AzureSearchIndexDataset

The Azure Search Index.

All required parameters must be populated in order to send to Azure.

AzureSearchLinkedService

Linked service for Windows Azure Search Service.

All required parameters must be populated in order to send to Azure.

AzureSqlDWLinkedService

Azure SQL Data Warehouse linked service.

All required parameters must be populated in order to send to Azure.

AzureSqlDWTableDataset

The Azure SQL Data Warehouse dataset.

All required parameters must be populated in order to send to Azure.

AzureSqlDatabaseLinkedService

Microsoft Azure SQL Database linked service.

All required parameters must be populated in order to send to Azure.

AzureSqlMILinkedService

Azure SQL Managed Instance linked service.

All required parameters must be populated in order to send to Azure.

AzureSqlMITableDataset

The Azure SQL Managed Instance dataset.

All required parameters must be populated in order to send to Azure.

AzureSqlTableDataset

The Azure SQL Server database dataset.

All required parameters must be populated in order to send to Azure.

AzureStorageLinkedService

The storage account linked service.

All required parameters must be populated in order to send to Azure.

AzureTableDataset

The Azure Table storage dataset.

All required parameters must be populated in order to send to Azure.

AzureTableStorageLinkedService

The azure table storage linked service.

All required parameters must be populated in order to send to Azure.

BigDataPoolReference

Big data pool reference.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

BinaryDataset

Binary dataset.

All required parameters must be populated in order to send to Azure.

CassandraLinkedService

Linked service for Cassandra data source.

All required parameters must be populated in order to send to Azure.

CassandraTableDataset

The Cassandra database dataset.

All required parameters must be populated in order to send to Azure.

CloudError

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

All required parameters must be populated in order to send to Azure.

CommonDataServiceForAppsEntityDataset

The Common Data Service for Apps entity dataset.

All required parameters must be populated in order to send to Azure.

CommonDataServiceForAppsLinkedService

Common Data Service for Apps linked service.

All required parameters must be populated in order to send to Azure.

ConcurLinkedService

Concur Service linked service.

All required parameters must be populated in order to send to Azure.

ConcurObjectDataset

Concur Service dataset.

All required parameters must be populated in order to send to Azure.

ControlActivity

Base class for all control activities like IfCondition, ForEach , Until.

All required parameters must be populated in order to send to Azure.

CopyActivity

Copy activity.

All required parameters must be populated in order to send to Azure.

CopySink

A copy activity sink.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: .

All required parameters must be populated in order to send to Azure.

CopySource

A copy activity source.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: .

All required parameters must be populated in order to send to Azure.

CosmosDbLinkedService

Microsoft Azure Cosmos Database (CosmosDB) linked service.

All required parameters must be populated in order to send to Azure.

CosmosDbMongoDbApiCollectionDataset

The CosmosDB (MongoDB API) database dataset.

All required parameters must be populated in order to send to Azure.

CosmosDbMongoDbApiLinkedService

Linked service for CosmosDB (MongoDB API) data source.

All required parameters must be populated in order to send to Azure.

CosmosDbSqlApiCollectionDataset

Microsoft Azure CosmosDB (SQL API) Collection dataset.

All required parameters must be populated in order to send to Azure.

CouchbaseLinkedService

Couchbase server linked service.

All required parameters must be populated in order to send to Azure.

CouchbaseTableDataset

Couchbase server dataset.

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

CustomActivity

Custom activity type.

All required parameters must be populated in order to send to Azure.

CustomActivityReferenceObject

Reference objects for custom activity.

CustomDataSourceLinkedService

Custom linked service.

All required parameters must be populated in order to send to Azure.

DataFlow

Azure Synapse nested object which contains a flow with data movements and transformations.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MappingDataFlow.

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

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.

DataFlowListResponse

A list of data flow resources.

All required parameters must be populated in order to send to Azure.

DataFlowReference

Data flow reference type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataFlowResource

Data flow resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataFlowSink

Transformation for data flow sink.

All required parameters must be populated in order to send to Azure.

DataFlowSource

Transformation for data flow source.

All required parameters must be populated in order to send to Azure.

DataFlowSourceSetting

Definition of data flow source setting for debug.

DataFlowStagingInfo

Staging info for execute data flow activity.

DataLakeAnalyticsUSQLActivity

Data Lake Analytics U-SQL activity.

All required parameters must be populated in order to send to Azure.

DatabricksNotebookActivity

DatabricksNotebook activity.

All required parameters must be populated in order to send to Azure.

DatabricksSparkJarActivity

DatabricksSparkJar activity.

All required parameters must be populated in order to send to Azure.

DatabricksSparkPythonActivity

DatabricksSparkPython activity.

All required parameters must be populated in order to send to Azure.

Dataset

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AmazonMWSObjectDataset, AmazonRedshiftTableDataset, AvroDataset, AzureDataExplorerTableDataset, AzureMariaDBTableDataset, AzureMySqlTableDataset, AzurePostgreSqlTableDataset, AzureSearchIndexDataset, AzureSqlDWTableDataset, AzureSqlMITableDataset, AzureSqlTableDataset, AzureTableDataset, BinaryDataset, CassandraTableDataset, CommonDataServiceForAppsEntityDataset, ConcurObjectDataset, CosmosDbMongoDbApiCollectionDataset, CosmosDbSqlApiCollectionDataset, CouchbaseTableDataset, Db2TableDataset, DelimitedTextDataset, DocumentDbCollectionDataset, DrillTableDataset, DynamicsAXResourceDataset, DynamicsCrmEntityDataset, DynamicsEntityDataset, EloquaObjectDataset, GoogleAdWordsObjectDataset, GoogleBigQueryObjectDataset, GreenplumTableDataset, HBaseObjectDataset, HiveObjectDataset, HubspotObjectDataset, ImpalaObjectDataset, InformixTableDataset, JiraObjectDataset, JsonDataset, MagentoObjectDataset, MariaDBTableDataset, MarketoObjectDataset, MicrosoftAccessTableDataset, 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, SapOpenHubTableDataset, SapTableResourceDataset, ServiceNowObjectDataset, ShopifyObjectDataset, SparkObjectDataset, SqlServerTableDataset, SquareObjectDataset, SybaseTableDataset, TeradataTableDataset, VerticaTableDataset, WebTableDataset, XeroObjectDataset, ZohoObjectDataset.

All required parameters must be populated in order to send to Azure.

DatasetBZip2Compression

The BZip2 compression method used on a dataset.

All required parameters must be populated in order to send to Azure.

DatasetCompression

The compression method used on a dataset.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DatasetBZip2Compression, DatasetDeflateCompression, DatasetGZipCompression, DatasetZipDeflateCompression.

All required parameters must be populated in order to send to Azure.

DatasetDebugResource

Dataset debug resource.

All required parameters must be populated in order to send to Azure.

DatasetDeflateCompression

The Deflate compression method used on a dataset.

All required parameters must be populated in order to send to Azure.

DatasetFolder

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

DatasetGZipCompression

The GZip compression method used on a dataset.

All required parameters must be populated in order to send to Azure.

DatasetListResponse

A list of dataset resources.

All required parameters must be populated in order to send to Azure.

DatasetLocation

Dataset location.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: .

All required parameters must be populated in order to send to Azure.

DatasetReference

Dataset reference type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DatasetResource

Dataset resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DatasetZipDeflateCompression

The ZipDeflate compression method used on a dataset.

All required parameters must be populated in order to send to Azure.

Db2LinkedService

Linked service for DB2 data source.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Db2TableDataset

The Db2 table dataset.

All required parameters must be populated in order to send to Azure.

DeleteActivity

Delete activity.

All required parameters must be populated in order to send to Azure.

DeleteDataFlowDebugSessionRequest

Request body structure for deleting data flow debug session.

DelimitedTextDataset

Delimited text dataset.

All required parameters must be populated in order to send to Azure.

DocumentDbCollectionDataset

Microsoft Azure Document Database Collection dataset.

All required parameters must be populated in order to send to Azure.

DrillLinkedService

Drill server linked service.

All required parameters must be populated in order to send to Azure.

DrillTableDataset

Drill server dataset.

All required parameters must be populated in order to send to Azure.

DynamicsAXLinkedService

Dynamics AX linked service.

All required parameters must be populated in order to send to Azure.

DynamicsAXResourceDataset

The path of the Dynamics AX OData entity.

All required parameters must be populated in order to send to Azure.

DynamicsCrmEntityDataset

The Dynamics CRM entity dataset.

All required parameters must be populated in order to send to Azure.

DynamicsCrmLinkedService

Dynamics CRM linked service.

All required parameters must be populated in order to send to Azure.

DynamicsEntityDataset

The Dynamics entity dataset.

All required parameters must be populated in order to send to Azure.

DynamicsLinkedService

Dynamics linked service.

All required parameters must be populated in order to send to Azure.

EloquaLinkedService

Eloqua server linked service.

All required parameters must be populated in order to send to Azure.

EloquaObjectDataset

Eloqua server dataset.

All required parameters must be populated in order to send to Azure.

EvaluateDataFlowExpressionRequest

Request body structure for data flow expression preview.

ExecuteDataFlowActivity

Execute data flow activity.

All required parameters must be populated in order to send to Azure.

ExecuteDataFlowActivityTypePropertiesCompute

Compute properties for data flow activity.

ExecutePipelineActivity

Execute pipeline activity.

All required parameters must be populated in order to send to Azure.

ExecuteSSISPackageActivity

Execute SSIS package activity.

All required parameters must be populated in order to send to Azure.

ExecutionActivity

Base class for all execution activities.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureDataExplorerCommandActivity, AzureFunctionActivity, AzureMLBatchExecutionActivity, AzureMLExecutePipelineActivity, AzureMLUpdateResourceActivity, CopyActivity, CustomActivity, DataLakeAnalyticsUSQLActivity, DatabricksNotebookActivity, DatabricksSparkJarActivity, DatabricksSparkPythonActivity, DeleteActivity, ExecuteDataFlowActivity, ExecuteSSISPackageActivity, GetMetadataActivity, HDInsightHiveActivity, HDInsightMapReduceActivity, HDInsightPigActivity, HDInsightSparkActivity, HDInsightStreamingActivity, LookupActivity, SqlServerStoredProcedureActivity, WebActivity.

All required parameters must be populated in order to send to Azure.

ExposureControlRequest

The exposure control request.

ExposureControlResponse

The exposure control response.

Variables are only populated by the server, and will be ignored when sending a request.

Expression

Azure Synapse expression definition.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

FileServerLinkedService

File system linked service.

All required parameters must be populated in order to send to Azure.

FilterActivity

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

All required parameters must be populated in order to send to Azure.

ForEachActivity

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

All required parameters must be populated in order to send to Azure.

FtpServerLinkedService

A FTP server Linked Service.

All required parameters must be populated in order to send to Azure.

GetMetadataActivity

Activity to get metadata of dataset.

All required parameters must be populated in order to send to Azure.

GetSsisObjectMetadataRequest

The request payload of get SSIS object metadata.

GoogleAdWordsLinkedService

Google AdWords service linked service.

All required parameters must be populated in order to send to Azure.

GoogleAdWordsObjectDataset

Google AdWords service dataset.

All required parameters must be populated in order to send to Azure.

GoogleBigQueryLinkedService

Google BigQuery service linked service.

All required parameters must be populated in order to send to Azure.

GoogleBigQueryObjectDataset

Google BigQuery service dataset.

All required parameters must be populated in order to send to Azure.

GoogleCloudStorageLinkedService

Linked service for Google Cloud Storage.

All required parameters must be populated in order to send to Azure.

GreenplumLinkedService

Greenplum Database linked service.

All required parameters must be populated in order to send to Azure.

GreenplumTableDataset

Greenplum Database dataset.

All required parameters must be populated in order to send to Azure.

HBaseLinkedService

HBase server linked service.

All required parameters must be populated in order to send to Azure.

HBaseObjectDataset

HBase server dataset.

All required parameters must be populated in order to send to Azure.

HDInsightHiveActivity

HDInsight Hive activity type.

All required parameters must be populated in order to send to Azure.

HDInsightLinkedService

HDInsight linked service.

All required parameters must be populated in order to send to Azure.

HDInsightMapReduceActivity

HDInsight MapReduce activity type.

All required parameters must be populated in order to send to Azure.

HDInsightOnDemandLinkedService

HDInsight ondemand linked service.

All required parameters must be populated in order to send to Azure.

HDInsightPigActivity

HDInsight Pig activity type.

All required parameters must be populated in order to send to Azure.

HDInsightSparkActivity

HDInsight Spark activity.

All required parameters must be populated in order to send to Azure.

HDInsightStreamingActivity

HDInsight streaming activity type.

All required parameters must be populated in order to send to Azure.

HdfsLinkedService

Hadoop Distributed File System (HDFS) linked service.

All required parameters must be populated in order to send to Azure.

HiveLinkedService

Hive Server linked service.

All required parameters must be populated in order to send to Azure.

HiveObjectDataset

Hive Server dataset.

All required parameters must be populated in order to send to Azure.

HttpLinkedService

Linked service for an HTTP source.

All required parameters must be populated in order to send to Azure.

HubspotLinkedService

Hubspot Service linked service.

All required parameters must be populated in order to send to Azure.

HubspotObjectDataset

Hubspot Service dataset.

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

ImpalaLinkedService

Impala server linked service.

All required parameters must be populated in order to send to Azure.

ImpalaObjectDataset

Impala server dataset.

All required parameters must be populated in order to send to Azure.

InformixLinkedService

Informix linked service.

All required parameters must be populated in order to send to Azure.

InformixTableDataset

The Informix table dataset.

All required parameters must be populated in order to send to Azure.

IntegrationRuntimeReference

Integration runtime reference type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

JiraLinkedService

Jira Service linked service.

All required parameters must be populated in order to send to Azure.

JiraObjectDataset

Jira Service dataset.

All required parameters must be populated in order to send to Azure.

JsonDataset

Json dataset.

All required parameters must be populated in order to send to Azure.

LinkedService

The Azure Synapse nested object which contains the information and credential which can be used to connect with related store or compute resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AmazonMWSLinkedService, AmazonRedshiftLinkedService, AmazonS3LinkedService, AzureBatchLinkedService, AzureBlobFSLinkedService, AzureBlobStorageLinkedService, AzureDataExplorerLinkedService, AzureDataLakeAnalyticsLinkedService, AzureDataLakeStoreLinkedService, AzureDatabricksLinkedService, AzureFileStorageLinkedService, AzureFunctionLinkedService, AzureKeyVaultLinkedService, AzureMLLinkedService, AzureMLServiceLinkedService, AzureMariaDBLinkedService, AzureMySqlLinkedService, AzurePostgreSqlLinkedService, AzureSearchLinkedService, AzureSqlDWLinkedService, AzureSqlDatabaseLinkedService, AzureSqlMILinkedService, AzureStorageLinkedService, AzureTableStorageLinkedService, CassandraLinkedService, CommonDataServiceForAppsLinkedService, ConcurLinkedService, CosmosDbLinkedService, CosmosDbMongoDbApiLinkedService, CouchbaseLinkedService, CustomDataSourceLinkedService, Db2LinkedService, DrillLinkedService, DynamicsLinkedService, DynamicsAXLinkedService, DynamicsCrmLinkedService, EloquaLinkedService, FileServerLinkedService, FtpServerLinkedService, GoogleAdWordsLinkedService, GoogleBigQueryLinkedService, GoogleCloudStorageLinkedService, GreenplumLinkedService, HBaseLinkedService, HDInsightLinkedService, HDInsightOnDemandLinkedService, HdfsLinkedService, HiveLinkedService, HttpLinkedService, HubspotLinkedService, ImpalaLinkedService, InformixLinkedService, JiraLinkedService, MagentoLinkedService, MariaDBLinkedService, MarketoLinkedService, MicrosoftAccessLinkedService, MongoDbLinkedService, MongoDbV2LinkedService, MySqlLinkedService, NetezzaLinkedService, ODataLinkedService, OdbcLinkedService, Office365LinkedService, OracleLinkedService, OracleServiceCloudLinkedService, PaypalLinkedService, PhoenixLinkedService, PostgreSqlLinkedService, PrestoLinkedService, QuickBooksLinkedService, ResponsysLinkedService, RestServiceLinkedService, SalesforceLinkedService, SalesforceMarketingCloudLinkedService, SalesforceServiceCloudLinkedService, SapBWLinkedService, SapCloudForCustomerLinkedService, SapEccLinkedService, SapHanaLinkedService, SapOpenHubLinkedService, SapTableLinkedService, ServiceNowLinkedService, SftpServerLinkedService, ShopifyLinkedService, SparkLinkedService, SqlServerLinkedService, SquareLinkedService, SybaseLinkedService, TeradataLinkedService, VerticaLinkedService, WebLinkedService, XeroLinkedService, ZohoLinkedService.

All required parameters must be populated in order to send to Azure.

LinkedServiceDebugResource

Linked service debug resource.

All required parameters must be populated in order to send to Azure.

LinkedServiceListResponse

A list of linked service resources.

All required parameters must be populated in order to send to Azure.

LinkedServiceReference

Linked service reference type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

LinkedServiceResource

Linked service resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

LogStorageSettings

Log storage settings.

All required parameters must be populated in order to send to Azure.

LookupActivity

Lookup activity.

All required parameters must be populated in order to send to Azure.

MagentoLinkedService

Magento server linked service.

All required parameters must be populated in order to send to Azure.

MagentoObjectDataset

Magento server dataset.

All required parameters must be populated in order to send to Azure.

MappingDataFlow

Mapping data flow.

All required parameters must be populated in order to send to Azure.

MariaDBLinkedService

MariaDB server linked service.

All required parameters must be populated in order to send to Azure.

MariaDBTableDataset

MariaDB server dataset.

All required parameters must be populated in order to send to Azure.

MarketoLinkedService

Marketo server linked service.

All required parameters must be populated in order to send to Azure.

MarketoObjectDataset

Marketo server dataset.

All required parameters must be populated in order to send to Azure.

MicrosoftAccessLinkedService

Microsoft Access linked service.

All required parameters must be populated in order to send to Azure.

MicrosoftAccessTableDataset

The Microsoft Access table dataset.

All required parameters must be populated in order to send to Azure.

MongoDbCollectionDataset

The MongoDB database dataset.

All required parameters must be populated in order to send to Azure.

MongoDbLinkedService

Linked service for MongoDb data source.

All required parameters must be populated in order to send to Azure.

MongoDbV2CollectionDataset

The MongoDB database dataset.

All required parameters must be populated in order to send to Azure.

MongoDbV2LinkedService

Linked service for MongoDB data source.

All required parameters must be populated in order to send to Azure.

MultiplePipelineTrigger

Base class for all triggers that support one to many model for trigger to pipeline.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

MySqlLinkedService

Linked service for MySQL data source.

All required parameters must be populated in order to send to Azure.

MySqlTableDataset

The MySQL table dataset.

All required parameters must be populated in order to send to Azure.

NetezzaLinkedService

Netezza linked service.

All required parameters must be populated in order to send to Azure.

NetezzaTableDataset

Netezza dataset.

All required parameters must be populated in order to send to Azure.

Notebook

Notebook.

All required parameters must be populated in order to send to Azure.

NotebookCell

Notebook cell.

All required parameters must be populated in order to send to Azure.

NotebookCellOutputItem

An item of the notebook cell execution output.

All required parameters must be populated in order to send to Azure.

NotebookKernelSpec

Kernel information.

All required parameters must be populated in order to send to Azure.

NotebookLanguageInfo

Language info.

All required parameters must be populated in order to send to Azure.

NotebookListResponse

A list of Notebook resources.

All required parameters must be populated in order to send to Azure.

NotebookMetadata

Notebook root-level metadata.

NotebookResource

Notebook resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

NotebookSessionProperties

Session properties.

All required parameters must be populated in order to send to Azure.

ODataLinkedService

Open Data Protocol (OData) linked service.

All required parameters must be populated in order to send to Azure.

ODataResourceDataset

The Open Data Protocol (OData) resource dataset.

All required parameters must be populated in order to send to Azure.

OdbcLinkedService

Open Database Connectivity (ODBC) linked service.

All required parameters must be populated in order to send to Azure.

OdbcTableDataset

The ODBC table dataset.

All required parameters must be populated in order to send to Azure.

Office365Dataset

The Office365 account.

All required parameters must be populated in order to send to Azure.

Office365LinkedService

Office365 linked service.

All required parameters must be populated in order to send to Azure.

OracleLinkedService

Oracle database.

All required parameters must be populated in order to send to Azure.

OracleServiceCloudLinkedService

Oracle Service Cloud linked service.

All required parameters must be populated in order to send to Azure.

OracleServiceCloudObjectDataset

Oracle Service Cloud dataset.

All required parameters must be populated in order to send to Azure.

OracleTableDataset

The on-premises Oracle database dataset.

All required parameters must be populated in order to send to Azure.

OrcDataset

ORC dataset.

All required parameters must be populated in order to send to Azure.

ParameterSpecification

Definition of a single parameter for an entity.

All required parameters must be populated in order to send to Azure.

ParquetDataset

Parquet dataset.

All required parameters must be populated in order to send to Azure.

PaypalLinkedService

Paypal Service linked service.

All required parameters must be populated in order to send to Azure.

PaypalObjectDataset

Paypal Service dataset.

All required parameters must be populated in order to send to Azure.

PhoenixLinkedService

Phoenix server linked service.

All required parameters must be populated in order to send to Azure.

PhoenixObjectDataset

Phoenix server dataset.

All required parameters must be populated in order to send to Azure.

PipelineFolder

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

PipelineListResponse

A list of pipeline resources.

All required parameters must be populated in order to send to Azure.

PipelineReference

Pipeline reference type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

PipelineResource

Pipeline resource type.

Variables are only populated by the server, and will be ignored when sending a request.

PipelineRun

Information about a pipeline run.

Variables are only populated by the server, and will be ignored when sending a request.

PipelineRunInvokedBy

Provides entity name and id that started the pipeline run.

Variables are only populated by the server, and will be ignored when sending a request.

PipelineRunsQueryResponse

A list pipeline runs.

All required parameters must be populated in order to send to Azure.

PostgreSqlLinkedService

Linked service for PostgreSQL data source.

All required parameters must be populated in order to send to Azure.

PostgreSqlTableDataset

The PostgreSQL table dataset.

All required parameters must be populated in order to send to Azure.

PrestoLinkedService

Presto server linked service.

All required parameters must be populated in order to send to Azure.

PrestoObjectDataset

Presto server dataset.

All required parameters must be populated in order to send to Azure.

QueryDataFlowDebugSessionsResponse

A list of active debug sessions.

QuickBooksLinkedService

QuickBooks server linked service.

All required parameters must be populated in order to send to Azure.

QuickBooksObjectDataset

QuickBooks server dataset.

All required parameters must be populated in order to send to Azure.

RedirectIncompatibleRowSettings

Redirect incompatible row settings.

All required parameters must be populated in order to send to Azure.

RelationalTableDataset

The relational table dataset.

All required parameters must be populated in order to send to Azure.

RerunTriggerListResponse

A list of rerun triggers.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

RerunTriggerResource

RerunTrigger resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

RerunTumblingWindowTrigger

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

RerunTumblingWindowTriggerActionParameters

Rerun tumbling window trigger Parameters.

All required parameters must be populated in order to send to Azure.

Resource

Azure Synapse top-level resource.

Variables are only populated by the server, and will be ignored when sending a request.

ResponsysLinkedService

Responsys linked service.

All required parameters must be populated in order to send to Azure.

ResponsysObjectDataset

Responsys dataset.

All required parameters must be populated in order to send to Azure.

RestResourceDataset

A Rest service dataset.

All required parameters must be populated in order to send to Azure.

RestServiceLinkedService

Rest Service linked service.

All required parameters must be populated in order to send to Azure.

RunFilterParameters

Query parameters for listing runs.

All required parameters must be populated in order to send to Azure.

RunQueryFilter

Query filter option for listing runs.

All required parameters must be populated in order to send to Azure.

RunQueryOrderBy

An object to provide order by options for listing runs.

All required parameters must be populated in order to send to Azure.

SSISAccessCredential

SSIS access credential.

All required parameters must be populated in order to send to Azure.

SSISChildPackage

SSIS embedded child package.

All required parameters must be populated in order to send to Azure.

SSISExecutionCredential

SSIS package execution credential.

All required parameters must be populated in order to send to Azure.

SSISExecutionParameter

SSIS execution parameter.

All required parameters must be populated in order to send to Azure.

SSISLogLocation

SSIS package execution log location.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

SSISPackageLocation

SSIS package location.

SSISPropertyOverride

SSIS property override.

All required parameters must be populated in order to send to Azure.

SalesforceLinkedService

Linked service for Salesforce.

All required parameters must be populated in order to send to Azure.

SalesforceMarketingCloudLinkedService

Salesforce Marketing Cloud linked service.

All required parameters must be populated in order to send to Azure.

SalesforceMarketingCloudObjectDataset

Salesforce Marketing Cloud dataset.

All required parameters must be populated in order to send to Azure.

SalesforceObjectDataset

The Salesforce object dataset.

All required parameters must be populated in order to send to Azure.

SalesforceServiceCloudLinkedService

Linked service for Salesforce Service Cloud.

All required parameters must be populated in order to send to Azure.

SalesforceServiceCloudObjectDataset

The Salesforce Service Cloud object dataset.

All required parameters must be populated in order to send to Azure.

SapBWLinkedService

SAP Business Warehouse Linked Service.

All required parameters must be populated in order to send to Azure.

SapBwCubeDataset

The SAP BW cube dataset.

All required parameters must be populated in order to send to Azure.

SapCloudForCustomerLinkedService

Linked service for SAP Cloud for Customer.

All required parameters must be populated in order to send to Azure.

SapCloudForCustomerResourceDataset

The path of the SAP Cloud for Customer OData entity.

All required parameters must be populated in order to send to Azure.

SapEccLinkedService

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

All required parameters must be populated in order to send to Azure.

SapEccResourceDataset

The path of the SAP ECC OData entity.

All required parameters must be populated in order to send to Azure.

SapHanaLinkedService

SAP HANA Linked Service.

All required parameters must be populated in order to send to Azure.

SapHanaTableDataset

SAP HANA Table properties.

All required parameters must be populated in order to send to Azure.

SapOpenHubLinkedService

SAP Business Warehouse Open Hub Destination Linked Service.

All required parameters must be populated in order to send to Azure.

SapOpenHubTableDataset

Sap Business Warehouse Open Hub Destination Table properties.

All required parameters must be populated in order to send to Azure.

SapTableLinkedService

SAP Table Linked Service.

All required parameters must be populated in order to send to Azure.

SapTableResourceDataset

SAP Table Resource properties.

All required parameters must be populated in order to send to Azure.

ScriptAction

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

All required parameters must be populated in order to send to Azure.

SecretBase

The base definition of a secret type.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureKeyVaultSecretReference, SecureString.

All required parameters must be populated in order to send to Azure.

SecureString

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

All required parameters must be populated in order to send to Azure.

ServiceNowLinkedService

ServiceNow server linked service.

All required parameters must be populated in order to send to Azure.

ServiceNowObjectDataset

ServiceNow server dataset.

All required parameters must be populated in order to send to Azure.

SetVariableActivity

Set value for a Variable.

All required parameters must be populated in order to send to Azure.

SftpServerLinkedService

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

All required parameters must be populated in order to send to Azure.

ShopifyLinkedService

Shopify Service linked service.

All required parameters must be populated in order to send to Azure.

ShopifyObjectDataset

Shopify Service dataset.

All required parameters must be populated in order to send to Azure.

SparkBatchJob

SparkBatchJob.

All required parameters must be populated in order to send to Azure.

SparkBatchJobState

SparkBatchJobState.

SparkJobDefinition

Spark job definition.

All required parameters must be populated in order to send to Azure.

SparkJobDefinitionResource

Spark job definition resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

SparkJobDefinitionsListResponse

A list of spark job definitions resources.

All required parameters must be populated in order to send to Azure.

SparkJobProperties

The properties of the Spark job.

All required parameters must be populated in order to send to Azure.

SparkLinkedService

Spark Server linked service.

All required parameters must be populated in order to send to Azure.

SparkObjectDataset

Spark Server dataset.

All required parameters must be populated in order to send to Azure.

SparkRequest

SparkRequest.

SparkScheduler

SparkScheduler.

SparkServiceError

SparkServiceError.

SparkServicePlugin

SparkServicePlugin.

SqlConnection

The connection used to execute the SQL script.

All required parameters must be populated in order to send to Azure.

SqlScript

SQL script.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

SqlScriptContent

The content of the SQL script.

All required parameters must be populated in order to send to Azure.

SqlScriptMetadata

The metadata of the SQL script.

SqlScriptResource

Sql Script resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

SqlScriptsListResponse

A list of sql scripts resources.

All required parameters must be populated in order to send to Azure.

SqlServerLinkedService

SQL Server linked service.

All required parameters must be populated in order to send to Azure.

SqlServerStoredProcedureActivity

SQL stored procedure activity type.

All required parameters must be populated in order to send to Azure.

SqlServerTableDataset

The on-premises SQL Server dataset.

All required parameters must be populated in order to send to Azure.

SquareLinkedService

Square Service linked service.

All required parameters must be populated in order to send to Azure.

SquareObjectDataset

Square Service dataset.

All required parameters must be populated in order to send to Azure.

SsisObjectMetadataStatusResponse

The status of the operation.

StagingSettings

Staging settings.

All required parameters must be populated in order to send to Azure.

StartDataFlowDebugSessionRequest

Request body structure for starting data flow debug session.

StartDataFlowDebugSessionResponse

Response body structure for starting data flow debug session.

StoredProcedureParameter

SQL stored procedure parameter.

SubResource

Azure Synapse nested resource, which belongs to a workspace.

Variables are only populated by the server, and will be ignored when sending a request.

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.

All required parameters must be populated in order to send to Azure.

SwitchCase

Switch cases with have a value and corresponding activities.

SybaseLinkedService

Linked service for Sybase data source.

All required parameters must be populated in order to send to Azure.

SybaseTableDataset

The Sybase table dataset.

All required parameters must be populated in order to send to Azure.

TeradataLinkedService

Linked service for Teradata data source.

All required parameters must be populated in order to send to Azure.

TeradataTableDataset

The Teradata database dataset.

All required parameters must be populated in order to send to Azure.

Transformation

A data flow transformation.

All required parameters must be populated in order to send to Azure.

Trigger

Azure Synapse nested object which contains information about creating pipeline run.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MultiplePipelineTrigger, RerunTumblingWindowTrigger.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

TriggerDependencyProvisioningStatus

Defines the response of a provision trigger dependency operation.

All required parameters must be populated in order to send to Azure.

TriggerListResponse

A list of trigger resources.

All required parameters must be populated in order to send to Azure.

TriggerPipelineReference

Pipeline that needs to be triggered with the given parameters.

TriggerResource

Trigger resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

TriggerRun

Trigger runs.

Variables are only populated by the server, and will be ignored when sending a request.

TriggerRunsQueryResponse

A list of trigger runs.

All required parameters must be populated in order to send to Azure.

TriggerSubscriptionOperationStatus

Defines the response of a trigger subscription operation.

Variables are only populated by the server, and will be ignored when sending a request.

UntilActivity

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

All required parameters must be populated in order to send to Azure.

UserProperty

User property.

All required parameters must be populated in order to send to Azure.

ValidationActivity

This activity verifies that an external resource exists.

All required parameters must be populated in order to send to Azure.

VariableSpecification

Definition of a single variable for a Pipeline.

All required parameters must be populated in order to send to Azure.

VerticaLinkedService

Vertica linked service.

All required parameters must be populated in order to send to Azure.

VerticaTableDataset

Vertica dataset.

All required parameters must be populated in order to send to Azure.

WaitActivity

This activity suspends pipeline execution for the specified interval.

All required parameters must be populated in order to send to Azure.

WebActivity

Web activity.

All required parameters must be populated in order to send to Azure.

WebActivityAuthentication

Web activity authentication properties.

All required parameters must be populated in order to send to Azure.

WebAnonymousAuthentication

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

All required parameters must be populated in order to send to Azure.

WebBasicAuthentication

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

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

WebHookActivity

WebHook activity.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

WebLinkedService

Web linked service.

All required parameters must be populated in order to send to Azure.

WebLinkedServiceTypeProperties

Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: WebAnonymousAuthentication, WebBasicAuthentication, WebClientCertificateAuthentication.

All required parameters must be populated in order to send to Azure.

WebTableDataset

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

All required parameters must be populated in order to send to Azure.

Workspace

Workspace resource type.

Variables are only populated by the server, and will be ignored when sending a request.

WorkspaceIdentity

Identity properties of the workspace resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

WorkspaceUpdateParameters

Parameters for updating a workspace resource.

XeroLinkedService

Xero Service linked service.

All required parameters must be populated in order to send to Azure.

XeroObjectDataset

Xero Service dataset.

All required parameters must be populated in order to send to Azure.

ZohoLinkedService

Zoho server linked service.

All required parameters must be populated in order to send to Azure.

ZohoObjectDataset

Zoho server dataset.

All required parameters must be populated in order to send to Azure.

Enums

AvroCompressionCodec

An enumeration.

AzureFunctionActivityMethod

The list of HTTP methods supported by a AzureFunctionActivity.

CellOutputType

Execution, display, or stream outputs.

DataFlowComputeType

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

DatasetCompressionLevel

All available compression levels.

DelimitedTextCompressionCodec

An enumeration.

DependencyCondition

An enumeration.

DynamicsAuthenticationType

The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).

DynamicsDeploymentType

The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string).

DynamicsServicePrincipalCredentialType

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).

EventSubscriptionStatus

Event Subscription Status.

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.

HdiNodeTypes

The node types on which the script action should be executed.

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.

MongoDbAuthenticationType

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

ODataAadServicePrincipalCredentialType

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

ODataAuthenticationType

Type of authentication used to connect to the OData service.

OrcCompressionCodec

An enumeration.

ParameterType

Parameter type.

ParquetCompressionCodec

An enumeration.

PhoenixAuthenticationType

The authentication mechanism used to connect to the Phoenix server.

PluginCurrentState

An enumeration.

PrestoAuthenticationType

The authentication mechanism used to connect to the Presto server.

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.

SapHanaAuthenticationType

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

SchedulerCurrentState

An enumeration.

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.

SparkErrorSource

An enumeration.

SparkJobType

The job type.

SparkServerType

The type of Spark server.

SparkThriftTransportProtocol

The transport protocol to use in the Thrift layer.

SqlConnectionType

The type of the connection.

SsisPackageLocationType

The type of SSIS package location.

StoredProcedureParameterType

Stored procedure parameter type.

SybaseAuthenticationType

AuthenticationType to be used for connection.

TeradataAuthenticationType

AuthenticationType to be used for connection.

TriggerRunStatus

Trigger run status.

TriggerRuntimeState

Enumerates possible state of Triggers.

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.