Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/synapse-artifacts

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

ActivityUnion

AmazonMWSLinkedService

AmazonMWSLinkedService: LinkedService & { accessKeyId: any; encryptedCredential?: any; endpoint: any; marketplaceID: any; mwsAuthToken?: SecretBaseUnion; secretKey?: SecretBaseUnion; sellerID: any; type: "AmazonMWS"; useEncryptedEndpoints?: any; useHostVerification?: any; usePeerVerification?: any }

Amazon Marketplace Web Service linked service.

AmazonMWSObjectDataset

AmazonMWSObjectDataset: Dataset & { tableName?: any; type: "AmazonMWSObject" }

Amazon Marketplace Web Service dataset.

AmazonMWSSource

AmazonMWSSource: TabularSource & { query?: any; type: "AmazonMWSSource" }

A copy activity Amazon Marketplace Web Service source.

AmazonRdsForOracleLinkedService

AmazonRdsForOracleLinkedService: LinkedService & { connectionString: any; encryptedCredential?: any; password?: SecretBaseUnion; type: "AmazonRdsForOracle" }

AmazonRdsForOracle database.

AmazonRdsForOraclePartitionOption

AmazonRdsForOraclePartitionOption: string

Defines values for AmazonRdsForOraclePartitionOption.
KnownAmazonRdsForOraclePartitionOption can be used interchangeably with AmazonRdsForOraclePartitionOption, this enum contains the known values that the service supports.

Known values supported by the service

None
PhysicalPartitionsOfTable
DynamicRange

AmazonRdsForOracleSource

AmazonRdsForOracleSource: CopySource & { additionalColumns?: any; oracleReaderQuery?: any; partitionOption?: any; partitionSettings?: AmazonRdsForOraclePartitionSettings; queryTimeout?: any; type: "AmazonRdsForOracleSource" }

A copy activity AmazonRdsForOracle source.

AmazonRdsForOracleTableDataset

AmazonRdsForOracleTableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; type: "AmazonRdsForOracleTable" }

The AmazonRdsForOracle database dataset.

AmazonRdsForSqlServerLinkedService

AmazonRdsForSqlServerLinkedService: LinkedService & { connectionString: any; encryptedCredential?: any; password?: SecretBaseUnion; type: "AmazonRdsForSqlServer"; userName?: any }

Amazon RDS for SQL Server linked service.

AmazonRdsForSqlServerSource

AmazonRdsForSqlServerSource: TabularSource & { partitionOption?: any; partitionSettings?: SqlPartitionSettings; produceAdditionalTypes?: any; sqlReaderQuery?: any; sqlReaderStoredProcedureName?: any; storedProcedureParameters?: undefined | {}; type: "AmazonRdsForSqlServerSource" }

A copy activity Amazon RDS for SQL Server source.

AmazonRdsForSqlServerTableDataset

AmazonRdsForSqlServerTableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; type: "AmazonRdsForSqlServerTable" }

The Amazon RDS for SQL Server dataset.

AmazonRedshiftLinkedService

AmazonRedshiftLinkedService: LinkedService & { database: any; encryptedCredential?: any; password?: SecretBaseUnion; port?: any; server: any; type: "AmazonRedshift"; username?: any }

Linked service for Amazon Redshift.

AmazonRedshiftSource

AmazonRedshiftSource: TabularSource & { query?: any; redshiftUnloadSettings?: RedshiftUnloadSettings; type: "AmazonRedshiftSource" }

A copy activity source for Amazon Redshift Source.

AmazonRedshiftTableDataset

AmazonRedshiftTableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "AmazonRedshiftTable" }

The Amazon Redshift table dataset.

AmazonS3Dataset

AmazonS3Dataset: Dataset & { bucketName: any; compression?: DatasetCompression; format?: DatasetStorageFormatUnion; key?: any; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; prefix?: any; type: "AmazonS3Object"; version?: any }

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

AmazonS3LinkedService

AmazonS3LinkedService: LinkedService & { accessKeyId?: any; authenticationType?: any; encryptedCredential?: any; secretAccessKey?: SecretBaseUnion; serviceUrl?: any; sessionToken?: SecretBaseUnion; type: "AmazonS3" }

Linked service for Amazon S3.

AmazonS3Location

AmazonS3Location: DatasetLocation & { bucketName?: any; type: "AmazonS3Location"; version?: any }

The location of amazon S3 dataset.

AmazonS3ReadSettings

AmazonS3ReadSettings: StoreReadSettings & { deleteFilesAfterCompletion?: any; enablePartitionDiscovery?: undefined | false | true; fileListPath?: any; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; partitionRootPath?: any; prefix?: any; recursive?: any; type: "AmazonS3ReadSettings"; wildcardFileName?: any; wildcardFolderPath?: any }

Azure data lake store read settings.

AppendVariableActivity

AppendVariableActivity: ControlActivity & { type: "AppendVariable"; value?: any; variableName?: undefined | string }

Append value for a Variable of type Array.

AvroCompressionCodec

AvroCompressionCodec: string

Defines values for AvroCompressionCodec.
KnownAvroCompressionCodec can be used interchangeably with AvroCompressionCodec, this enum contains the known values that the service supports.

Known values supported by the service

none
deflate
snappy
xz
bzip2

AvroDataset

AvroDataset: Dataset & { avroCompressionCodec?: any; avroCompressionLevel?: undefined | number; location?: DatasetLocationUnion; type: "Avro" }

Avro dataset.

AvroFormat

AvroFormat: DatasetStorageFormat & { type: "AvroFormat" }

The data stored in Avro format.

AvroSink

AvroSink: CopySink & { formatSettings?: AvroWriteSettings; storeSettings?: StoreWriteSettingsUnion; type: "AvroSink" }

A copy activity Avro sink.

AvroSource

AvroSource: CopySource & { additionalColumns?: any; storeSettings?: StoreReadSettingsUnion; type: "AvroSource" }

A copy activity Avro source.

AvroWriteSettings

AvroWriteSettings: FormatWriteSettings & { fileNamePrefix?: any; maxRowsPerFile?: any; recordName?: undefined | string; recordNamespace?: undefined | string; type: "AvroWriteSettings" }

Avro write settings.

AzureBatchLinkedService

AzureBatchLinkedService: LinkedService & { accessKey?: SecretBaseUnion; accountName: any; batchUri: any; encryptedCredential?: any; linkedServiceName: LinkedServiceReference; poolName: any; type: "AzureBatch" }

Azure Batch linked service.

AzureBlobDataset

AzureBlobDataset: Dataset & { compression?: DatasetCompression; fileName?: any; folderPath?: any; format?: DatasetStorageFormatUnion; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; tableRootLocation?: any; type: "AzureBlob" }

The Azure Blob storage.

AzureBlobFSDataset

AzureBlobFSDataset: Dataset & { compression?: DatasetCompression; fileName?: any; folderPath?: any; format?: DatasetStorageFormatUnion; type: "AzureBlobFSFile" }

The Azure Data Lake Storage Gen2 storage.

AzureBlobFSLinkedService

AzureBlobFSLinkedService: LinkedService & { accountKey?: any; azureCloudType?: any; encryptedCredential?: any; servicePrincipalCredential?: SecretBaseUnion; servicePrincipalCredentialType?: any; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; tenant?: any; type: "AzureBlobFS"; url: any }

Azure Data Lake Storage Gen2 linked service.

AzureBlobFSLocation

AzureBlobFSLocation: DatasetLocation & { fileSystem?: any; type: "AzureBlobFSLocation" }

The location of azure blobFS dataset.

AzureBlobFSReadSettings

AzureBlobFSReadSettings: StoreReadSettings & { deleteFilesAfterCompletion?: any; enablePartitionDiscovery?: undefined | false | true; fileListPath?: any; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; partitionRootPath?: any; recursive?: any; type: "AzureBlobFSReadSettings"; wildcardFileName?: any; wildcardFolderPath?: any }

Azure blobFS read settings.

AzureBlobFSSink

AzureBlobFSSink: CopySink & { copyBehavior?: any; type: "AzureBlobFSSink" }

A copy activity Azure Data Lake Storage Gen2 sink.

AzureBlobFSSource

AzureBlobFSSource: CopySource & { recursive?: any; skipHeaderLineCount?: any; treatEmptyAsNull?: any; type: "AzureBlobFSSource" }

A copy activity Azure BlobFS source.

AzureBlobFSWriteSettings

AzureBlobFSWriteSettings: StoreWriteSettings & { blockSizeInMB?: any; type: "AzureBlobFSWriteSettings" }

Azure blobFS write settings.

AzureBlobStorageLinkedService

AzureBlobStorageLinkedService: LinkedService & { accountKey?: AzureKeyVaultSecretReference; accountKind?: undefined | string; azureCloudType?: any; connectionString?: any; encryptedCredential?: undefined | string; sasToken?: AzureKeyVaultSecretReference; sasUri?: any; serviceEndpoint?: undefined | string; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; tenant?: any; type: "AzureBlobStorage" }

The azure blob storage linked service.

AzureBlobStorageLocation

AzureBlobStorageLocation: DatasetLocation & { container?: any; type: "AzureBlobStorageLocation" }

The location of azure blob dataset.

AzureBlobStorageReadSettings

AzureBlobStorageReadSettings: StoreReadSettings & { deleteFilesAfterCompletion?: any; enablePartitionDiscovery?: undefined | false | true; fileListPath?: any; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; partitionRootPath?: any; prefix?: any; recursive?: any; type: "AzureBlobStorageReadSettings"; wildcardFileName?: any; wildcardFolderPath?: any }

Azure blob read settings.

AzureBlobStorageWriteSettings

AzureBlobStorageWriteSettings: StoreWriteSettings & { blockSizeInMB?: any; type: "AzureBlobStorageWriteSettings" }

Azure blob write settings.

AzureDataExplorerCommandActivity

AzureDataExplorerCommandActivity: ExecutionActivity & { command: any; commandTimeout?: any; type: "AzureDataExplorerCommand" }

Azure Data Explorer command activity.

AzureDataExplorerLinkedService

AzureDataExplorerLinkedService: LinkedService & { database: any; endpoint: any; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; tenant?: any; type: "AzureDataExplorer" }

Azure Data Explorer (Kusto) linked service.

AzureDataExplorerSink

AzureDataExplorerSink: CopySink & { flushImmediately?: any; ingestionMappingAsJson?: any; ingestionMappingName?: any; type: "AzureDataExplorerSink" }

A copy activity Azure Data Explorer sink.

AzureDataExplorerSource

AzureDataExplorerSource: CopySource & { additionalColumns?: any; noTruncation?: any; query: any; queryTimeout?: any; type: "AzureDataExplorerSource" }

A copy activity Azure Data Explorer (Kusto) source.

AzureDataExplorerTableDataset

AzureDataExplorerTableDataset: Dataset & { table?: any; type: "AzureDataExplorerTable" }

The Azure Data Explorer (Kusto) dataset.

AzureDataLakeAnalyticsLinkedService

AzureDataLakeAnalyticsLinkedService: LinkedService & { accountName: any; dataLakeAnalyticsUri?: any; encryptedCredential?: any; resourceGroupName?: any; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; subscriptionId?: any; tenant: any; type: "AzureDataLakeAnalytics" }

Azure Data Lake Analytics linked service.

AzureDataLakeStoreDataset

AzureDataLakeStoreDataset: Dataset & { compression?: DatasetCompression; fileName?: any; folderPath?: any; format?: DatasetStorageFormatUnion; type: "AzureDataLakeStoreFile" }

Azure Data Lake Store dataset.

AzureDataLakeStoreLinkedService

AzureDataLakeStoreLinkedService: LinkedService & { accountName?: any; azureCloudType?: any; dataLakeStoreUri: any; encryptedCredential?: any; resourceGroupName?: any; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; subscriptionId?: any; tenant?: any; type: "AzureDataLakeStore" }

Azure Data Lake Store linked service.

AzureDataLakeStoreLocation

AzureDataLakeStoreLocation: DatasetLocation & { type: "AzureDataLakeStoreLocation" }

The location of azure data lake store dataset.

AzureDataLakeStoreReadSettings

AzureDataLakeStoreReadSettings: StoreReadSettings & { deleteFilesAfterCompletion?: any; enablePartitionDiscovery?: undefined | false | true; fileListPath?: any; listAfter?: any; listBefore?: any; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; partitionRootPath?: any; recursive?: any; type: "AzureDataLakeStoreReadSettings"; wildcardFileName?: any; wildcardFolderPath?: any }

Azure data lake store read settings.

AzureDataLakeStoreSink

AzureDataLakeStoreSink: CopySink & { copyBehavior?: any; enableAdlsSingleFileParallel?: any; type: "AzureDataLakeStoreSink" }

A copy activity Azure Data Lake Store sink.

AzureDataLakeStoreSource

AzureDataLakeStoreSource: CopySource & { recursive?: any; type: "AzureDataLakeStoreSource" }

A copy activity Azure Data Lake source.

AzureDataLakeStoreWriteSettings

AzureDataLakeStoreWriteSettings: StoreWriteSettings & { expiryDateTime?: any; type: "AzureDataLakeStoreWriteSettings" }

Azure data lake store write settings.

AzureDatabricksDeltaLakeDataset

AzureDatabricksDeltaLakeDataset: Dataset & { database?: any; table?: any; type: "AzureDatabricksDeltaLakeDataset" }

Azure Databricks Delta Lake dataset.

AzureDatabricksDeltaLakeExportCommand

AzureDatabricksDeltaLakeExportCommand: ExportSettings & { dateFormat?: any; timestampFormat?: any; type: "AzureDatabricksDeltaLakeExportCommand" }

Azure Databricks Delta Lake export command settings.

AzureDatabricksDeltaLakeImportCommand

AzureDatabricksDeltaLakeImportCommand: ImportSettings & { dateFormat?: any; timestampFormat?: any; type: "AzureDatabricksDeltaLakeImportCommand" }

Azure Databricks Delta Lake import command settings.

AzureDatabricksDeltaLakeLinkedService

AzureDatabricksDeltaLakeLinkedService: LinkedService & { accessToken: SecretBaseUnion; clusterId?: any; domain: any; encryptedCredential?: any; type: "AzureDatabricksDeltaLake" }

Azure Databricks Delta Lake linked service.

AzureDatabricksDeltaLakeSink

AzureDatabricksDeltaLakeSink: CopySink & { importSettings?: AzureDatabricksDeltaLakeImportCommand; preCopyScript?: any; type: "AzureDatabricksDeltaLakeSink" }

A copy activity Azure Databricks Delta Lake sink.

AzureDatabricksDeltaLakeSource

AzureDatabricksDeltaLakeSource: CopySource & { exportSettings?: AzureDatabricksDeltaLakeExportCommand; query?: any; type: "AzureDatabricksDeltaLakeSource" }

A copy activity Azure Databricks Delta Lake source.

AzureDatabricksLinkedService

AzureDatabricksLinkedService: LinkedService & { accessToken?: SecretBaseUnion; authentication?: any; domain: any; encryptedCredential?: any; existingClusterId?: any; instancePoolId?: any; newClusterCustomTags?: undefined | {}; newClusterDriverNodeType?: any; newClusterEnableElasticDisk?: any; newClusterInitScripts?: any; newClusterLogDestination?: any; newClusterNodeType?: any; newClusterNumOfWorker?: any; newClusterSparkConf?: undefined | {}; newClusterSparkEnvVars?: undefined | {}; newClusterVersion?: any; policyId?: any; type: "AzureDatabricks"; workspaceResourceId?: any }

Azure Databricks linked service.

AzureEntityResource

AzureEntityResource: Resource & { etag?: undefined | string }

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

AzureFileStorageLinkedService

AzureFileStorageLinkedService: LinkedService & { accountKey?: AzureKeyVaultSecretReference; connectionString?: any; encryptedCredential?: any; fileShare?: any; host: any; password?: SecretBaseUnion; sasToken?: AzureKeyVaultSecretReference; sasUri?: any; snapshot?: any; type: "AzureFileStorage"; userId?: any }

Azure File Storage linked service.

AzureFileStorageLocation

AzureFileStorageLocation: DatasetLocation & { type: "AzureFileStorageLocation" }

The location of file server dataset.

AzureFileStorageReadSettings

AzureFileStorageReadSettings: StoreReadSettings & { deleteFilesAfterCompletion?: any; enablePartitionDiscovery?: undefined | false | true; fileListPath?: any; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; partitionRootPath?: any; prefix?: any; recursive?: any; type: "AzureFileStorageReadSettings"; wildcardFileName?: any; wildcardFolderPath?: any }

Azure File Storage read settings.

AzureFileStorageWriteSettings

AzureFileStorageWriteSettings: StoreWriteSettings & { type: "AzureFileStorageWriteSettings" }

Azure File Storage write settings.

AzureFunctionActivity

AzureFunctionActivity: ExecutionActivity & { body?: any; functionName: any; headers?: any; method: AzureFunctionActivityMethod; type: "AzureFunctionActivity" }

Azure Function activity.

AzureFunctionActivityMethod

AzureFunctionActivityMethod: string

Defines values for AzureFunctionActivityMethod.
KnownAzureFunctionActivityMethod can be used interchangeably with AzureFunctionActivityMethod, this enum contains the known values that the service supports.

Known values supported by the service

GET
POST
PUT
DELETE
OPTIONS
HEAD
TRACE

AzureFunctionLinkedService

AzureFunctionLinkedService: LinkedService & { encryptedCredential?: any; functionAppUrl: any; functionKey?: SecretBaseUnion; type: "AzureFunction" }

Azure Function linked service.

AzureKeyVaultLinkedService

AzureKeyVaultLinkedService: LinkedService & { baseUrl: any; type: "AzureKeyVault" }

Azure Key Vault linked service.

AzureKeyVaultSecretReference

AzureKeyVaultSecretReference: SecretBase & { secretName: any; secretVersion?: any; store: LinkedServiceReference; type: "AzureKeyVaultSecret" }

Azure Key Vault secret reference.

AzureMLBatchExecutionActivity

AzureMLBatchExecutionActivity: ExecutionActivity & { globalParameters?: undefined | {}; type: "AzureMLBatchExecution"; webServiceInputs?: undefined | {}; webServiceOutputs?: undefined | {} }

Azure ML Batch Execution activity.

AzureMLExecutePipelineActivity

AzureMLExecutePipelineActivity: ExecutionActivity & { continueOnStepFailure?: any; experimentName?: any; mlParentRunId?: any; mlPipelineId: any; mlPipelineParameters?: any; type: "AzureMLExecutePipeline" }

Azure ML Execute Pipeline activity.

AzureMLLinkedService

AzureMLLinkedService: LinkedService & { apiKey: SecretBaseUnion; encryptedCredential?: any; mlEndpoint: any; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; tenant?: any; type: "AzureML"; updateResourceEndpoint?: any }

Azure ML Studio Web Service linked service.

AzureMLServiceLinkedService

AzureMLServiceLinkedService: LinkedService & { encryptedCredential?: any; mlWorkspaceName: any; resourceGroupName: any; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; subscriptionId: any; tenant?: any; type: "AzureMLService" }

Azure ML Service linked service.

AzureMLUpdateResourceActivity

AzureMLUpdateResourceActivity: ExecutionActivity & { trainedModelFilePath: any; trainedModelLinkedServiceName: LinkedServiceReference; trainedModelName: any; type: "AzureMLUpdateResource" }

Azure ML Update Resource management activity.

AzureMariaDBLinkedService

AzureMariaDBLinkedService: LinkedService & { connectionString?: any; encryptedCredential?: any; pwd?: AzureKeyVaultSecretReference; type: "AzureMariaDB" }

Azure Database for MariaDB linked service.

AzureMariaDBSource

AzureMariaDBSource: TabularSource & { query?: any; type: "AzureMariaDBSource" }

A copy activity Azure MariaDB source.

AzureMariaDBTableDataset

AzureMariaDBTableDataset: Dataset & { tableName?: any; type: "AzureMariaDBTable" }

Azure Database for MariaDB dataset.

AzureMySqlLinkedService

AzureMySqlLinkedService: LinkedService & { connectionString: any; encryptedCredential?: any; password?: AzureKeyVaultSecretReference; type: "AzureMySql" }

Azure MySQL database linked service.

AzureMySqlSink

AzureMySqlSink: CopySink & { preCopyScript?: any; type: "AzureMySqlSink" }

A copy activity Azure MySql sink.

AzureMySqlSource

AzureMySqlSource: TabularSource & { query?: any; type: "AzureMySqlSource" }

A copy activity Azure MySQL source.

AzureMySqlTableDataset

AzureMySqlTableDataset: Dataset & { table?: any; tableName?: any; type: "AzureMySqlTable" }

The Azure MySQL database dataset.

AzurePostgreSqlLinkedService

AzurePostgreSqlLinkedService: LinkedService & { connectionString?: any; encryptedCredential?: any; password?: AzureKeyVaultSecretReference; type: "AzurePostgreSql" }

Azure PostgreSQL linked service.

AzurePostgreSqlSink

AzurePostgreSqlSink: CopySink & { preCopyScript?: any; type: "AzurePostgreSqlSink" }

A copy activity Azure PostgreSQL sink.

AzurePostgreSqlSource

AzurePostgreSqlSource: TabularSource & { query?: any; type: "AzurePostgreSqlSource" }

A copy activity Azure PostgreSQL source.

AzurePostgreSqlTableDataset

AzurePostgreSqlTableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "AzurePostgreSqlTable" }

Azure PostgreSQL dataset.

AzureQueueSink

AzureQueueSink: CopySink & { type: "AzureQueueSink" }

A copy activity Azure Queue sink.

AzureSearchIndexDataset

AzureSearchIndexDataset: Dataset & { indexName: any; type: "AzureSearchIndex" }

The Azure Search Index.

AzureSearchIndexSink

AzureSearchIndexSink: CopySink & { type: "AzureSearchIndexSink"; writeBehavior?: AzureSearchIndexWriteBehaviorType }

A copy activity Azure Search Index sink.

AzureSearchIndexWriteBehaviorType

AzureSearchIndexWriteBehaviorType: string

Defines values for AzureSearchIndexWriteBehaviorType.
KnownAzureSearchIndexWriteBehaviorType can be used interchangeably with AzureSearchIndexWriteBehaviorType, this enum contains the known values that the service supports.

Known values supported by the service

Merge
Upload

AzureSearchLinkedService

AzureSearchLinkedService: LinkedService & { encryptedCredential?: any; key?: SecretBaseUnion; type: "AzureSearch"; url: any }

Linked service for Windows Azure Search Service.

AzureSqlDWLinkedService

AzureSqlDWLinkedService: LinkedService & { azureCloudType?: any; connectionString: any; encryptedCredential?: any; password?: AzureKeyVaultSecretReference; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; tenant?: any; type: "AzureSqlDW" }

Azure SQL Data Warehouse linked service.

AzureSqlDWTableDataset

AzureSqlDWTableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "AzureSqlDWTable" }

The Azure SQL Data Warehouse dataset.

AzureSqlDatabaseLinkedService

AzureSqlDatabaseLinkedService: LinkedService & { azureCloudType?: any; connectionString: any; encryptedCredential?: any; password?: AzureKeyVaultSecretReference; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; tenant?: any; type: "AzureSqlDatabase" }

Microsoft Azure SQL Database linked service.

AzureSqlMILinkedService

AzureSqlMILinkedService: LinkedService & { azureCloudType?: any; connectionString: any; encryptedCredential?: any; password?: AzureKeyVaultSecretReference; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; tenant?: any; type: "AzureSqlMI" }

Azure SQL Managed Instance linked service.

AzureSqlMITableDataset

AzureSqlMITableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "AzureSqlMITable" }

The Azure SQL Managed Instance dataset.

AzureSqlSink

AzureSqlSink: CopySink & { preCopyScript?: any; sqlWriterStoredProcedureName?: any; sqlWriterTableType?: any; storedProcedureParameters?: undefined | {}; storedProcedureTableTypeParameterName?: any; tableOption?: any; type: "AzureSqlSink" }

A copy activity Azure SQL sink.

AzureSqlSource

AzureSqlSource: TabularSource & { partitionOption?: any; partitionSettings?: SqlPartitionSettings; produceAdditionalTypes?: any; sqlReaderQuery?: any; sqlReaderStoredProcedureName?: any; storedProcedureParameters?: undefined | {}; type: "AzureSqlSource" }

A copy activity Azure SQL source.

AzureSqlTableDataset

AzureSqlTableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "AzureSqlTable" }

The Azure SQL Server database dataset.

AzureStorageLinkedService

AzureStorageLinkedService: LinkedService & { accountKey?: AzureKeyVaultSecretReference; connectionString?: any; encryptedCredential?: undefined | string; sasToken?: AzureKeyVaultSecretReference; sasUri?: any; type: "AzureStorage" }

The storage account linked service.

AzureTableDataset

AzureTableDataset: Dataset & { tableName: any; type: "AzureTable" }

The Azure Table storage dataset.

AzureTableSink

AzureTableSink: CopySink & { azureTableDefaultPartitionKeyValue?: any; azureTableInsertType?: any; azureTablePartitionKeyName?: any; azureTableRowKeyName?: any; type: "AzureTableSink" }

A copy activity Azure Table sink.

AzureTableSource

AzureTableSource: TabularSource & { azureTableSourceIgnoreTableNotFound?: any; azureTableSourceQuery?: any; type: "AzureTableSource" }

A copy activity Azure Table source.

AzureTableStorageLinkedService

AzureTableStorageLinkedService: LinkedService & { accountKey?: AzureKeyVaultSecretReference; connectionString?: any; encryptedCredential?: undefined | string; sasToken?: AzureKeyVaultSecretReference; sasUri?: any; type: "AzureTableStorage" }

The azure table storage linked service.

BigDataPoolReferenceType

BigDataPoolReferenceType: string

Defines values for BigDataPoolReferenceType.
KnownBigDataPoolReferenceType can be used interchangeably with BigDataPoolReferenceType, this enum contains the known values that the service supports.

Known values supported by the service

BigDataPoolReference

BigDataPoolResourceInfo

BigDataPoolResourceInfo: TrackedResource & { autoPause?: AutoPauseProperties; autoScale?: AutoScaleProperties; cacheSize?: undefined | number; creationDate?: Date; customLibraries?: LibraryInfo[]; defaultSparkLogFolder?: undefined | string; dynamicExecutorAllocation?: DynamicExecutorAllocation; isComputeIsolationEnabled?: undefined | false | true; lastSucceededTimestamp?: Date; libraryRequirements?: LibraryRequirements; nodeCount?: undefined | number; nodeSize?: NodeSize; nodeSizeFamily?: NodeSizeFamily; provisioningState?: undefined | string; sessionLevelPackagesEnabled?: undefined | false | true; sparkConfigProperties?: LibraryRequirements; sparkEventsFolder?: undefined | string; sparkVersion?: undefined | string }

A Big Data pool

BigDataPoolsGetResponse

BigDataPoolsGetResponse: BigDataPoolResourceInfo

Contains response data for the get operation.

BigDataPoolsListResponse

BigDataPoolsListResponse: BigDataPoolResourceInfoListResult

Contains response data for the list operation.

BinaryDataset

BinaryDataset: Dataset & { compression?: DatasetCompression; location?: DatasetLocationUnion; type: "Binary" }

Binary dataset.

BinaryReadSettings

BinaryReadSettings: FormatReadSettings & { compressionProperties?: CompressionReadSettingsUnion; type: "BinaryReadSettings" }

Binary read settings.

BinarySink

BinarySink: CopySink & { storeSettings?: StoreWriteSettingsUnion; type: "BinarySink" }

A copy activity Binary sink.

BinarySource

BinarySource: CopySource & { formatSettings?: BinaryReadSettings; storeSettings?: StoreReadSettingsUnion; type: "BinarySource" }

A copy activity Binary source.

BlobEventType

BlobEventType: string

Defines values for BlobEventType.
KnownBlobEventType can be used interchangeably with BlobEventType, this enum contains the known values that the service supports.

Known values supported by the service

Microsoft.Storage.BlobCreated
Microsoft.Storage.BlobDeleted

BlobEventsTrigger

BlobEventsTrigger: MultiplePipelineTrigger & { blobPathBeginsWith?: undefined | string; blobPathEndsWith?: undefined | string; events: BlobEventType[]; ignoreEmptyBlobs?: undefined | false | true; scope: string; type: "BlobEventsTrigger" }

Trigger that runs every time a Blob event occurs.

BlobSink

BlobSink: CopySink & { blobWriterAddHeader?: any; blobWriterDateTimeFormat?: any; blobWriterOverwriteFiles?: any; copyBehavior?: any; type: "BlobSink" }

A copy activity Azure Blob sink.

BlobSource

BlobSource: CopySource & { recursive?: any; skipHeaderLineCount?: any; treatEmptyAsNull?: any; type: "BlobSource" }

A copy activity Azure Blob source.

BlobTrigger

BlobTrigger: MultiplePipelineTrigger & { folderPath: string; linkedService: LinkedServiceReference; maxConcurrency: number; type: "BlobTrigger" }

Trigger that runs every time the selected Blob container changes.

CassandraLinkedService

CassandraLinkedService: LinkedService & { authenticationType?: any; encryptedCredential?: any; host: any; password?: SecretBaseUnion; port?: any; type: "Cassandra"; username?: any }

Linked service for Cassandra data source.

CassandraSource

CassandraSource: TabularSource & { consistencyLevel?: CassandraSourceReadConsistencyLevels; query?: any; type: "CassandraSource" }

A copy activity source for a Cassandra database.

CassandraSourceReadConsistencyLevels

CassandraSourceReadConsistencyLevels: string

Defines values for CassandraSourceReadConsistencyLevels.
KnownCassandraSourceReadConsistencyLevels can be used interchangeably with CassandraSourceReadConsistencyLevels, this enum contains the known values that the service supports.

Known values supported by the service

ALL
EACH_QUORUM
QUORUM
LOCAL_QUORUM
ONE
TWO
THREE
LOCAL_ONE
SERIAL
LOCAL_SERIAL

CassandraTableDataset

CassandraTableDataset: Dataset & { keyspace?: any; tableName?: any; type: "CassandraTable" }

The Cassandra database dataset.

CellOutputType

CellOutputType: string

Defines values for CellOutputType.
KnownCellOutputType can be used interchangeably with CellOutputType, this enum contains the known values that the service supports.

Known values supported by the service

execute_result
display_data
stream
error

ChainingTrigger

ChainingTrigger: Trigger & { dependsOn: PipelineReference[]; pipeline: TriggerPipelineReference; runDimension: string; type: "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.

CommonDataServiceForAppsEntityDataset

CommonDataServiceForAppsEntityDataset: Dataset & { entityName?: any; type: "CommonDataServiceForAppsEntity" }

The Common Data Service for Apps entity dataset.

CommonDataServiceForAppsLinkedService

CommonDataServiceForAppsLinkedService: LinkedService & { authenticationType: any; deploymentType: any; encryptedCredential?: any; hostName?: any; organizationName?: any; password?: SecretBaseUnion; port?: any; servicePrincipalCredential?: SecretBaseUnion; servicePrincipalCredentialType?: any; servicePrincipalId?: any; serviceUri?: any; type: "CommonDataServiceForApps"; username?: any }

Common Data Service for Apps linked service.

CommonDataServiceForAppsSink

CommonDataServiceForAppsSink: CopySink & { alternateKeyName?: any; ignoreNullValues?: any; type: "CommonDataServiceForAppsSink"; writeBehavior: DynamicsSinkWriteBehavior }

A copy activity Common Data Service for Apps sink.

CommonDataServiceForAppsSource

CommonDataServiceForAppsSource: CopySource & { additionalColumns?: any; query?: any; type: "CommonDataServiceForAppsSource" }

A copy activity Common Data Service for Apps source.

CompressionCodec

CompressionCodec: string

Defines values for CompressionCodec.
KnownCompressionCodec can be used interchangeably with CompressionCodec, this enum contains the known values that the service supports.

Known values supported by the service

none
lzo
bzip2
gzip
deflate
zipDeflate
snappy
lz4
tar
tarGZip

CompressionReadSettingsUnion

ConcurLinkedService

ConcurLinkedService: LinkedService & { clientId: any; connectionProperties?: any; encryptedCredential?: any; password?: SecretBaseUnion; type: "Concur"; useEncryptedEndpoints?: any; useHostVerification?: any; usePeerVerification?: any; username: any }

Concur Service linked service.

ConcurObjectDataset

ConcurObjectDataset: Dataset & { tableName?: any; type: "ConcurObject" }

Concur Service dataset.

ConcurSource

ConcurSource: TabularSource & { query?: any; type: "ConcurSource" }

A copy activity Concur Service source.

ControlActivity

ControlActivity: Activity & { type: "Container" | "ExecutePipeline" | "IfCondition" | "Switch" | "ForEach" | "Wait" | "Until" | "Validation" | "Filter" | "SetVariable" | "AppendVariable" | "WebHook" }

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

ControlActivityUnion

CopyActivity

CopyActivity: ExecutionActivity & { dataIntegrationUnits?: any; enableSkipIncompatibleRow?: any; enableStaging?: any; inputs?: DatasetReference[]; logSettings?: LogSettings; logStorageSettings?: LogStorageSettings; outputs?: DatasetReference[]; parallelCopies?: any; preserve?: any[]; preserveRules?: any[]; redirectIncompatibleRowSettings?: RedirectIncompatibleRowSettings; sink: CopySinkUnion; skipErrorFile?: SkipErrorFile; source: CopySourceUnion; stagingSettings?: StagingSettings; translator?: any; type: "Copy"; validateDataConsistency?: any }

Copy activity.

CopyBehaviorType

CopyBehaviorType: string

Defines values for CopyBehaviorType.
KnownCopyBehaviorType can be used interchangeably with CopyBehaviorType, this enum contains the known values that the service supports.

Known values supported by the service

PreserveHierarchy
FlattenHierarchy
MergeFiles

CopySinkUnion

CopySourceUnion

CopyTranslatorUnion

CopyTranslatorUnion: CopyTranslator | TabularTranslator

CosmosDbLinkedService

CosmosDbLinkedService: LinkedService & { accountEndpoint?: any; accountKey?: SecretBaseUnion; connectionString?: any; database?: any; encryptedCredential?: any; type: "CosmosDb" }

Microsoft Azure Cosmos Database (CosmosDB) linked service.

CosmosDbMongoDbApiCollectionDataset

CosmosDbMongoDbApiCollectionDataset: Dataset & { collection: any; type: "CosmosDbMongoDbApiCollection" }

The CosmosDB (MongoDB API) database dataset.

CosmosDbMongoDbApiLinkedService

CosmosDbMongoDbApiLinkedService: LinkedService & { connectionString: any; database: any; type: "CosmosDbMongoDbApi" }

Linked service for CosmosDB (MongoDB API) data source.

CosmosDbMongoDbApiSink

CosmosDbMongoDbApiSink: CopySink & { type: "CosmosDbMongoDbApiSink"; writeBehavior?: any }

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

CosmosDbMongoDbApiSource

CosmosDbMongoDbApiSource: CopySource & { additionalColumns?: any; batchSize?: any; cursorMethods?: MongoDbCursorMethodsProperties; filter?: any; queryTimeout?: any; type: "CosmosDbMongoDbApiSource" }

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

CosmosDbSqlApiCollectionDataset

CosmosDbSqlApiCollectionDataset: Dataset & { collectionName: any; type: "CosmosDbSqlApiCollection" }

Microsoft Azure CosmosDB (SQL API) Collection dataset.

CosmosDbSqlApiSink

CosmosDbSqlApiSink: CopySink & { type: "CosmosDbSqlApiSink"; writeBehavior?: any }

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

CosmosDbSqlApiSource

CosmosDbSqlApiSource: CopySource & { additionalColumns?: any; detectDatetime?: any; pageSize?: any; preferredRegions?: any; query?: any; type: "CosmosDbSqlApiSource" }

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

CouchbaseLinkedService

CouchbaseLinkedService: LinkedService & { connectionString?: any; credString?: AzureKeyVaultSecretReference; encryptedCredential?: any; type: "Couchbase" }

Couchbase server linked service.

CouchbaseSource

CouchbaseSource: TabularSource & { query?: any; type: "CouchbaseSource" }

A copy activity Couchbase server source.

CouchbaseTableDataset

CouchbaseTableDataset: Dataset & { tableName?: any; type: "CouchbaseTable" }

Couchbase server dataset.

CreateMode

CreateMode: string

Defines values for CreateMode.
KnownCreateMode can be used interchangeably with CreateMode, this enum contains the known values that the service supports.

Known values supported by the service

Default
PointInTimeRestore
Recovery
Restore

CustomActivity

CustomActivity: ExecutionActivity & { autoUserSpecification?: any; command: any; extendedProperties?: undefined | {}; folderPath?: any; referenceObjects?: CustomActivityReferenceObject; resourceLinkedService?: LinkedServiceReference; retentionTimeInDays?: any; type: "Custom" }

Custom activity type.

CustomDataSourceLinkedService

CustomDataSourceLinkedService: LinkedService & { type: "CustomDataSource"; typeProperties: any }

Custom linked service.

CustomDataset

CustomDataset: Dataset & { type: "CustomDataset"; typeProperties?: any }

The custom dataset.

CustomEventsTrigger

CustomEventsTrigger: MultiplePipelineTrigger & { events: any[]; scope: string; subjectBeginsWith?: undefined | string; subjectEndsWith?: undefined | string; type: "CustomEventsTrigger" }

Trigger that runs every time a custom event is received.

DataFlowComputeType

DataFlowComputeType: string

Defines values for DataFlowComputeType.
KnownDataFlowComputeType can be used interchangeably with DataFlowComputeType, this enum contains the known values that the service supports.

Known values supported by the service

General
MemoryOptimized
ComputeOptimized

DataFlowCreateOrUpdateDataFlowResponse

DataFlowCreateOrUpdateDataFlowResponse: DataFlowResource

Contains response data for the createOrUpdateDataFlow operation.

DataFlowDebugCommandType

DataFlowDebugCommandType: string

Defines values for DataFlowDebugCommandType.
KnownDataFlowDebugCommandType can be used interchangeably with DataFlowDebugCommandType, this enum contains the known values that the service supports.

Known values supported by the service

executePreviewQuery
executeStatisticsQuery
executeExpressionQuery

DataFlowDebugResource

DataFlowDebugResource: SubResourceDebugResource & { properties: DataFlowUnion }

Data flow debug resource.

DataFlowDebugSessionAddDataFlowResponse

DataFlowDebugSessionAddDataFlowResponse: AddDataFlowToDebugSessionResponse

Contains response data for the addDataFlow operation.

DataFlowDebugSessionCreateDataFlowDebugSessionResponse

DataFlowDebugSessionCreateDataFlowDebugSessionResponse: CreateDataFlowDebugSessionResponse

Contains response data for the createDataFlowDebugSession operation.

DataFlowDebugSessionExecuteCommandResponse

DataFlowDebugSessionExecuteCommandResponse: DataFlowDebugCommandResponse

Contains response data for the executeCommand operation.

DataFlowDebugSessionQueryDataFlowDebugSessionsByWorkspaceNextResponse

DataFlowDebugSessionQueryDataFlowDebugSessionsByWorkspaceNextResponse: QueryDataFlowDebugSessionsResponse

Contains response data for the queryDataFlowDebugSessionsByWorkspaceNext operation.

DataFlowDebugSessionQueryDataFlowDebugSessionsByWorkspaceResponse

DataFlowDebugSessionQueryDataFlowDebugSessionsByWorkspaceResponse: QueryDataFlowDebugSessionsResponse

Contains response data for the queryDataFlowDebugSessionsByWorkspace operation.

DataFlowGetDataFlowResponse

DataFlowGetDataFlowResponse: DataFlowResource

Contains response data for the getDataFlow operation.

DataFlowGetDataFlowsByWorkspaceNextResponse

DataFlowGetDataFlowsByWorkspaceNextResponse: DataFlowListResponse

Contains response data for the getDataFlowsByWorkspaceNext operation.

DataFlowGetDataFlowsByWorkspaceResponse

DataFlowGetDataFlowsByWorkspaceResponse: DataFlowListResponse

Contains response data for the getDataFlowsByWorkspace operation.

DataFlowReferenceType

DataFlowReferenceType: string

Defines values for DataFlowReferenceType.
KnownDataFlowReferenceType can be used interchangeably with DataFlowReferenceType, this enum contains the known values that the service supports.

Known values supported by the service

DataFlowReference

DataFlowResource

DataFlowResource: SubResource & { properties: DataFlowUnion }

Data flow resource type.

DataFlowSink

DataFlowSink: Transformation & { schemaLinkedService?: LinkedServiceReference }

Transformation for data flow sink.

DataFlowSource

DataFlowSource: Transformation & { schemaLinkedService?: LinkedServiceReference }

Transformation for data flow source.

DataFlowUnion

DataFlowUnion: DataFlow | MappingDataFlow | Flowlet

DataLakeAnalyticsUsqlActivity

DataLakeAnalyticsUsqlActivity: ExecutionActivity & { compilationMode?: any; degreeOfParallelism?: any; parameters?: undefined | {}; priority?: any; runtimeVersion?: any; scriptLinkedService: LinkedServiceReference; scriptPath: any; type: "DataLakeAnalyticsU-SQL" }

Data Lake Analytics U-SQL activity.

DatabricksNotebookActivity

DatabricksNotebookActivity: ExecutionActivity & { baseParameters?: undefined | {}; libraries?: {}[]; notebookPath: any; type: "DatabricksNotebook" }

DatabricksNotebook activity.

DatabricksSparkJarActivity

DatabricksSparkJarActivity: ExecutionActivity & { libraries?: {}[]; mainClassName: any; parameters?: any[]; type: "DatabricksSparkJar" }

DatabricksSparkJar activity.

DatabricksSparkPythonActivity

DatabricksSparkPythonActivity: ExecutionActivity & { libraries?: {}[]; parameters?: any[]; pythonFile: any; type: "DatabricksSparkPython" }

DatabricksSparkPython activity.

DatasetCompressionLevel

DatasetCompressionLevel: string

Defines values for DatasetCompressionLevel.
KnownDatasetCompressionLevel can be used interchangeably with DatasetCompressionLevel, this enum contains the known values that the service supports.

Known values supported by the service

Optimal
Fastest

DatasetCreateOrUpdateDatasetResponse

DatasetCreateOrUpdateDatasetResponse: DatasetResource

Contains response data for the createOrUpdateDataset operation.

DatasetDebugResource

DatasetDebugResource: SubResourceDebugResource & { properties: DatasetUnion }

Dataset debug resource.

DatasetGetDatasetResponse

DatasetGetDatasetResponse: DatasetResource

Contains response data for the getDataset operation.

DatasetGetDatasetsByWorkspaceNextResponse

DatasetGetDatasetsByWorkspaceNextResponse: DatasetListResponse

Contains response data for the getDatasetsByWorkspaceNext operation.

DatasetGetDatasetsByWorkspaceResponse

DatasetGetDatasetsByWorkspaceResponse: DatasetListResponse

Contains response data for the getDatasetsByWorkspace operation.

DatasetLocationUnion

DatasetReferenceType

DatasetReferenceType: string

Defines values for DatasetReferenceType.
KnownDatasetReferenceType can be used interchangeably with DatasetReferenceType, this enum contains the known values that the service supports.

Known values supported by the service

DatasetReference

DatasetResource

DatasetResource: SubResource & { properties: DatasetUnion }

Dataset resource type.

DatasetStorageFormatUnion

DatasetUnion

DatasetUnion: Dataset | AmazonS3Dataset | AvroDataset | ExcelDataset | ParquetDataset | DelimitedTextDataset | JsonDataset | XmlDataset | OrcDataset | BinaryDataset | AzureBlobDataset | AzureTableDataset | AzureSqlTableDataset | AzureSqlMITableDataset | AzureSqlDWTableDataset | CassandraTableDataset | CustomDataset | CosmosDbSqlApiCollectionDataset | DocumentDbCollectionDataset | DynamicsEntityDataset | DynamicsCrmEntityDataset | CommonDataServiceForAppsEntityDataset | AzureDataLakeStoreDataset | AzureBlobFSDataset | Office365Dataset | FileShareDataset | MongoDbCollectionDataset | MongoDbAtlasCollectionDataset | MongoDbV2CollectionDataset | CosmosDbMongoDbApiCollectionDataset | ODataResourceDataset | OracleTableDataset | AmazonRdsForOracleTableDataset | TeradataTableDataset | AzureMySqlTableDataset | AmazonRedshiftTableDataset | Db2TableDataset | RelationalTableDataset | InformixTableDataset | OdbcTableDataset | MySqlTableDataset | PostgreSqlTableDataset | MicrosoftAccessTableDataset | SalesforceObjectDataset | SalesforceServiceCloudObjectDataset | SybaseTableDataset | SapBwCubeDataset | SapCloudForCustomerResourceDataset | SapEccResourceDataset | SapHanaTableDataset | SapOpenHubTableDataset | SqlServerTableDataset | AmazonRdsForSqlServerTableDataset | RestResourceDataset | SapTableResourceDataset | WebTableDataset | AzureSearchIndexDataset | HttpDataset | AmazonMWSObjectDataset | AzurePostgreSqlTableDataset | ConcurObjectDataset | CouchbaseTableDataset | DrillTableDataset | EloquaObjectDataset | GoogleBigQueryObjectDataset | GreenplumTableDataset | HBaseObjectDataset | HiveObjectDataset | HubspotObjectDataset | ImpalaObjectDataset | JiraObjectDataset | MagentoObjectDataset | MariaDBTableDataset | AzureMariaDBTableDataset | MarketoObjectDataset | PaypalObjectDataset | PhoenixObjectDataset | PrestoObjectDataset | QuickBooksObjectDataset | ServiceNowObjectDataset | ShopifyObjectDataset | SparkObjectDataset | SquareObjectDataset | XeroObjectDataset | ZohoObjectDataset | NetezzaTableDataset | VerticaTableDataset | SalesforceMarketingCloudObjectDataset | ResponsysObjectDataset | DynamicsAXResourceDataset | OracleServiceCloudObjectDataset | AzureDataExplorerTableDataset | GoogleAdWordsObjectDataset | SnowflakeDataset | SharePointOnlineListResourceDataset | AzureDatabricksDeltaLakeDataset

DayOfWeek

DayOfWeek: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"

Defines values for DayOfWeek.

Db2AuthenticationType

Db2AuthenticationType: string

Defines values for Db2AuthenticationType.
KnownDb2AuthenticationType can be used interchangeably with Db2AuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Basic

Db2LinkedService

Db2LinkedService: LinkedService & { authenticationType?: Db2AuthenticationType; certificateCommonName?: any; connectionString?: any; database: any; encryptedCredential?: any; packageCollection?: any; password?: SecretBaseUnion; server: any; type: "Db2"; username?: any }

Linked service for DB2 data source.

Db2Source

Db2Source: TabularSource & { query?: any; type: "Db2Source" }

A copy activity source for Db2 databases.

Db2TableDataset

Db2TableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "Db2Table" }

The Db2 table dataset.

DeleteActivity

DeleteActivity: ExecutionActivity & { dataset: DatasetReference; enableLogging?: any; logStorageSettings?: LogStorageSettings; maxConcurrentConnections?: undefined | number; recursive?: any; storeSettings?: StoreReadSettingsUnion; type: "Delete" }

Delete activity.

DelimitedTextDataset

DelimitedTextDataset: Dataset & { columnDelimiter?: any; compressionCodec?: any; compressionLevel?: any; encodingName?: any; escapeChar?: any; firstRowAsHeader?: any; location?: DatasetLocationUnion; nullValue?: any; quoteChar?: any; rowDelimiter?: any; type: "DelimitedText" }

Delimited text dataset.

DelimitedTextReadSettings

DelimitedTextReadSettings: FormatReadSettings & { compressionProperties?: CompressionReadSettingsUnion; skipLineCount?: any; type: "DelimitedTextReadSettings" }

Delimited text read settings.

DelimitedTextSink

DelimitedTextSink: CopySink & { formatSettings?: DelimitedTextWriteSettings; storeSettings?: StoreWriteSettingsUnion; type: "DelimitedTextSink" }

A copy activity DelimitedText sink.

DelimitedTextSource

DelimitedTextSource: CopySource & { additionalColumns?: any; formatSettings?: DelimitedTextReadSettings; storeSettings?: StoreReadSettingsUnion; type: "DelimitedTextSource" }

A copy activity DelimitedText source.

DelimitedTextWriteSettings

DelimitedTextWriteSettings: FormatWriteSettings & { fileExtension: any; fileNamePrefix?: any; maxRowsPerFile?: any; quoteAllText?: any; type: "DelimitedTextWriteSettings" }

Delimited text write settings.

DependencyCondition

DependencyCondition: string

Defines values for DependencyCondition.
KnownDependencyCondition can be used interchangeably with DependencyCondition, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed
Skipped
Completed

DependencyReferenceUnion

DocumentDbCollectionDataset

DocumentDbCollectionDataset: Dataset & { collectionName: any; type: "DocumentDbCollection" }

Microsoft Azure Document Database Collection dataset.

DocumentDbCollectionSink

DocumentDbCollectionSink: CopySink & { nestingSeparator?: any; type: "DocumentDbCollectionSink"; writeBehavior?: any }

A copy activity Document Database Collection sink.

DocumentDbCollectionSource

DocumentDbCollectionSource: CopySource & { additionalColumns?: any; nestingSeparator?: any; query?: any; queryTimeout?: any; type: "DocumentDbCollectionSource" }

A copy activity Document Database Collection source.

DrillLinkedService

DrillLinkedService: LinkedService & { connectionString?: any; encryptedCredential?: any; pwd?: AzureKeyVaultSecretReference; type: "Drill" }

Drill server linked service.

DrillSource

DrillSource: TabularSource & { query?: any; type: "DrillSource" }

A copy activity Drill server source.

DrillTableDataset

DrillTableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "DrillTable" }

Drill server dataset.

DynamicsAXLinkedService

DynamicsAXLinkedService: LinkedService & { aadResourceId: any; encryptedCredential?: any; servicePrincipalId: any; servicePrincipalKey: SecretBaseUnion; tenant: any; type: "DynamicsAX"; url: any }

Dynamics AX linked service.

DynamicsAXResourceDataset

DynamicsAXResourceDataset: Dataset & { path: any; type: "DynamicsAXResource" }

The path of the Dynamics AX OData entity.

DynamicsAXSource

DynamicsAXSource: TabularSource & { httpRequestTimeout?: any; query?: any; type: "DynamicsAXSource" }

A copy activity Dynamics AX source.

DynamicsAuthenticationType

DynamicsAuthenticationType: string

Defines values for DynamicsAuthenticationType.
KnownDynamicsAuthenticationType can be used interchangeably with DynamicsAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Office365
Ifd
AADServicePrincipal

DynamicsCrmEntityDataset

DynamicsCrmEntityDataset: Dataset & { entityName?: any; type: "DynamicsCrmEntity" }

The Dynamics CRM entity dataset.

DynamicsCrmLinkedService

DynamicsCrmLinkedService: LinkedService & { authenticationType: any; deploymentType: any; encryptedCredential?: any; hostName?: any; organizationName?: any; password?: SecretBaseUnion; port?: any; servicePrincipalCredential?: SecretBaseUnion; servicePrincipalCredentialType?: any; servicePrincipalId?: any; serviceUri?: any; type: "DynamicsCrm"; username?: any }

Dynamics CRM linked service.

DynamicsCrmSink

DynamicsCrmSink: CopySink & { alternateKeyName?: any; ignoreNullValues?: any; type: "DynamicsCrmSink"; writeBehavior: DynamicsSinkWriteBehavior }

A copy activity Dynamics CRM sink.

DynamicsCrmSource

DynamicsCrmSource: CopySource & { additionalColumns?: any; query?: any; type: "DynamicsCrmSource" }

A copy activity Dynamics CRM source.

DynamicsDeploymentType

DynamicsDeploymentType: string

Defines values for DynamicsDeploymentType.
KnownDynamicsDeploymentType can be used interchangeably with DynamicsDeploymentType, this enum contains the known values that the service supports.

Known values supported by the service

Online
OnPremisesWithIfd

DynamicsEntityDataset

DynamicsEntityDataset: Dataset & { entityName?: any; type: "DynamicsEntity" }

The Dynamics entity dataset.

DynamicsLinkedService

DynamicsLinkedService: LinkedService & { authenticationType: any; deploymentType: any; encryptedCredential?: any; hostName?: any; organizationName?: any; password?: SecretBaseUnion; port?: any; servicePrincipalCredential?: SecretBaseUnion; servicePrincipalCredentialType?: any; servicePrincipalId?: any; serviceUri?: any; type: "Dynamics"; username?: any }

Dynamics linked service.

DynamicsServicePrincipalCredentialType

DynamicsServicePrincipalCredentialType: string

Defines values for DynamicsServicePrincipalCredentialType.
KnownDynamicsServicePrincipalCredentialType can be used interchangeably with DynamicsServicePrincipalCredentialType, this enum contains the known values that the service supports.

Known values supported by the service

ServicePrincipalKey
ServicePrincipalCert

DynamicsSink

DynamicsSink: CopySink & { alternateKeyName?: any; ignoreNullValues?: any; type: "DynamicsSink"; writeBehavior: DynamicsSinkWriteBehavior }

A copy activity Dynamics sink.

DynamicsSinkWriteBehavior

DynamicsSinkWriteBehavior: string

Defines values for DynamicsSinkWriteBehavior.
KnownDynamicsSinkWriteBehavior can be used interchangeably with DynamicsSinkWriteBehavior, this enum contains the known values that the service supports.

Known values supported by the service

Upsert

DynamicsSource

DynamicsSource: CopySource & { additionalColumns?: any; query?: any; type: "DynamicsSource" }

A copy activity Dynamics source.

EloquaLinkedService

EloquaLinkedService: LinkedService & { encryptedCredential?: any; endpoint: any; password?: SecretBaseUnion; type: "Eloqua"; useEncryptedEndpoints?: any; useHostVerification?: any; usePeerVerification?: any; username: any }

Eloqua server linked service.

EloquaObjectDataset

EloquaObjectDataset: Dataset & { tableName?: any; type: "EloquaObject" }

Eloqua server dataset.

EloquaSource

EloquaSource: TabularSource & { query?: any; type: "EloquaSource" }

A copy activity Eloqua server source.

EventSubscriptionStatus

EventSubscriptionStatus: string

Defines values for EventSubscriptionStatus.
KnownEventSubscriptionStatus can be used interchangeably with EventSubscriptionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Provisioning
Deprovisioning
Disabled
Unknown

ExcelDataset

ExcelDataset: Dataset & { compression?: DatasetCompression; firstRowAsHeader?: any; location?: DatasetLocationUnion; nullValue?: any; range?: any; sheetName?: any; type: "Excel" }

Excel dataset.

ExcelSource

ExcelSource: CopySource & { additionalColumns?: any; storeSettings?: StoreReadSettingsUnion; type: "ExcelSource" }

A copy activity excel source.

ExecuteDataFlowActivity

ExecuteDataFlowActivity: ExecutionActivity & { compute?: ExecuteDataFlowActivityTypePropertiesCompute; continueOnError?: any; dataflow: DataFlowReference; integrationRuntime?: IntegrationRuntimeReference; runConcurrently?: any; staging?: DataFlowStagingInfo; traceLevel?: any; type: "ExecuteDataFlow" }

Execute data flow activity.

ExecutePipelineActivity

ExecutePipelineActivity: ControlActivity & { parameters?: undefined | {}; pipeline: PipelineReference; type: "ExecutePipeline"; waitOnCompletion?: undefined | false | true }

Execute pipeline activity.

ExecuteSsisPackageActivity

ExecuteSsisPackageActivity: ExecutionActivity & { connectVia: IntegrationRuntimeReference; environmentPath?: any; executionCredential?: SsisExecutionCredential; logLocation?: SsisLogLocation; loggingLevel?: any; packageConnectionManagers?: undefined | {}; packageLocation: SsisPackageLocation; packageParameters?: undefined | {}; projectConnectionManagers?: undefined | {}; projectParameters?: undefined | {}; propertyOverrides?: undefined | {}; runtime?: any; type: "ExecuteSSISPackage" }

Execute SSIS package activity.

ExecutionActivity

ExecutionActivity: Activity & { linkedServiceName?: LinkedServiceReference; policy?: ActivityPolicy; type: "Execution" | "Copy" | "HDInsightHive" | "HDInsightPig" | "HDInsightMapReduce" | "HDInsightStreaming" | "HDInsightSpark" | "ExecuteSSISPackage" | "Custom" | "SqlServerStoredProcedure" | "Delete" | "AzureDataExplorerCommand" | "Lookup" | "WebActivity" | "GetMetadata" | "AzureMLBatchExecution" | "AzureMLUpdateResource" | "AzureMLExecutePipeline" | "DataLakeAnalyticsU-SQL" | "DatabricksNotebook" | "DatabricksSparkJar" | "DatabricksSparkPython" | "AzureFunctionActivity" | "ExecuteDataFlow" | "Script" | "SynapseNotebook" | "SparkJob" }

Base class for all execution activities.

ExecutionActivityUnion

ExportSettingsUnion

ExpressionType

ExpressionType: string

Defines values for ExpressionType.
KnownExpressionType can be used interchangeably with ExpressionType, this enum contains the known values that the service supports.

Known values supported by the service

Expression

FileServerLinkedService

FileServerLinkedService: LinkedService & { encryptedCredential?: any; host: any; password?: SecretBaseUnion; type: "FileServer"; userId?: any }

File system linked service.

FileServerLocation

FileServerLocation: DatasetLocation & { type: "FileServerLocation" }

The location of file server dataset.

FileServerReadSettings

FileServerReadSettings: StoreReadSettings & { deleteFilesAfterCompletion?: any; enablePartitionDiscovery?: undefined | false | true; fileFilter?: any; fileListPath?: any; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; partitionRootPath?: any; recursive?: any; type: "FileServerReadSettings"; wildcardFileName?: any; wildcardFolderPath?: any }

File server read settings.

FileServerWriteSettings

FileServerWriteSettings: StoreWriteSettings & { type: "FileServerWriteSettings" }

File server write settings.

FileShareDataset

FileShareDataset: Dataset & { compression?: DatasetCompression; fileFilter?: any; fileName?: any; folderPath?: any; format?: DatasetStorageFormatUnion; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; type: "FileShare" }

An on-premises file system dataset.

FileSystemSink

FileSystemSink: CopySink & { copyBehavior?: any; type: "FileSystemSink" }

A copy activity file system sink.

FileSystemSource

FileSystemSource: CopySource & { additionalColumns?: any; recursive?: any; type: "FileSystemSource" }

A copy activity file system source.

FilterActivity

FilterActivity: ControlActivity & { condition: Expression; items: Expression; type: "Filter" }

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

Flowlet

Flowlet: DataFlow & { script?: undefined | string; scriptLines?: string[]; sinks?: DataFlowSink[]; sources?: DataFlowSource[]; transformations?: Transformation[]; type: "Flowlet" }

Data flow flowlet

ForEachActivity

ForEachActivity: ControlActivity & { activities: ActivityUnion[]; batchCount?: undefined | number; isSequential?: undefined | false | true; items: Expression; type: "ForEach" }

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

FormatReadSettingsUnion

FormatWriteSettingsUnion

FtpAuthenticationType

FtpAuthenticationType: string

Defines values for FtpAuthenticationType.
KnownFtpAuthenticationType can be used interchangeably with FtpAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Basic
Anonymous

FtpReadSettings

FtpReadSettings: StoreReadSettings & { deleteFilesAfterCompletion?: any; disableChunking?: any; enablePartitionDiscovery?: undefined | false | true; fileListPath?: any; partitionRootPath?: any; recursive?: any; type: "FtpReadSettings"; useBinaryTransfer?: undefined | false | true; wildcardFileName?: any; wildcardFolderPath?: any }

Ftp read settings.

FtpServerLinkedService

FtpServerLinkedService: LinkedService & { authenticationType?: FtpAuthenticationType; enableServerCertificateValidation?: any; enableSsl?: any; encryptedCredential?: any; host: any; password?: SecretBaseUnion; port?: any; type: "FtpServer"; userName?: any }

A FTP server Linked Service.

FtpServerLocation

FtpServerLocation: DatasetLocation & { type: "FtpServerLocation" }

The location of ftp server dataset.

GetMetadataActivity

GetMetadataActivity: ExecutionActivity & { dataset: DatasetReference; fieldList?: any[]; formatSettings?: FormatReadSettingsUnion; storeSettings?: StoreReadSettingsUnion; type: "GetMetadata" }

Activity to get metadata of dataset

GoogleAdWordsAuthenticationType

GoogleAdWordsAuthenticationType: string

Defines values for GoogleAdWordsAuthenticationType.
KnownGoogleAdWordsAuthenticationType can be used interchangeably with GoogleAdWordsAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

ServiceAuthentication
UserAuthentication

GoogleAdWordsLinkedService

GoogleAdWordsLinkedService: LinkedService & { authenticationType?: GoogleAdWordsAuthenticationType; clientCustomerID?: any; clientId?: any; clientSecret?: SecretBaseUnion; connectionProperties?: any; developerToken?: SecretBaseUnion; email?: any; encryptedCredential?: any; keyFilePath?: any; refreshToken?: SecretBaseUnion; trustedCertPath?: any; type: "GoogleAdWords"; useSystemTrustStore?: any }

Google AdWords service linked service.

GoogleAdWordsObjectDataset

GoogleAdWordsObjectDataset: Dataset & { tableName?: any; type: "GoogleAdWordsObject" }

Google AdWords service dataset.

GoogleAdWordsSource

GoogleAdWordsSource: TabularSource & { query?: any; type: "GoogleAdWordsSource" }

A copy activity Google AdWords service source.

GoogleBigQueryAuthenticationType

GoogleBigQueryAuthenticationType: string

Defines values for GoogleBigQueryAuthenticationType.
KnownGoogleBigQueryAuthenticationType can be used interchangeably with GoogleBigQueryAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

ServiceAuthentication
UserAuthentication

GoogleBigQueryLinkedService

GoogleBigQueryLinkedService: LinkedService & { additionalProjects?: any; authenticationType: GoogleBigQueryAuthenticationType; clientId?: any; clientSecret?: SecretBaseUnion; email?: any; encryptedCredential?: any; keyFilePath?: any; project: any; refreshToken?: SecretBaseUnion; requestGoogleDriveScope?: any; trustedCertPath?: any; type: "GoogleBigQuery"; useSystemTrustStore?: any }

Google BigQuery service linked service.

GoogleBigQueryObjectDataset

GoogleBigQueryObjectDataset: Dataset & { dataset?: any; table?: any; tableName?: any; type: "GoogleBigQueryObject" }

Google BigQuery service dataset.

GoogleBigQuerySource

GoogleBigQuerySource: TabularSource & { query?: any; type: "GoogleBigQuerySource" }

A copy activity Google BigQuery service source.

GoogleCloudStorageLinkedService

GoogleCloudStorageLinkedService: LinkedService & { accessKeyId?: any; encryptedCredential?: any; secretAccessKey?: SecretBaseUnion; serviceUrl?: any; type: "GoogleCloudStorage" }

Linked service for Google Cloud Storage.

GoogleCloudStorageLocation

GoogleCloudStorageLocation: DatasetLocation & { bucketName?: any; type: "GoogleCloudStorageLocation"; version?: any }

The location of Google Cloud Storage dataset.

GoogleCloudStorageReadSettings

GoogleCloudStorageReadSettings: StoreReadSettings & { deleteFilesAfterCompletion?: any; enablePartitionDiscovery?: undefined | false | true; fileListPath?: any; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; partitionRootPath?: any; prefix?: any; recursive?: any; type: "GoogleCloudStorageReadSettings"; wildcardFileName?: any; wildcardFolderPath?: any }

Google Cloud Storage read settings.

GreenplumLinkedService

GreenplumLinkedService: LinkedService & { connectionString?: any; encryptedCredential?: any; pwd?: AzureKeyVaultSecretReference; type: "Greenplum" }

Greenplum Database linked service.

GreenplumSource

GreenplumSource: TabularSource & { query?: any; type: "GreenplumSource" }

A copy activity Greenplum Database source.

GreenplumTableDataset

GreenplumTableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "GreenplumTable" }

Greenplum Database dataset.

HBaseAuthenticationType

HBaseAuthenticationType: string

Defines values for HBaseAuthenticationType.
KnownHBaseAuthenticationType can be used interchangeably with HBaseAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Anonymous
Basic

HBaseLinkedService

HBaseLinkedService: LinkedService & { allowHostNameCNMismatch?: any; allowSelfSignedServerCert?: any; authenticationType: HBaseAuthenticationType; enableSsl?: any; encryptedCredential?: any; host: any; httpPath?: any; password?: SecretBaseUnion; port?: any; trustedCertPath?: any; type: "HBase"; username?: any }

HBase server linked service.

HBaseObjectDataset

HBaseObjectDataset: Dataset & { tableName?: any; type: "HBaseObject" }

HBase server dataset.

HBaseSource

HBaseSource: TabularSource & { query?: any; type: "HBaseSource" }

A copy activity HBase server source.

HDInsightActivityDebugInfoOption

HDInsightActivityDebugInfoOption: string

Defines values for HDInsightActivityDebugInfoOption.
KnownHDInsightActivityDebugInfoOption can be used interchangeably with HDInsightActivityDebugInfoOption, this enum contains the known values that the service supports.

Known values supported by the service

None
Always
Failure

HDInsightHiveActivity

HDInsightHiveActivity: ExecutionActivity & { arguments?: any[]; defines?: undefined | {}; getDebugInfo?: HDInsightActivityDebugInfoOption; queryTimeout?: undefined | number; scriptLinkedService?: LinkedServiceReference; scriptPath?: any; storageLinkedServices?: LinkedServiceReference[]; type: "HDInsightHive"; variables?: any[] }

HDInsight Hive activity type.

HDInsightLinkedService

HDInsightLinkedService: LinkedService & { clusterUri: any; encryptedCredential?: any; fileSystem?: any; hcatalogLinkedServiceName?: LinkedServiceReference; isEspEnabled?: any; linkedServiceName?: LinkedServiceReference; password?: SecretBaseUnion; type: "HDInsight"; userName?: any }

HDInsight linked service.

HDInsightMapReduceActivity

HDInsightMapReduceActivity: ExecutionActivity & { arguments?: any[]; className: any; defines?: undefined | {}; getDebugInfo?: HDInsightActivityDebugInfoOption; jarFilePath: any; jarLibs?: any[]; jarLinkedService?: LinkedServiceReference; storageLinkedServices?: LinkedServiceReference[]; type: "HDInsightMapReduce" }

HDInsight MapReduce activity type.

HDInsightOnDemandLinkedService

HDInsightOnDemandLinkedService: LinkedService & { additionalLinkedServiceNames?: LinkedServiceReference[]; clusterNamePrefix?: any; clusterPassword?: SecretBaseUnion; clusterResourceGroup: any; clusterSize: any; clusterSshPassword?: SecretBaseUnion; clusterSshUserName?: any; clusterType?: any; clusterUserName?: any; coreConfiguration?: any; dataNodeSize?: any; encryptedCredential?: any; hBaseConfiguration?: any; hcatalogLinkedServiceName?: LinkedServiceReference; hdfsConfiguration?: any; headNodeSize?: any; hiveConfiguration?: any; hostSubscriptionId: any; linkedServiceName: LinkedServiceReference; mapReduceConfiguration?: any; oozieConfiguration?: any; scriptActions?: ScriptAction[]; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; sparkVersion?: any; stormConfiguration?: any; subnetName?: any; tenant: any; timeToLive: any; type: "HDInsightOnDemand"; version: any; virtualNetworkId?: any; yarnConfiguration?: any; zookeeperNodeSize?: any }

HDInsight ondemand linked service.

HDInsightPigActivity

HDInsightPigActivity: ExecutionActivity & { arguments?: any; defines?: undefined | {}; getDebugInfo?: HDInsightActivityDebugInfoOption; scriptLinkedService?: LinkedServiceReference; scriptPath?: any; storageLinkedServices?: LinkedServiceReference[]; type: "HDInsightPig" }

HDInsight Pig activity type.

HDInsightSparkActivity

HDInsightSparkActivity: ExecutionActivity & { arguments?: any[]; className?: undefined | string; entryFilePath: any; getDebugInfo?: HDInsightActivityDebugInfoOption; proxyUser?: any; rootPath: any; sparkConfig?: undefined | {}; sparkJobLinkedService?: LinkedServiceReference; type: "HDInsightSpark" }

HDInsight Spark activity.

HDInsightStreamingActivity

HDInsightStreamingActivity: ExecutionActivity & { arguments?: any[]; combiner?: any; commandEnvironment?: any[]; defines?: undefined | {}; fileLinkedService?: LinkedServiceReference; filePaths: any[]; getDebugInfo?: HDInsightActivityDebugInfoOption; input: any; mapper: any; output: any; reducer: any; storageLinkedServices?: LinkedServiceReference[]; type: "HDInsightStreaming" }

HDInsight streaming activity type.

HdfsLinkedService

HdfsLinkedService: LinkedService & { authenticationType?: any; encryptedCredential?: any; password?: SecretBaseUnion; type: "Hdfs"; url: any; userName?: any }

Hadoop Distributed File System (HDFS) linked service.

HdfsLocation

HdfsLocation: DatasetLocation & { type: "HdfsLocation" }

The location of HDFS.

HdfsReadSettings

HdfsReadSettings: StoreReadSettings & { deleteFilesAfterCompletion?: any; distcpSettings?: DistcpSettings; enablePartitionDiscovery?: undefined | false | true; fileListPath?: any; modifiedDatetimeEnd?: any; modifiedDatetimeStart?: any; partitionRootPath?: any; recursive?: any; type: "HdfsReadSettings"; wildcardFileName?: any; wildcardFolderPath?: any }

HDFS read settings.

HdfsSource

HdfsSource: CopySource & { distcpSettings?: DistcpSettings; recursive?: any; type: "HdfsSource" }

A copy activity HDFS source.

HdiNodeTypes

HdiNodeTypes: string

Defines values for HdiNodeTypes.
KnownHdiNodeTypes can be used interchangeably with HdiNodeTypes, this enum contains the known values that the service supports.

Known values supported by the service

Headnode
Workernode
Zookeeper

HiveAuthenticationType

HiveAuthenticationType: string

Defines values for HiveAuthenticationType.
KnownHiveAuthenticationType can be used interchangeably with HiveAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Anonymous
Username
UsernameAndPassword
WindowsAzureHDInsightService

HiveLinkedService

HiveLinkedService: LinkedService & { allowHostNameCNMismatch?: any; allowSelfSignedServerCert?: any; authenticationType: HiveAuthenticationType; enableSsl?: any; encryptedCredential?: any; host: any; httpPath?: any; password?: SecretBaseUnion; port?: any; serverType?: HiveServerType; serviceDiscoveryMode?: any; thriftTransportProtocol?: HiveThriftTransportProtocol; trustedCertPath?: any; type: "Hive"; useNativeQuery?: any; useSystemTrustStore?: any; username?: any; zooKeeperNameSpace?: any }

Hive Server linked service.

HiveObjectDataset

HiveObjectDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "HiveObject" }

Hive Server dataset.

HiveServerType

HiveServerType: string

Defines values for HiveServerType.
KnownHiveServerType can be used interchangeably with HiveServerType, this enum contains the known values that the service supports.

Known values supported by the service

HiveServer1
HiveServer2
HiveThriftServer

HiveSource

HiveSource: TabularSource & { query?: any; type: "HiveSource" }

A copy activity Hive Server source.

HiveThriftTransportProtocol

HiveThriftTransportProtocol: string

Defines values for HiveThriftTransportProtocol.
KnownHiveThriftTransportProtocol can be used interchangeably with HiveThriftTransportProtocol, this enum contains the known values that the service supports.

Known values supported by the service

Binary
SASL
*HTTP *

HttpAuthenticationType

HttpAuthenticationType: string

Defines values for HttpAuthenticationType.
KnownHttpAuthenticationType can be used interchangeably with HttpAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Basic
Anonymous
Digest
Windows
ClientCertificate

HttpDataset

HttpDataset: Dataset & { additionalHeaders?: any; compression?: DatasetCompression; format?: DatasetStorageFormatUnion; relativeUrl?: any; requestBody?: any; requestMethod?: any; type: "HttpFile" }

A file in an HTTP web server.

HttpLinkedService

HttpLinkedService: LinkedService & { authenticationType?: HttpAuthenticationType; certThumbprint?: any; embeddedCertData?: any; enableServerCertificateValidation?: any; encryptedCredential?: any; password?: SecretBaseUnion; type: "HttpServer"; url: any; userName?: any }

Linked service for an HTTP source.

HttpReadSettings

HttpReadSettings: StoreReadSettings & { additionalHeaders?: any; enablePartitionDiscovery?: undefined | false | true; partitionRootPath?: any; requestBody?: any; requestMethod?: any; requestTimeout?: any; type: "HttpReadSettings" }

Sftp read settings.

HttpServerLocation

HttpServerLocation: DatasetLocation & { relativeUrl?: any; type: "HttpServerLocation" }

The location of http server.

HttpSource

HttpSource: CopySource & { httpRequestTimeout?: any; type: "HttpSource" }

A copy activity source for an HTTP file.

HubspotLinkedService

HubspotLinkedService: LinkedService & { accessToken?: SecretBaseUnion; clientId: any; clientSecret?: SecretBaseUnion; encryptedCredential?: any; refreshToken?: SecretBaseUnion; type: "Hubspot"; useEncryptedEndpoints?: any; useHostVerification?: any; usePeerVerification?: any }

Hubspot Service linked service.

HubspotObjectDataset

HubspotObjectDataset: Dataset & { tableName?: any; type: "HubspotObject" }

Hubspot Service dataset.

HubspotSource

HubspotSource: TabularSource & { query?: any; type: "HubspotSource" }

A copy activity Hubspot Service source.

IfConditionActivity

IfConditionActivity: ControlActivity & { expression: Expression; ifFalseActivities?: ActivityUnion[]; ifTrueActivities?: ActivityUnion[]; type: "IfCondition" }

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.

ImpalaAuthenticationType

ImpalaAuthenticationType: string

Defines values for ImpalaAuthenticationType.
KnownImpalaAuthenticationType can be used interchangeably with ImpalaAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Anonymous
SASLUsername
UsernameAndPassword

ImpalaLinkedService

ImpalaLinkedService: LinkedService & { allowHostNameCNMismatch?: any; allowSelfSignedServerCert?: any; authenticationType: ImpalaAuthenticationType; enableSsl?: any; encryptedCredential?: any; host: any; password?: SecretBaseUnion; port?: any; trustedCertPath?: any; type: "Impala"; useSystemTrustStore?: any; username?: any }

Impala server linked service.

ImpalaObjectDataset

ImpalaObjectDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "ImpalaObject" }

Impala server dataset.

ImpalaSource

ImpalaSource: TabularSource & { query?: any; type: "ImpalaSource" }

A copy activity Impala server source.

ImportSettingsUnion

InformixLinkedService

InformixLinkedService: LinkedService & { authenticationType?: any; connectionString: any; credential?: SecretBaseUnion; encryptedCredential?: any; password?: SecretBaseUnion; type: "Informix"; userName?: any }

Informix linked service.

InformixSink

InformixSink: CopySink & { preCopyScript?: any; type: "InformixSink" }

A copy activity Informix sink.

InformixSource

InformixSource: TabularSource & { query?: any; type: "InformixSource" }

A copy activity source for Informix.

InformixTableDataset

InformixTableDataset: Dataset & { tableName?: any; type: "InformixTable" }

The Informix table dataset.

IntegrationRuntimeDebugResource

IntegrationRuntimeDebugResource: SubResourceDebugResource & { properties: IntegrationRuntimeUnion }

Integration runtime debug resource.

IntegrationRuntimeEdition

IntegrationRuntimeEdition: string

Defines values for IntegrationRuntimeEdition.
KnownIntegrationRuntimeEdition can be used interchangeably with IntegrationRuntimeEdition, this enum contains the known values that the service supports.

Known values supported by the service

Standard
Enterprise

IntegrationRuntimeEntityReferenceType

IntegrationRuntimeEntityReferenceType: string

Defines values for IntegrationRuntimeEntityReferenceType.
KnownIntegrationRuntimeEntityReferenceType can be used interchangeably with IntegrationRuntimeEntityReferenceType, this enum contains the known values that the service supports.

Known values supported by the service

IntegrationRuntimeReference
LinkedServiceReference

IntegrationRuntimeLicenseType

IntegrationRuntimeLicenseType: string

Defines values for IntegrationRuntimeLicenseType.
KnownIntegrationRuntimeLicenseType can be used interchangeably with IntegrationRuntimeLicenseType, this enum contains the known values that the service supports.

Known values supported by the service

BasePrice
LicenseIncluded

IntegrationRuntimeReferenceType

IntegrationRuntimeReferenceType: string

Defines values for IntegrationRuntimeReferenceType.
KnownIntegrationRuntimeReferenceType can be used interchangeably with IntegrationRuntimeReferenceType, this enum contains the known values that the service supports.

Known values supported by the service

IntegrationRuntimeReference

IntegrationRuntimeResource

IntegrationRuntimeResource: SubResource & { properties: IntegrationRuntimeUnion }

Integration runtime resource type.

IntegrationRuntimeSsisCatalogPricingTier

IntegrationRuntimeSsisCatalogPricingTier: string

Defines values for IntegrationRuntimeSsisCatalogPricingTier.
KnownIntegrationRuntimeSsisCatalogPricingTier can be used interchangeably with IntegrationRuntimeSsisCatalogPricingTier, this enum contains the known values that the service supports.

Known values supported by the service

Basic
Standard
Premium
PremiumRS

IntegrationRuntimeState

IntegrationRuntimeState: string

Defines values for IntegrationRuntimeState.
KnownIntegrationRuntimeState can be used interchangeably with IntegrationRuntimeState, this enum contains the known values that the service supports.

Known values supported by the service

Initial
Stopped
Started
Starting
Stopping
NeedRegistration
Online
Limited
Offline
AccessDenied

IntegrationRuntimeType

IntegrationRuntimeType: string

Defines values for IntegrationRuntimeType.
KnownIntegrationRuntimeType can be used interchangeably with IntegrationRuntimeType, this enum contains the known values that the service supports.

Known values supported by the service

Managed
SelfHosted

IntegrationRuntimeUnion

IntegrationRuntimesGetResponse

IntegrationRuntimesGetResponse: IntegrationRuntimeResource

Contains response data for the get operation.

IntegrationRuntimesListResponse

IntegrationRuntimesListResponse: IntegrationRuntimeListResponse

Contains response data for the list operation.

JiraLinkedService

JiraLinkedService: LinkedService & { encryptedCredential?: any; host: any; password?: SecretBaseUnion; port?: any; type: "Jira"; useEncryptedEndpoints?: any; useHostVerification?: any; usePeerVerification?: any; username: any }

Jira Service linked service.

JiraObjectDataset

JiraObjectDataset: Dataset & { tableName?: any; type: "JiraObject" }

Jira Service dataset.

JiraSource

JiraSource: TabularSource & { query?: any; type: "JiraSource" }

A copy activity Jira Service source.

JsonDataset

JsonDataset: Dataset & { compression?: DatasetCompression; encodingName?: any; location?: DatasetLocationUnion; type: "Json" }

Json dataset.

JsonFormat

JsonFormat: DatasetStorageFormat & { encodingName?: any; filePattern?: any; jsonNodeReference?: any; jsonPathDefinition?: any; nestingSeparator?: any; type: "JsonFormat" }

The data stored in JSON format.

JsonFormatFilePattern

JsonFormatFilePattern: string

Defines values for JsonFormatFilePattern.
KnownJsonFormatFilePattern can be used interchangeably with JsonFormatFilePattern, this enum contains the known values that the service supports.

Known values supported by the service

setOfObjects
arrayOfObjects

JsonReadSettings

JsonReadSettings: FormatReadSettings & { compressionProperties?: CompressionReadSettingsUnion; type: "JsonReadSettings" }

Json read settings.

JsonSink

JsonSink: CopySink & { formatSettings?: JsonWriteSettings; storeSettings?: StoreWriteSettingsUnion; type: "JsonSink" }

A copy activity Json sink.

JsonSource

JsonSource: CopySource & { additionalColumns?: any; formatSettings?: JsonReadSettings; storeSettings?: StoreReadSettingsUnion; type: "JsonSource" }

A copy activity Json source.

JsonWriteFilePattern

JsonWriteFilePattern: string

Defines values for JsonWriteFilePattern.
KnownJsonWriteFilePattern can be used interchangeably with JsonWriteFilePattern, this enum contains the known values that the service supports.

Known values supported by the service

setOfObjects
arrayOfObjects

JsonWriteSettings

JsonWriteSettings: FormatWriteSettings & { filePattern?: any; type: "JsonWriteSettings" }

Json write settings.

KqlScriptCreateOrUpdateResponse

KqlScriptCreateOrUpdateResponse: KqlScriptResource

Contains response data for the createOrUpdate operation.

KqlScriptGetByNameResponse

KqlScriptGetByNameResponse: KqlScriptResource

Contains response data for the getByName operation.

KqlScriptsGetAllNextResponse

KqlScriptsGetAllNextResponse: KqlScriptsResourceCollectionResponse

Contains response data for the getAllNext operation.

KqlScriptsGetAllResponse

KqlScriptsGetAllResponse: KqlScriptsResourceCollectionResponse

Contains response data for the getAll operation.

LibraryGetOperationResultResponse

LibraryGetOperationResultResponse: LibraryResource

Contains response data for the getOperationResult operation.

LibraryGetResponse

LibraryGetResponse: LibraryResource

Contains response data for the get operation.

LibraryListNextResponse

LibraryListNextResponse: LibraryListResponse

Contains response data for the listNext operation.

LibraryListOperationResponse

LibraryListOperationResponse: LibraryListResponse

Contains response data for the list operation.

LibraryResource

LibraryResource: SubResource & { properties: LibraryResourceProperties }

Library response details

LinkConnectionCreateOrUpdateLinkConnectionResponse

LinkConnectionCreateOrUpdateLinkConnectionResponse: LinkConnectionResource

Contains response data for the createOrUpdateLinkConnection operation.

LinkConnectionGetDetailedStatusResponse

LinkConnectionGetDetailedStatusResponse: LinkConnectionDetailedStatus

Contains response data for the getDetailedStatus operation.

LinkConnectionGetLinkConnectionResponse

LinkConnectionGetLinkConnectionResponse: LinkConnectionResource

Contains response data for the getLinkConnection operation.

LinkConnectionListLinkConnectionsByWorkspaceNextResponse

LinkConnectionListLinkConnectionsByWorkspaceNextResponse: LinkConnectionListResponse

Contains response data for the listLinkConnectionsByWorkspaceNext operation.

LinkConnectionListLinkConnectionsByWorkspaceResponse

LinkConnectionListLinkConnectionsByWorkspaceResponse: LinkConnectionListResponse

Contains response data for the listLinkConnectionsByWorkspace operation.

LinkConnectionListLinkTablesResponse

LinkConnectionListLinkTablesResponse: LinkTableListResponse

Contains response data for the listLinkTables operation.

LinkConnectionQueryTableStatusResponse

LinkConnectionQueryTableStatusResponse: LinkConnectionQueryTableStatus

Contains response data for the queryTableStatus operation.

LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeKeyAuthorization: LinkedIntegrationRuntimeType & { authorizationType: "Key"; key: SecureString }

The key authorization type integration runtime.

LinkedIntegrationRuntimeRbacAuthorization

LinkedIntegrationRuntimeRbacAuthorization: LinkedIntegrationRuntimeType & { authorizationType: "RBAC"; resourceId: string }

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

LinkedIntegrationRuntimeTypeUnion

LinkedServiceCreateOrUpdateLinkedServiceResponse

LinkedServiceCreateOrUpdateLinkedServiceResponse: LinkedServiceResource

Contains response data for the createOrUpdateLinkedService operation.

LinkedServiceDebugResource

LinkedServiceDebugResource: SubResourceDebugResource & { properties: LinkedServiceUnion }

Linked service debug resource.

LinkedServiceGetLinkedServiceResponse

LinkedServiceGetLinkedServiceResponse: LinkedServiceResource

Contains response data for the getLinkedService operation.

LinkedServiceGetLinkedServicesByWorkspaceNextResponse

LinkedServiceGetLinkedServicesByWorkspaceNextResponse: LinkedServiceListResponse

Contains response data for the getLinkedServicesByWorkspaceNext operation.

LinkedServiceGetLinkedServicesByWorkspaceResponse

LinkedServiceGetLinkedServicesByWorkspaceResponse: LinkedServiceListResponse

Contains response data for the getLinkedServicesByWorkspace operation.

LinkedServiceResource

LinkedServiceResource: SubResource & { properties: LinkedServiceUnion }

Linked service resource type.

LinkedServiceUnion

LinkedServiceUnion: LinkedService | AzureStorageLinkedService | AzureBlobStorageLinkedService | AzureTableStorageLinkedService | AzureSqlDWLinkedService | SqlServerLinkedService | AmazonRdsForSqlServerLinkedService | AzureSqlDatabaseLinkedService | AzureSqlMILinkedService | AzureBatchLinkedService | AzureKeyVaultLinkedService | CosmosDbLinkedService | DynamicsLinkedService | DynamicsCrmLinkedService | CommonDataServiceForAppsLinkedService | HDInsightLinkedService | FileServerLinkedService | AzureFileStorageLinkedService | GoogleCloudStorageLinkedService | OracleLinkedService | AmazonRdsForOracleLinkedService | AzureMySqlLinkedService | MySqlLinkedService | PostgreSqlLinkedService | SybaseLinkedService | Db2LinkedService | TeradataLinkedService | AzureMLLinkedService | AzureMLServiceLinkedService | OdbcLinkedService | InformixLinkedService | MicrosoftAccessLinkedService | HdfsLinkedService | ODataLinkedService | WebLinkedService | CassandraLinkedService | MongoDbLinkedService | MongoDbAtlasLinkedService | MongoDbV2LinkedService | CosmosDbMongoDbApiLinkedService | AzureDataLakeStoreLinkedService | AzureBlobFSLinkedService | Office365LinkedService | SalesforceLinkedService | SalesforceServiceCloudLinkedService | SapCloudForCustomerLinkedService | SapEccLinkedService | SapOpenHubLinkedService | RestServiceLinkedService | TeamDeskLinkedService | QuickbaseLinkedService | SmartsheetLinkedService | ZendeskLinkedService | AmazonS3LinkedService | AmazonRedshiftLinkedService | CustomDataSourceLinkedService | AzureSearchLinkedService | HttpLinkedService | FtpServerLinkedService | SftpServerLinkedService | SapBWLinkedService | SapHanaLinkedService | AmazonMWSLinkedService | AzurePostgreSqlLinkedService | ConcurLinkedService | CouchbaseLinkedService | DrillLinkedService | EloquaLinkedService | GoogleBigQueryLinkedService | GreenplumLinkedService | HBaseLinkedService | HiveLinkedService | HubspotLinkedService | ImpalaLinkedService | JiraLinkedService | MagentoLinkedService | MariaDBLinkedService | AzureMariaDBLinkedService | MarketoLinkedService | PaypalLinkedService | PhoenixLinkedService | PrestoLinkedService | QuickBooksLinkedService | ServiceNowLinkedService | ShopifyLinkedService | SparkLinkedService | SquareLinkedService | XeroLinkedService | ZohoLinkedService | VerticaLinkedService | NetezzaLinkedService | SalesforceMarketingCloudLinkedService | HDInsightOnDemandLinkedService | AzureDataLakeAnalyticsLinkedService | AzureDatabricksLinkedService | AzureDatabricksDeltaLakeLinkedService | ResponsysLinkedService | DynamicsAXLinkedService | OracleServiceCloudLinkedService | GoogleAdWordsLinkedService | SapTableLinkedService | AzureDataExplorerLinkedService | AzureFunctionLinkedService | SnowflakeLinkedService | SharePointOnlineListLinkedService

LivyStates

LivyStates: string

Defines values for LivyStates.
KnownLivyStates can be used interchangeably with LivyStates, this enum contains the known values that the service supports.

Known values supported by the service

not_started
starting
idle
busy
shutting_down
error
dead
killed
success
running
recovering

LookupActivity

LookupActivity: ExecutionActivity & { dataset: DatasetReference; firstRowOnly?: any; source: CopySourceUnion; type: "Lookup" }

Lookup activity.

MagentoLinkedService

MagentoLinkedService: LinkedService & { accessToken?: SecretBaseUnion; encryptedCredential?: any; host: any; type: "Magento"; useEncryptedEndpoints?: any; useHostVerification?: any; usePeerVerification?: any }

Magento server linked service.

MagentoObjectDataset

MagentoObjectDataset: Dataset & { tableName?: any; type: "MagentoObject" }

Magento server dataset.

MagentoSource

MagentoSource: TabularSource & { query?: any; type: "MagentoSource" }

A copy activity Magento server source.

ManagedIntegrationRuntime

ManagedIntegrationRuntime: IntegrationRuntime & { computeProperties?: IntegrationRuntimeComputeProperties; managedVirtualNetwork?: ManagedVirtualNetworkReference; ssisProperties?: IntegrationRuntimeSsisProperties; state?: IntegrationRuntimeState; type: "Managed" }

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

MappingDataFlow

MappingDataFlow: DataFlow & { script?: undefined | string; scriptLines?: string[]; sinks?: DataFlowSink[]; sources?: DataFlowSource[]; transformations?: Transformation[]; type: "MappingDataFlow" }

Mapping data flow.

MariaDBLinkedService

MariaDBLinkedService: LinkedService & { connectionString?: any; encryptedCredential?: any; pwd?: AzureKeyVaultSecretReference; type: "MariaDB" }

MariaDB server linked service.

MariaDBSource

MariaDBSource: TabularSource & { query?: any; type: "MariaDBSource" }

A copy activity MariaDB server source.

MariaDBTableDataset

MariaDBTableDataset: Dataset & { tableName?: any; type: "MariaDBTable" }

MariaDB server dataset.

MarketoLinkedService

MarketoLinkedService: LinkedService & { clientId: any; clientSecret?: SecretBaseUnion; encryptedCredential?: any; endpoint: any; type: "Marketo"; useEncryptedEndpoints?: any; useHostVerification?: any; usePeerVerification?: any }

Marketo server linked service.

MarketoObjectDataset

MarketoObjectDataset: Dataset & { tableName?: any; type: "MarketoObject" }

Marketo server dataset.

MarketoSource

MarketoSource: TabularSource & { query?: any; type: "MarketoSource" }

A copy activity Marketo server source.

MetastoreGetDatabaseOperationsResponse

MetastoreGetDatabaseOperationsResponse: MetastoreRequestSuccessResponse

Contains response data for the getDatabaseOperations operation.

MetastoreRegisterResponse

MetastoreRegisterResponse: MetastoreRegistrationResponse

Contains response data for the register operation.

MetastoreUpdateResponse

MetastoreUpdateResponse: MetastoreUpdationResponse

Contains response data for the update operation.

MicrosoftAccessLinkedService

MicrosoftAccessLinkedService: LinkedService & { authenticationType?: any; connectionString: any; credential?: SecretBaseUnion; encryptedCredential?: any; password?: SecretBaseUnion; type: "MicrosoftAccess"; userName?: any }

Microsoft Access linked service.

MicrosoftAccessSink

MicrosoftAccessSink: CopySink & { preCopyScript?: any; type: "MicrosoftAccessSink" }

A copy activity Microsoft Access sink.

MicrosoftAccessSource

MicrosoftAccessSource: CopySource & { additionalColumns?: any; query?: any; type: "MicrosoftAccessSource" }

A copy activity source for Microsoft Access.

MicrosoftAccessTableDataset

MicrosoftAccessTableDataset: Dataset & { tableName?: any; type: "MicrosoftAccessTable" }

The Microsoft Access table dataset.

MongoDbAtlasCollectionDataset

MongoDbAtlasCollectionDataset: Dataset & { collection: any; type: "MongoDbAtlasCollection" }

The MongoDB Atlas database dataset.

MongoDbAtlasLinkedService

MongoDbAtlasLinkedService: LinkedService & { connectionString: any; database: any; type: "MongoDbAtlas" }

Linked service for MongoDB Atlas data source.

MongoDbAtlasSource

MongoDbAtlasSource: CopySource & { additionalColumns?: any; batchSize?: any; cursorMethods?: MongoDbCursorMethodsProperties; filter?: any; queryTimeout?: any; type: "MongoDbAtlasSource" }

A copy activity source for a MongoDB Atlas database.

MongoDbAuthenticationType

MongoDbAuthenticationType: string

Defines values for MongoDbAuthenticationType.
KnownMongoDbAuthenticationType can be used interchangeably with MongoDbAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Basic
Anonymous

MongoDbCollectionDataset

MongoDbCollectionDataset: Dataset & { collectionName: any; type: "MongoDbCollection" }

The MongoDB database dataset.

MongoDbLinkedService

MongoDbLinkedService: LinkedService & { allowSelfSignedServerCert?: any; authSource?: any; authenticationType?: MongoDbAuthenticationType; databaseName: any; enableSsl?: any; encryptedCredential?: any; password?: SecretBaseUnion; port?: any; server: any; type: "MongoDb"; username?: any }

Linked service for MongoDb data source.

MongoDbSource

MongoDbSource: CopySource & { additionalColumns?: any; query?: any; type: "MongoDbSource" }

A copy activity source for a MongoDB database.

MongoDbV2CollectionDataset

MongoDbV2CollectionDataset: Dataset & { collection: any; type: "MongoDbV2Collection" }

The MongoDB database dataset.

MongoDbV2LinkedService

MongoDbV2LinkedService: LinkedService & { connectionString: any; database: any; type: "MongoDbV2" }

Linked service for MongoDB data source.

MongoDbV2Source

MongoDbV2Source: CopySource & { additionalColumns?: any; batchSize?: any; cursorMethods?: MongoDbCursorMethodsProperties; filter?: any; queryTimeout?: any; type: "MongoDbV2Source" }

A copy activity source for a MongoDB database.

MultiplePipelineTrigger

MultiplePipelineTrigger: Trigger & { pipelines?: TriggerPipelineReference[]; type: "MultiplePipelineTrigger" | "ScheduleTrigger" | "BlobTrigger" | "BlobEventsTrigger" | "CustomEventsTrigger" }

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

MultiplePipelineTriggerUnion

MySqlLinkedService

MySqlLinkedService: LinkedService & { connectionString: any; encryptedCredential?: any; password?: AzureKeyVaultSecretReference; type: "MySql" }

Linked service for MySQL data source.

MySqlSource

MySqlSource: TabularSource & { query?: any; type: "MySqlSource" }

A copy activity source for MySQL databases.

MySqlTableDataset

MySqlTableDataset: Dataset & { tableName?: any; type: "MySqlTable" }

The MySQL table dataset.

NetezzaLinkedService

NetezzaLinkedService: LinkedService & { connectionString?: any; encryptedCredential?: any; pwd?: AzureKeyVaultSecretReference; type: "Netezza" }

Netezza linked service.

NetezzaPartitionOption

NetezzaPartitionOption: string

Defines values for NetezzaPartitionOption.
KnownNetezzaPartitionOption can be used interchangeably with NetezzaPartitionOption, this enum contains the known values that the service supports.

Known values supported by the service

None
DataSlice
DynamicRange

NetezzaSource

NetezzaSource: TabularSource & { partitionOption?: NetezzaPartitionOption; partitionSettings?: NetezzaPartitionSettings; query?: any; type: "NetezzaSource" }

A copy activity Netezza source.

NetezzaTableDataset

NetezzaTableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "NetezzaTable" }

Netezza dataset.

NodeSize

NodeSize: string

Defines values for NodeSize.
KnownNodeSize can be used interchangeably with NodeSize, this enum contains the known values that the service supports.

Known values supported by the service

None
Small
Medium
Large
XLarge
XXLarge
XXXLarge

NodeSizeFamily

NodeSizeFamily: string

Defines values for NodeSizeFamily.
KnownNodeSizeFamily can be used interchangeably with NodeSizeFamily, this enum contains the known values that the service supports.

Known values supported by the service

None
MemoryOptimized

NotebookCreateOrUpdateNotebookResponse

NotebookCreateOrUpdateNotebookResponse: NotebookResource

Contains response data for the createOrUpdateNotebook operation.

NotebookGetNotebookResponse

NotebookGetNotebookResponse: NotebookResource

Contains response data for the getNotebook operation.

NotebookGetNotebookSummaryByWorkSpaceNextResponse

NotebookGetNotebookSummaryByWorkSpaceNextResponse: NotebookListResponse

Contains response data for the getNotebookSummaryByWorkSpaceNext operation.

NotebookGetNotebookSummaryByWorkSpaceResponse

NotebookGetNotebookSummaryByWorkSpaceResponse: NotebookListResponse

Contains response data for the getNotebookSummaryByWorkSpace operation.

NotebookGetNotebooksByWorkspaceNextResponse

NotebookGetNotebooksByWorkspaceNextResponse: NotebookListResponse

Contains response data for the getNotebooksByWorkspaceNext operation.

NotebookGetNotebooksByWorkspaceResponse

NotebookGetNotebooksByWorkspaceResponse: NotebookListResponse

Contains response data for the getNotebooksByWorkspace operation.

NotebookParameterType

NotebookParameterType: string

Defines values for NotebookParameterType.
KnownNotebookParameterType can be used interchangeably with NotebookParameterType, this enum contains the known values that the service supports.

Known values supported by the service

string
int
float
bool

NotebookReferenceType

NotebookReferenceType: string

Defines values for NotebookReferenceType.
KnownNotebookReferenceType can be used interchangeably with NotebookReferenceType, this enum contains the known values that the service supports.

Known values supported by the service

NotebookReference

ODataAadServicePrincipalCredentialType

ODataAadServicePrincipalCredentialType: string

Defines values for ODataAadServicePrincipalCredentialType.
KnownODataAadServicePrincipalCredentialType can be used interchangeably with ODataAadServicePrincipalCredentialType, this enum contains the known values that the service supports.

Known values supported by the service

ServicePrincipalKey
ServicePrincipalCert

ODataAuthenticationType

ODataAuthenticationType: string

Defines values for ODataAuthenticationType.
KnownODataAuthenticationType can be used interchangeably with ODataAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Basic
Anonymous
Windows
AadServicePrincipal
ManagedServiceIdentity

ODataLinkedService

ODataLinkedService: LinkedService & { aadResourceId?: any; aadServicePrincipalCredentialType?: ODataAadServicePrincipalCredentialType; authenticationType?: ODataAuthenticationType; azureCloudType?: any; encryptedCredential?: any; password?: SecretBaseUnion; servicePrincipalEmbeddedCert?: SecretBaseUnion; servicePrincipalEmbeddedCertPassword?: SecretBaseUnion; servicePrincipalId?: any; servicePrincipalKey?: SecretBaseUnion; tenant?: any; type: "OData"; url: any; userName?: any }

Open Data Protocol (OData) linked service.

ODataResourceDataset

ODataResourceDataset: Dataset & { path?: any; type: "ODataResource" }

The Open Data Protocol (OData) resource dataset.

ODataSource

ODataSource: CopySource & { additionalColumns?: any; httpRequestTimeout?: any; query?: any; type: "ODataSource" }

A copy activity source for OData source.

OdbcLinkedService

OdbcLinkedService: LinkedService & { authenticationType?: any; connectionString: any; credential?: SecretBaseUnion; encryptedCredential?: any; password?: SecretBaseUnion; type: "Odbc"; userName?: any }

Open Database Connectivity (ODBC) linked service.

OdbcSink

OdbcSink: CopySink & { preCopyScript?: any; type: "OdbcSink" }

A copy activity ODBC sink.

OdbcSource

OdbcSource: TabularSource & { query?: any; type: "OdbcSource" }

A copy activity source for ODBC databases.

OdbcTableDataset

OdbcTableDataset: Dataset & { tableName?: any; type: "OdbcTable" }

The ODBC table dataset.

Office365Dataset

Office365Dataset: Dataset & { predicate?: any; tableName: any; type: "Office365Table" }

The Office365 account.

Office365LinkedService

Office365LinkedService: LinkedService & { encryptedCredential?: any; office365TenantId: any; servicePrincipalId: any; servicePrincipalKey: SecretBaseUnion; servicePrincipalTenantId: any; type: "Office365" }

Office365 linked service.

Office365Source

Office365Source: CopySource & { allowedGroups?: any; dateFilterColumn?: any; endTime?: any; outputColumns?: any; startTime?: any; type: "Office365Source"; userScopeFilterUri?: any }

A copy activity source for an Office 365 service.

OracleLinkedService

OracleLinkedService: LinkedService & { connectionString: any; encryptedCredential?: any; password?: AzureKeyVaultSecretReference; type: "Oracle" }

Oracle database.

OraclePartitionOption

OraclePartitionOption: string

Defines values for OraclePartitionOption.
KnownOraclePartitionOption can be used interchangeably with OraclePartitionOption, this enum contains the known values that the service supports.

Known values supported by the service

None
PhysicalPartitionsOfTable
DynamicRange

OracleServiceCloudLinkedService

OracleServiceCloudLinkedService: LinkedService & { encryptedCredential?: any; host: any; password: SecretBaseUnion; type: "OracleServiceCloud"; useEncryptedEndpoints?: any; useHostVerification?: any; usePeerVerification?: any; username: any }

Oracle Service Cloud linked service.

OracleServiceCloudObjectDataset

OracleServiceCloudObjectDataset: Dataset & { tableName?: any; type: "OracleServiceCloudObject" }

Oracle Service Cloud dataset.

OracleServiceCloudSource

OracleServiceCloudSource: TabularSource & { query?: any; type: "OracleServiceCloudSource" }

A copy activity Oracle Service Cloud source.

OracleSink

OracleSink: CopySink & { preCopyScript?: any; type: "OracleSink" }

A copy activity Oracle sink.

OracleSource

OracleSource: CopySource & { additionalColumns?: any; oracleReaderQuery?: any; partitionOption?: OraclePartitionOption; partitionSettings?: OraclePartitionSettings; queryTimeout?: any; type: "OracleSource" }

A copy activity Oracle source.

OracleTableDataset

OracleTableDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "OracleTable" }

The on-premises Oracle database dataset.

OrcCompressionCodec

OrcCompressionCodec: string

Defines values for OrcCompressionCodec.
KnownOrcCompressionCodec can be used interchangeably with OrcCompressionCodec, this enum contains the known values that the service supports.

Known values supported by the service

none
zlib
snappy
lzo

OrcDataset

OrcDataset: Dataset & { location?: DatasetLocationUnion; orcCompressionCodec?: any; type: "Orc" }

ORC dataset.

OrcFormat

OrcFormat: DatasetStorageFormat & { type: "OrcFormat" }

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

OrcSink

OrcSink: CopySink & { formatSettings?: OrcWriteSettings; storeSettings?: StoreWriteSettingsUnion; type: "OrcSink" }

A copy activity ORC sink.

OrcSource

OrcSource: CopySource & { additionalColumns?: any; storeSettings?: StoreReadSettingsUnion; type: "OrcSource" }

A copy activity ORC source.

OrcWriteSettings

OrcWriteSettings: FormatWriteSettings & { fileNamePrefix?: any; maxRowsPerFile?: any; type: "OrcWriteSettings" }

Orc write settings.

ParameterType

ParameterType: string

Defines values for ParameterType.
KnownParameterType can be used interchangeably with ParameterType, this enum contains the known values that the service supports.

Known values supported by the service

Object
String
Int
Float
Bool
Array
SecureString

ParquetCompressionCodecEnum

ParquetCompressionCodecEnum: string

Defines values for ParquetCompressionCodecEnum.
KnownParquetCompressionCodecEnum can be used interchangeably with ParquetCompressionCodecEnum, this enum contains the known values that the service supports.

Known values supported by the service

none
gzip
snappy
lzo

ParquetDataset

ParquetDataset: Dataset & { compressionCodec?: any; location?: DatasetLocationUnion; type: "Parquet" }

Parquet dataset.

ParquetFormat

ParquetFormat: DatasetStorageFormat & { type: "ParquetFormat" }

The data stored in Parquet format.

ParquetSink

ParquetSink: CopySink & { formatSettings?: ParquetWriteSettings; storeSettings?: StoreWriteSettingsUnion; type: "ParquetSink" }

A copy activity Parquet sink.

ParquetSource

ParquetSource: CopySource & { additionalColumns?: any; storeSettings?: StoreReadSettingsUnion; type: "ParquetSource" }

A copy activity Parquet source.

ParquetWriteSettings

ParquetWriteSettings: FormatWriteSettings & { fileNamePrefix?: any; maxRowsPerFile?: any; type: "ParquetWriteSettings" }

Parquet write settings.

PaypalLinkedService

PaypalLinkedService: LinkedService & { clientId: any; clientSecret?: SecretBaseUnion; encryptedCredential?: any; host: any; type: "Paypal"; useEncryptedEndpoints?: any; useHostVerification?: any; usePeerVerification?: any }

Paypal Service linked service.

PaypalObjectDataset

PaypalObjectDataset: Dataset & { tableName?: any; type: "PaypalObject" }

Paypal Service dataset.

PaypalSource

PaypalSource: TabularSource & { query?: any; type: "PaypalSource" }

A copy activity Paypal Service source.

PhoenixAuthenticationType

PhoenixAuthenticationType: string

Defines values for PhoenixAuthenticationType.
KnownPhoenixAuthenticationType can be used interchangeably with PhoenixAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Anonymous
UsernameAndPassword
WindowsAzureHDInsightService

PhoenixLinkedService

PhoenixLinkedService: LinkedService & { allowHostNameCNMismatch?: any; allowSelfSignedServerCert?: any; authenticationType: PhoenixAuthenticationType; enableSsl?: any; encryptedCredential?: any; host: any; httpPath?: any; password?: SecretBaseUnion; port?: any; trustedCertPath?: any; type: "Phoenix"; useSystemTrustStore?: any; username?: any }

Phoenix server linked service.

PhoenixObjectDataset

PhoenixObjectDataset: Dataset & { schemaTypePropertiesSchema?: any; table?: any; tableName?: any; type: "PhoenixObject" }

Phoenix server dataset.

PhoenixSource

PhoenixSource: TabularSource & { query?: any; type: "PhoenixSource" }

A copy activity Phoenix server source.

PipelineCreateOrUpdatePipelineResponse

PipelineCreateOrUpdatePipelineResponse: PipelineResource

Contains response data for the createOrUpdatePipeline operation.

PipelineCreatePipelineRunResponse

PipelineCreatePipelineRunResponse: CreateRunResponse

Contains response data for the createPipelineRun operation.

PipelineGetPipelineResponse

PipelineGetPipelineResponse: PipelineResource

Contains response data for the getPipeline operation.

PipelineGetPipelinesByWorkspaceNextResponse

PipelineGetPipelinesByWorkspaceNextResponse: PipelineListResponse

Contains response data for the getPipelinesByWorkspaceNext operation.

PipelineGetPipelinesByWorkspaceResponse

PipelineGetPipelinesByWorkspaceResponse: PipelineListResponse

Contains response data for the getPipelinesByWorkspace operation.

PipelineReferenceType

PipelineReferenceType: string