Data Flow Debug Session - Add Data Flow

Service:: Data Factory

API Version:: 2018-06-01

Add a data flow into debug session.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/addDataFlowToDebugSession?api-version=2018-06-01

URI Parameters

Name	In	Required	Type	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	The factory name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	The resource group name.
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The API version.

Request Body

Name	Type	Description
dataFlow	DataFlowDebugResource	Data flow instance.
dataFlows	DataFlowDebugResource[]	List of Data flows
datasets	DatasetDebugResource[]	List of datasets.
debugSettings	DebugSettings	Data flow debug settings.
linkedServices	LinkedServiceDebugResource[]	List of linked services.
sessionId	string	The ID of data flow debug session.
staging	DataFlowStagingInfo	Staging info for debug session.

Responses

Name	Type	Description
200 OK	AddDataFlowToDebugSessionResponse	OK.
Other Status Codes	CloudError	An error response received from the Azure Data Factory service.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

DataFlowDebugSession_AddDataFlow

Sample request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/addDataFlowToDebugSession?api-version=2018-06-01

{
  "dataFlow": {
    "name": "dataflow1",
    "properties": {
      "type": "MappingDataFlow",
      "typeProperties": {
        "sources": [
          {
            "dataset": {
              "referenceName": "DelimitedText2",
              "type": "DatasetReference"
            },
            "name": "source1"
          }
        ],
        "sinks": [],
        "transformations": [],
        "script": "\n\nsource(output(\n\t\tColumn_1 as string\n\t),\n\tallowSchemaDrift: true,\n\tvalidateSchema: false) ~> source1"
      }
    }
  },
  "datasets": [
    {
      "name": "dataset1",
      "properties": {
        "linkedServiceName": {
          "referenceName": "linkedService5",
          "type": "LinkedServiceReference"
        },
        "annotations": [],
        "type": "DelimitedText",
        "typeProperties": {
          "location": {
            "type": "AzureBlobStorageLocation",
            "fileName": "Ansiencoding.csv",
            "container": "dataflow-sample-data"
          },
          "columnDelimiter": ",",
          "escapeChar": "\\",
          "firstRowAsHeader": true,
          "quoteChar": "\""
        },
        "schema": [
          {
            "type": "String"
          }
        ]
      }
    }
  ],
  "linkedServices": [
    {
      "name": "linkedService1",
      "properties": {
        "type": "AzureBlobStorage",
        "typeProperties": {
          "connectionString": "DefaultEndpointsProtocol=https;AccountName=<storageName>;EndpointSuffix=core.windows.net;",
          "encryptedCredential": "<credential>"
        },
        "annotations": []
      }
    }
  ],
  "debugSettings": {
    "sourceSettings": [
      {
        "sourceName": "source1",
        "rowLimit": 1000
      },
      {
        "sourceName": "source2",
        "rowLimit": 222
      }
    ],
    "parameters": {
      "sourcePath": "Toy"
    },
    "datasetParameters": {
      "Movies": {
        "path": "abc"
      },
      "Output": {
        "time": "def"
      }
    }
  },
  "sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e"
}


import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.datafactory.models.AzureBlobStorageLinkedService;
import com.azure.resourcemanager.datafactory.models.AzureBlobStorageLocation;
import com.azure.resourcemanager.datafactory.models.DataFlowDebugPackage;
import com.azure.resourcemanager.datafactory.models.DataFlowDebugPackageDebugSettings;
import com.azure.resourcemanager.datafactory.models.DataFlowDebugResource;
import com.azure.resourcemanager.datafactory.models.DataFlowSource;
import com.azure.resourcemanager.datafactory.models.DataFlowSourceSetting;
import com.azure.resourcemanager.datafactory.models.DatasetDebugResource;
import com.azure.resourcemanager.datafactory.models.DatasetReference;
import com.azure.resourcemanager.datafactory.models.DelimitedTextDataset;
import com.azure.resourcemanager.datafactory.models.LinkedServiceDebugResource;
import com.azure.resourcemanager.datafactory.models.LinkedServiceReference;
import com.azure.resourcemanager.datafactory.models.MappingDataFlow;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DataFlowDebugSession AddDataFlow.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * DataFlowDebugSession_AddDataFlow.json
     */
    /**
     * Sample code: DataFlowDebugSession_AddDataFlow.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void dataFlowDebugSessionAddDataFlow(com.azure.resourcemanager.datafactory.DataFactoryManager manager)
        throws IOException {
        manager.dataFlowDebugSessions().addDataFlowWithResponse("exampleResourceGroup", "exampleFactoryName",
            new DataFlowDebugPackage().withSessionId("f06ed247-9d07-49b2-b05e-2cb4a2fc871e")
                .withDataFlow(new DataFlowDebugResource().withName("dataflow1").withProperties(new MappingDataFlow()
                    .withSources(Arrays.asList(new DataFlowSource().withName("source1")
                        .withDataset(new DatasetReference().withReferenceName("DelimitedText2"))))
                    .withSinks(Arrays.asList()).withTransformations(Arrays.asList()).withScript(
                        "\n\nsource(output(\n\t\tColumn_1 as string\n\t),\n\tallowSchemaDrift: true,\n\tvalidateSchema: false) ~> source1")))
                .withDatasets(Arrays.asList(new DatasetDebugResource().withName("dataset1")
                    .withProperties(new DelimitedTextDataset()
                        .withSchema(SerializerFactory.createDefaultManagementSerializerAdapter()
                            .deserialize("[{\"type\":\"String\"}]", Object.class, SerializerEncoding.JSON))
                        .withLinkedServiceName(new LinkedServiceReference().withReferenceName("linkedService5"))
                        .withAnnotations(Arrays.asList())
                        .withLocation(new AzureBlobStorageLocation().withFileName("Ansiencoding.csv")
                            .withContainer("dataflow-sample-data"))
                        .withColumnDelimiter(",").withQuoteChar("\"").withEscapeChar("\\").withFirstRowAsHeader(true))))
                .withLinkedServices(Arrays.asList(new LinkedServiceDebugResource().withName("linkedService1")
                    .withProperties(new AzureBlobStorageLinkedService().withAnnotations(Arrays.asList())
                        .withConnectionString(
                            "DefaultEndpointsProtocol=https;AccountName=<storageName>;EndpointSuffix=core.windows.net;")
                        .withEncryptedCredential("fakeTokenPlaceholder"))))
                .withDebugSettings(new DataFlowDebugPackageDebugSettings()
                    .withSourceSettings(Arrays.asList(
                        new DataFlowSourceSetting().withSourceName("source1").withRowLimit(1000)
                            .withAdditionalProperties(mapOf()),
                        new DataFlowSourceSetting()
                            .withSourceName("source2").withRowLimit(222).withAdditionalProperties(mapOf())))
                    .withParameters(mapOf("sourcePath", "Toy"))
                    .withDatasetParameters(SerializerFactory.createDefaultManagementSerializerAdapter().deserialize(
                        "{\"Movies\":{\"path\":\"abc\"},\"Output\":{\"time\":\"def\"}}", Object.class,
                        SerializerEncoding.JSON)))
                .withAdditionalProperties(mapOf()),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python data_flow_debug_session_add_data_flow.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.data_flow_debug_session.add_data_flow(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        request={
            "dataFlow": {
                "name": "dataflow1",
                "properties": {
                    "type": "MappingDataFlow",
                    "typeProperties": {
                        "script": "\n\nsource(output(\n\t\tColumn_1 as string\n\t),\n\tallowSchemaDrift: true,\n\tvalidateSchema: false) ~> source1",
                        "sinks": [],
                        "sources": [
                            {
                                "dataset": {"referenceName": "DelimitedText2", "type": "DatasetReference"},
                                "name": "source1",
                            }
                        ],
                        "transformations": [],
                    },
                },
            },
            "datasets": [
                {
                    "name": "dataset1",
                    "properties": {
                        "annotations": [],
                        "linkedServiceName": {"referenceName": "linkedService5", "type": "LinkedServiceReference"},
                        "schema": [{"type": "String"}],
                        "type": "DelimitedText",
                        "typeProperties": {
                            "columnDelimiter": ",",
                            "escapeChar": "\\",
                            "firstRowAsHeader": True,
                            "location": {
                                "container": "dataflow-sample-data",
                                "fileName": "Ansiencoding.csv",
                                "type": "AzureBlobStorageLocation",
                            },
                            "quoteChar": '"',
                        },
                    },
                }
            ],
            "debugSettings": {
                "datasetParameters": {"Movies": {"path": "abc"}, "Output": {"time": "def"}},
                "parameters": {"sourcePath": "Toy"},
                "sourceSettings": [
                    {"rowLimit": 1000, "sourceName": "source1"},
                    {"rowLimit": 222, "sourceName": "source2"},
                ],
            },
            "linkedServices": [
                {
                    "name": "linkedService1",
                    "properties": {
                        "annotations": [],
                        "type": "AzureBlobStorage",
                        "typeProperties": {
                            "connectionString": "DefaultEndpointsProtocol=https;AccountName=<storageName>;EndpointSuffix=core.windows.net;",
                            "encryptedCredential": "<credential>",
                        },
                    },
                }
            ],
            "sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e",
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlowDebugSession_AddDataFlow.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdatafactory_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v10"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8eb3f7a4f66d408152c32b9d647e59147172d533/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlowDebugSession_AddDataFlow.json
func ExampleDataFlowDebugSessionClient_AddDataFlow() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataFlowDebugSessionClient().AddDataFlow(ctx, "exampleResourceGroup", "exampleFactoryName", armdatafactory.DataFlowDebugPackage{
		DataFlow: &armdatafactory.DataFlowDebugResource{
			Name: to.Ptr("dataflow1"),
			Properties: &armdatafactory.MappingDataFlow{
				Type: to.Ptr("MappingDataFlow"),
				TypeProperties: &armdatafactory.MappingDataFlowTypeProperties{
					Script: to.Ptr("\n\nsource(output(\n		Column_1 as string\n	),\n	allowSchemaDrift: true,\n	validateSchema: false) ~> source1"),
					Sinks:  []*armdatafactory.DataFlowSink{},
					Sources: []*armdatafactory.DataFlowSource{
						{
							Name: to.Ptr("source1"),
							Dataset: &armdatafactory.DatasetReference{
								Type:          to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
								ReferenceName: to.Ptr("DelimitedText2"),
							},
						}},
					Transformations: []*armdatafactory.Transformation{},
				},
			},
		},
		Datasets: []*armdatafactory.DatasetDebugResource{
			{
				Name: to.Ptr("dataset1"),
				Properties: &armdatafactory.DelimitedTextDataset{
					Type: to.Ptr("DelimitedText"),
					Schema: []any{
						map[string]any{
							"type": "String",
						},
					},
					Annotations: []any{},
					LinkedServiceName: &armdatafactory.LinkedServiceReference{
						Type:          to.Ptr(armdatafactory.LinkedServiceReferenceTypeLinkedServiceReference),
						ReferenceName: to.Ptr("linkedService5"),
					},
					TypeProperties: &armdatafactory.DelimitedTextDatasetTypeProperties{
						ColumnDelimiter:  ",",
						EscapeChar:       "\\",
						FirstRowAsHeader: true,
						Location: &armdatafactory.AzureBlobStorageLocation{
							Type:      to.Ptr("AzureBlobStorageLocation"),
							FileName:  "Ansiencoding.csv",
							Container: "dataflow-sample-data",
						},
						QuoteChar: "\"",
					},
				},
			}},
		DebugSettings: &armdatafactory.DataFlowDebugPackageDebugSettings{
			DatasetParameters: map[string]any{
				"Movies": map[string]any{
					"path": "abc",
				},
				"Output": map[string]any{
					"time": "def",
				},
			},
			Parameters: map[string]any{
				"sourcePath": "Toy",
			},
			SourceSettings: []*armdatafactory.DataFlowSourceSetting{
				{
					RowLimit:   to.Ptr[int32](1000),
					SourceName: to.Ptr("source1"),
				},
				{
					RowLimit:   to.Ptr[int32](222),
					SourceName: to.Ptr("source2"),
				}},
		},
		LinkedServices: []*armdatafactory.LinkedServiceDebugResource{
			{
				Name: to.Ptr("linkedService1"),
				Properties: &armdatafactory.AzureBlobStorageLinkedService{
					Type:        to.Ptr("AzureBlobStorage"),
					Annotations: []any{},
					TypeProperties: &armdatafactory.AzureBlobStorageLinkedServiceTypeProperties{
						ConnectionString:    "DefaultEndpointsProtocol=https;AccountName=<storageName>;EndpointSuffix=core.windows.net;",
						EncryptedCredential: to.Ptr("<credential>"),
					},
				},
			}},
		SessionID: to.Ptr("f06ed247-9d07-49b2-b05e-2cb4a2fc871e"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AddDataFlowToDebugSessionResponse = armdatafactory.AddDataFlowToDebugSessionResponse{
	// 	JobVersion: to.Ptr("e5328ee7-c524-4207-8ba4-b709010db33d"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Add a data flow into debug session.
 *
 * @summary Add a data flow into debug session.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlowDebugSession_AddDataFlow.json
 */
async function dataFlowDebugSessionAddDataFlow() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const request = {
    dataFlow: {
      name: "dataflow1",
      properties: {
        type: "MappingDataFlow",
        script:
          "\n\nsource(output(\n\t\tColumn_1 as string\n\t),\n\tallowSchemaDrift: true,\n\tvalidateSchema: false) ~> source1",
        sinks: [],
        sources: [
          {
            name: "source1",
            dataset: {
              type: "DatasetReference",
              referenceName: "DelimitedText2",
            },
          },
        ],
        transformations: [],
      },
    },
    datasets: [
      {
        name: "dataset1",
        properties: {
          type: "DelimitedText",
          schema: [{ type: "String" }],
          annotations: [],
          columnDelimiter: ",",
          escapeChar: "\\",
          firstRowAsHeader: true,
          linkedServiceName: {
            type: "LinkedServiceReference",
            referenceName: "linkedService5",
          },
          location: {
            type: "AzureBlobStorageLocation",
            container: "dataflow-sample-data",
            fileName: "Ansiencoding.csv",
          },
          quoteChar: '"',
        },
      },
    ],
    debugSettings: {
      datasetParameters: { Movies: { path: "abc" }, Output: { time: "def" } },
      parameters: { sourcePath: "Toy" },
      sourceSettings: [
        { rowLimit: 1000, sourceName: "source1" },
        { rowLimit: 222, sourceName: "source2" },
      ],
    },
    linkedServices: [
      {
        name: "linkedService1",
        properties: {
          type: "AzureBlobStorage",
          annotations: [],
          connectionString:
            "DefaultEndpointsProtocol=https;AccountName=<storageName>;EndpointSuffix=core.windows.net;",
          encryptedCredential: "<credential>",
        },
      },
    ],
    sessionId: "f06ed247-9d07-49b2-b05e-2cb4a2fc871e",
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.dataFlowDebugSession.addDataFlow(
    resourceGroupName,
    factoryName,
    request,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlowDebugSession_AddDataFlow.json
// this example is just showing the usage of "DataFlowDebugSession_AddDataFlow" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryResource created on azure
// for more information of creating DataFactoryResource, please refer to the document of DataFactoryResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
ResourceIdentifier dataFactoryResourceId = DataFactoryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName);
DataFactoryResource dataFactory = client.GetDataFactoryResource(dataFactoryResourceId);

// invoke the operation
DataFactoryDataFlowDebugPackageContent content = new DataFactoryDataFlowDebugPackageContent
{
    SessionId = Guid.Parse("f06ed247-9d07-49b2-b05e-2cb4a2fc871e"),
    DataFlow = new DataFactoryDataFlowDebugInfo(new DataFactoryMappingDataFlowProperties
    {
        Sources = {new DataFlowSource("source1")
        {
        Dataset = new DatasetReference(DatasetReferenceType.DatasetReference, "DelimitedText2"),
        }},
        Sinks = { },
        Transformations = { },
        Script = "\n\nsource(output(\n\t\tColumn_1 as string\n\t),\n\tallowSchemaDrift: true,\n\tvalidateSchema: false) ~> source1",
    })
    {
        Name = "dataflow1",
    },
    Datasets = {new DataFactoryDatasetDebugInfo(new DelimitedTextDataset(new DataFactoryLinkedServiceReference(default, "linkedService5"))
    {
    DataLocation = new AzureBlobStorageLocation
    {
    Container = null,
    FileName = null,
    },
    ColumnDelimiter = null,
    QuoteChar = null,
    EscapeChar = null,
    FirstRowAsHeader = null,
    Schema = null,
    Annotations = {},
    })
    {
    Name = "dataset1",
    }},
    LinkedServices = {new DataFactoryLinkedServiceDebugInfo(new AzureBlobStorageLinkedService
    {
    ConnectionString = null,
    EncryptedCredential = "<credential>",
    Annotations = {},
    })
    {
    Name = "linkedService1",
    }},
    DebugSettings = new DataFlowDebugPackageDebugSettings
    {
        SourceSettings = {new DataFlowSourceSetting
        {
        SourceName = "source1",
        RowLimit = 1000,
        }, new DataFlowSourceSetting
        {
        SourceName = "source2",
        RowLimit = 222,
        }},
        Parameters =
        {
        ["sourcePath"] = BinaryData.FromObjectAsJson("Toy")
        },
        DatasetParameters = BinaryData.FromObjectAsJson(new
        {
            Movies = new
            {
                path = "abc",
            },
            Output = new
            {
                time = "def",
            },
        }),
    },
};
DataFactoryDataFlowStartDebugSessionResult result = await dataFactory.AddDataFlowToDebugSessionAsync(content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

Date: Sat, 16 Jun 2018 00:40:01 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14989
x-ms-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
x-ms-correlation-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd

{
  "jobVersion": "e5328ee7-c524-4207-8ba4-b709010db33d"
}

Definitions

Name	Description
AddDataFlowToDebugSessionResponse	Response body structure for starting data flow debug session.
AmazonMWSLinkedService	Amazon Marketplace Web Service linked service.
AmazonMWSObjectDataset	Amazon Marketplace Web Service dataset.
AmazonRdsForOracleAuthenticationType	Authentication type for connecting to the AmazonRdsForOracle database. Only used for Version 2.0.
AmazonRdsForOracleLinkedService	AmazonRdsForOracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.
AmazonRdsForOracleTableDataset	The AmazonRdsForOracle database dataset.
AmazonRdsForSqlAuthenticationType	The type used for authentication. Type: string.
AmazonRdsForSqlServerLinkedService	Amazon RDS for SQL Server linked service.
AmazonRdsForSqlServerTableDataset	The Amazon RDS for SQL Server dataset.
AmazonRedshiftLinkedService	Linked service for Amazon Redshift.
AmazonRedshiftTableDataset	The Amazon Redshift table dataset.
AmazonS3CompatibleLinkedService	Linked service for Amazon S3 Compatible.
AmazonS3Dataset	A single Amazon Simple Storage Service (S3) object or a set of S3 objects.
AmazonS3LinkedService	Linked service for Amazon S3.
AppFiguresLinkedService	Linked service for AppFigures.
AsanaLinkedService	Linked service for Asana.
AvroDataset	Avro dataset.
AzureBatchLinkedService	Azure Batch linked service.
AzureBlobDataset	The Azure Blob storage.
AzureBlobFSDataset	The Azure Data Lake Storage Gen2 storage.
AzureBlobFSLinkedService	Azure Data Lake Storage Gen2 linked service.
AzureBlobStorageLinkedService	The azure blob storage linked service.
AzureDatabricksDeltaLakeDataset	Azure Databricks Delta Lake dataset.
AzureDatabricksDeltaLakeLinkedService	Azure Databricks Delta Lake linked service.
AzureDatabricksLinkedService	Azure Databricks linked service.
AzureDataExplorerLinkedService	Azure Data Explorer (Kusto) linked service.
AzureDataExplorerTableDataset	The Azure Data Explorer (Kusto) dataset.
AzureDataLakeAnalyticsLinkedService	Azure Data Lake Analytics linked service.
AzureDataLakeStoreDataset	Azure Data Lake Store dataset.
AzureDataLakeStoreLinkedService	Azure Data Lake Store linked service.
AzureFileStorageLinkedService	Azure File Storage linked service.
AzureFunctionLinkedService	Azure Function linked service.
AzureKeyVaultLinkedService	Azure Key Vault linked service.
AzureKeyVaultSecretReference	Azure Key Vault secret reference.
AzureMariaDBLinkedService	Azure Database for MariaDB linked service.
AzureMariaDBTableDataset	Azure Database for MariaDB dataset.
AzureMLLinkedService	Azure ML Studio Web Service linked service.
AzureMLServiceLinkedService	Azure ML Service linked service.
AzureMySqlLinkedService	Azure MySQL database linked service.
AzureMySqlTableDataset	The Azure MySQL database dataset.
AzurePostgreSqlLinkedService	Azure PostgreSQL linked service.
AzurePostgreSqlTableDataset	Azure PostgreSQL dataset.
AzureSearchIndexDataset	The Azure Search Index.
AzureSearchLinkedService	Linked service for Windows Azure Search Service.
AzureSqlDatabaseAuthenticationType	The type used for authentication. Type: string.
AzureSqlDatabaseLinkedService	Microsoft Azure SQL Database linked service.
AzureSqlDWAuthenticationType	The type used for authentication. Type: string.
AzureSqlDWLinkedService	Azure SQL Data Warehouse linked service.
AzureSqlDWTableDataset	The Azure SQL Data Warehouse dataset.
AzureSqlMIAuthenticationType	The type used for authentication. Type: string.
AzureSqlMILinkedService	Azure SQL Managed Instance linked service.
AzureSqlMITableDataset	The Azure SQL Managed Instance dataset.
AzureSqlTableDataset	The Azure SQL Server database dataset.
AzureStorageAuthenticationType	The type used for authentication. Type: string.
AzureStorageLinkedService	The storage account linked service.
AzureSynapseArtifactsLinkedService	Azure Synapse Analytics (Artifacts) linked service.
AzureTableDataset	The Azure Table storage dataset.
AzureTableStorageLinkedService	The azure table storage linked service.
BinaryDataset	Binary dataset.
CassandraLinkedService	Linked service for Cassandra data source.
CassandraTableDataset	The Cassandra database dataset.
CloudError	The object that defines the structure of an Azure Data Factory error response.
CommonDataServiceForAppsEntityDataset	The Common Data Service for Apps entity dataset.
CommonDataServiceForAppsLinkedService	Common Data Service for Apps linked service.
ConcurLinkedService	Concur Service linked service.
ConcurObjectDataset	Concur Service dataset.
CosmosDbConnectionMode	The connection mode used to access CosmosDB account. Type: string.
CosmosDbLinkedService	Microsoft Azure Cosmos Database (CosmosDB) linked service.
CosmosDbMongoDbApiCollectionDataset	The CosmosDB (MongoDB API) database dataset.
CosmosDbMongoDbApiLinkedService	Linked service for CosmosDB (MongoDB API) data source.
CosmosDbSqlApiCollectionDataset	Microsoft Azure CosmosDB (SQL API) Collection dataset.
CouchbaseLinkedService	Couchbase server linked service.
CouchbaseTableDataset	Couchbase server dataset.
CredentialReference	Credential reference type.
CredentialReferenceType	Credential reference type.
CustomDataSourceLinkedService	Custom linked service.
DataFlow.Folder	The folder that this data flow is in. If not specified, Data flow will appear at the root level.
DataFlowDebugPackage	Request body structure for starting data flow debug session.
DataFlowDebugResource	Data flow debug resource.
DataFlowReference	Data flow reference type.
DataFlowReferenceType	Data flow reference type.
DataFlowSink	Transformation for data flow sink.
DataFlowSource	Transformation for data flow source.
DataFlowSourceSetting	Definition of data flow source setting for debug.
DataFlowStagingInfo	Staging info for execute data flow activity.
DatasetCompression	The compression method used on a dataset.
DatasetDebugResource	Dataset debug resource.
DatasetReference	Dataset reference type.
DataworldLinkedService	Linked service for Dataworld.
Db2AuthenticationType	AuthenticationType to be used for connection. It is mutually exclusive with connectionString property.
Db2LinkedService	Linked service for DB2 data source.
Db2TableDataset	The Db2 table dataset.
DebugSettings	Data flow debug settings.
DelimitedTextDataset	Delimited text dataset.
DocumentDbCollectionDataset	Microsoft Azure Document Database Collection dataset.
DrillLinkedService	Drill server linked service.
DrillTableDataset	Drill server dataset.
DynamicsAXLinkedService	Dynamics AX linked service.
DynamicsAXResourceDataset	The path of the Dynamics AX OData entity.
DynamicsCrmEntityDataset	The Dynamics CRM entity dataset.
DynamicsCrmLinkedService	Dynamics CRM linked service.
DynamicsEntityDataset	The Dynamics entity dataset.
DynamicsLinkedService	Dynamics linked service.
EloquaLinkedService	Eloqua server linked service.
EloquaObjectDataset	Eloqua server dataset.
ExcelDataset	Excel dataset.
FileServerLinkedService	File system linked service.
FileShareDataset	An on-premises file system dataset.
Flowlet	Data flow flowlet
Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
FtpAuthenticationType	The authentication type to be used to connect to the FTP server.
FtpServerLinkedService	A FTP server Linked Service.
GoogleAdWordsAuthenticationType	The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.
GoogleAdWordsLinkedService	Google AdWords service linked service.
GoogleAdWordsObjectDataset	Google AdWords service dataset.
GoogleBigQueryAuthenticationType	The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.
GoogleBigQueryLinkedService	Google BigQuery service linked service.
GoogleBigQueryObjectDataset	Google BigQuery service dataset.
GoogleBigQueryV2AuthenticationType	The OAuth 2.0 authentication mechanism used for authentication.
GoogleBigQueryV2LinkedService	Google BigQuery service linked service.
GoogleBigQueryV2ObjectDataset	Google BigQuery service dataset.
GoogleCloudStorageLinkedService	Linked service for Google Cloud Storage.
GoogleSheetsLinkedService	Linked service for GoogleSheets.
GreenplumAuthenticationType	The authentication type to use. Type: string. Only used for V2.
GreenplumLinkedService	Greenplum Database linked service.
GreenplumTableDataset	Greenplum Database dataset.
HBaseAuthenticationType	The authentication mechanism to use to connect to the HBase server.
HBaseLinkedService	HBase server linked service.
HBaseObjectDataset	HBase server dataset.
HdfsLinkedService	Hadoop Distributed File System (HDFS) linked service.
HDInsightLinkedService	HDInsight linked service.
HDInsightOnDemandLinkedService	HDInsight ondemand linked service.
HiveAuthenticationType	The authentication method used to access the Hive server.
HiveLinkedService	Hive Server linked service.
HiveObjectDataset	Hive Server dataset.
HiveServerType	The type of Hive server.
HiveThriftTransportProtocol	The transport protocol to use in the Thrift layer.
HttpAuthenticationType	The authentication type to be used to connect to the HTTP server.
HttpDataset	A file in an HTTP web server.
HttpLinkedService	Linked service for an HTTP source.
HubspotLinkedService	Hubspot Service linked service.
HubspotObjectDataset	Hubspot Service dataset.
IcebergDataset	Iceberg dataset.
ImpalaAuthenticationType	The authentication type to use.
ImpalaLinkedService	Impala server linked service.
ImpalaObjectDataset	Impala server dataset.
ImpalaThriftTransportProtocol	The transport protocol to use in the Thrift layer (for V2 only). Default value is Binary.
InformixLinkedService	Informix linked service.
InformixTableDataset	The Informix table dataset.
IntegrationRuntimeReference	Integration runtime reference type.
JiraLinkedService	Jira Service linked service.
JiraObjectDataset	Jira Service dataset.
JsonDataset	Json dataset.
LakeHouseLinkedService	Microsoft Fabric Lakehouse linked service.
LakeHouseTableDataset	Microsoft Fabric Lakehouse Table.
LinkedServiceDebugResource	Linked service debug resource.
LinkedServiceReference	Linked service reference type.
MagentoLinkedService	Magento server linked service.
MagentoObjectDataset	Magento server dataset.
MappingDataFlow	Mapping data flow.
MariaDBLinkedService	MariaDB server linked service.
MariaDBTableDataset	MariaDB server dataset.
MarketoLinkedService	Marketo server linked service.
MarketoObjectDataset	Marketo server dataset.
MicrosoftAccessLinkedService	Microsoft Access linked service.
MicrosoftAccessTableDataset	The Microsoft Access table dataset.
MongoDbAtlasCollectionDataset	The MongoDB Atlas database dataset.
MongoDbAtlasLinkedService	Linked service for MongoDB Atlas data source.
MongoDbAuthenticationType	The authentication type to be used to connect to the MongoDB database.
MongoDbCollectionDataset	The MongoDB database dataset.
MongoDbLinkedService	Linked service for MongoDb data source.
MongoDbV2CollectionDataset	The MongoDB database dataset.
MongoDbV2LinkedService	Linked service for MongoDB data source.
MySqlLinkedService	Linked service for MySQL data source.
MySqlTableDataset	The MySQL table dataset.
NetezzaLinkedService	Netezza linked service.
NetezzaTableDataset	Netezza dataset.
ODataAadServicePrincipalCredentialType	Specify the credential type (key or cert) is used for service principal.
ODataAuthenticationType	Type of authentication used to connect to the OData service.
ODataLinkedService	Open Data Protocol (OData) linked service.
ODataResourceDataset	The Open Data Protocol (OData) resource dataset.
OdbcLinkedService	Open Database Connectivity (ODBC) linked service.
OdbcTableDataset	The ODBC table dataset.
Office365Dataset	The Office365 account.
Office365LinkedService	Office365 linked service.
OracleAuthenticationType	Authentication type for connecting to the Oracle database. Only used for Version 2.0.
OracleCloudStorageLinkedService	Linked service for Oracle Cloud Storage.
OracleLinkedService	Oracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.
OracleServiceCloudLinkedService	Oracle Service Cloud linked service.
OracleServiceCloudObjectDataset	Oracle Service Cloud dataset.
OracleTableDataset	The on-premises Oracle database dataset.
OrcDataset	ORC dataset.
ParameterSpecification	Definition of a single parameter for an entity.
ParameterType	Parameter type.
ParquetDataset	Parquet dataset.
PaypalLinkedService	Paypal Service linked service.
PaypalObjectDataset	Paypal Service dataset.
PhoenixAuthenticationType	The authentication mechanism used to connect to the Phoenix server.
PhoenixLinkedService	Phoenix server linked service.
PhoenixObjectDataset	Phoenix server dataset.
PostgreSqlLinkedService	Linked service for PostgreSQL data source.
PostgreSqlTableDataset	The PostgreSQL table dataset.
PostgreSqlV2LinkedService	Linked service for PostgreSQLV2 data source.
PostgreSqlV2TableDataset	The PostgreSQLV2 table dataset.
PowerQuerySource	Power query source.
PrestoAuthenticationType	The authentication mechanism used to connect to the Presto server.
PrestoLinkedService	Presto server linked service. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.
PrestoObjectDataset	Presto server dataset.
QuickbaseLinkedService	Linked service for Quickbase.
QuickBooksLinkedService	QuickBooks server linked service. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.
QuickBooksObjectDataset	QuickBooks server dataset.
RelationalTableDataset	The relational table dataset.
ResponsysLinkedService	Responsys linked service.
ResponsysObjectDataset	Responsys dataset.
RestResourceDataset	A Rest service dataset.
RestServiceAuthenticationType	Type of authentication used to connect to the REST service.
RestServiceLinkedService	Rest Service linked service.
SalesforceLinkedService	Linked service for Salesforce.
SalesforceMarketingCloudLinkedService	Salesforce Marketing Cloud linked service.
SalesforceMarketingCloudObjectDataset	Salesforce Marketing Cloud dataset.
SalesforceObjectDataset	The Salesforce object dataset.
SalesforceServiceCloudLinkedService	Linked service for Salesforce Service Cloud.
SalesforceServiceCloudObjectDataset	The Salesforce Service Cloud object dataset.
SalesforceServiceCloudV2LinkedService	Linked service for Salesforce Service Cloud V2.
SalesforceServiceCloudV2ObjectDataset	The Salesforce Service Cloud V2 object dataset.
SalesforceV2LinkedService	Linked service for Salesforce V2.
SalesforceV2ObjectDataset	The Salesforce V2 object dataset.
SapBwCubeDataset	The SAP BW cube dataset.
SapBWLinkedService	SAP Business Warehouse Linked Service.
SapCloudForCustomerLinkedService	Linked service for SAP Cloud for Customer.
SapCloudForCustomerResourceDataset	The path of the SAP Cloud for Customer OData entity.
SapEccLinkedService	Linked service for SAP ERP Central Component(SAP ECC).
SapEccResourceDataset	The path of the SAP ECC OData entity.
SapHanaAuthenticationType	The authentication type to be used to connect to the SAP HANA server.
SapHanaLinkedService	SAP HANA Linked Service.
SapHanaTableDataset	SAP HANA Table properties.
SapOdpLinkedService	SAP ODP Linked Service.
SapOdpResourceDataset	SAP ODP Resource properties.
SapOpenHubLinkedService	SAP Business Warehouse Open Hub Destination Linked Service.
SapOpenHubTableDataset	Sap Business Warehouse Open Hub Destination Table properties.
SapTableLinkedService	SAP Table Linked Service.
SapTableResourceDataset	SAP Table Resource properties.
ScriptAction	Custom script action to run on HDI ondemand cluster once it's up.
SecureString	Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.
ServiceNowAuthenticationType	The authentication type to use.
ServiceNowLinkedService	ServiceNow server linked service.
ServiceNowObjectDataset	ServiceNow server dataset.
ServiceNowV2AuthenticationType	The authentication type to use.
ServiceNowV2LinkedService	ServiceNowV2 server linked service.
ServiceNowV2ObjectDataset	ServiceNowV2 server dataset.
SftpAuthenticationType	The authentication type to be used to connect to the FTP server.
SftpServerLinkedService	A linked service for an SSH File Transfer Protocol (SFTP) server.
SharePointOnlineListLinkedService	SharePoint Online List linked service.
SharePointOnlineListResourceDataset	The sharepoint online list resource dataset.
ShopifyLinkedService	Shopify Service linked service.
ShopifyObjectDataset	Shopify Service dataset.
SmartsheetLinkedService	Linked service for Smartsheet.
SnowflakeAuthenticationType	The type used for authentication. Type: string.
SnowflakeDataset	The snowflake dataset.
SnowflakeLinkedService	Snowflake linked service.
SnowflakeV2Dataset	The snowflake dataset.
SnowflakeV2LinkedService	Snowflake linked service.
SparkAuthenticationType	The authentication method used to access the Spark server.
SparkLinkedService	Spark Server linked service.
SparkObjectDataset	Spark Server dataset.
SparkServerType	The type of Spark server.
SparkThriftTransportProtocol	The transport protocol to use in the Thrift layer.
SqlAlwaysEncryptedAkvAuthType	Sql always encrypted AKV authentication type. Type: string.
SqlAlwaysEncryptedProperties	Sql always encrypted properties.
SqlServerAuthenticationType	The type used for authentication. Type: string.
SqlServerLinkedService	SQL Server linked service.
SqlServerTableDataset	The on-premises SQL Server dataset.
SquareLinkedService	Square Service linked service.
SquareObjectDataset	Square Service dataset.
SybaseAuthenticationType	AuthenticationType to be used for connection.
SybaseLinkedService	Linked service for Sybase data source.
SybaseTableDataset	The Sybase table dataset.
TeamDeskAuthenticationType	The authentication type to use.
TeamDeskLinkedService	Linked service for TeamDesk.
TeradataAuthenticationType	AuthenticationType to be used for connection.
TeradataLinkedService	Linked service for Teradata data source.
TeradataTableDataset	The Teradata database dataset.
Transformation	A data flow transformation.
TwilioLinkedService	Linked service for Twilio.
Type	Linked service reference type.
ValueType	Type of value copied from source.
VerticaLinkedService	Vertica linked service.
VerticaTableDataset	Vertica dataset.
WarehouseLinkedService	Microsoft Fabric Warehouse linked service.
WarehouseTableDataset	Microsoft Fabric Warehouse dataset.
WebAnonymousAuthentication	A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.
WebBasicAuthentication	A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.
WebClientCertificateAuthentication	A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.
WebLinkedService	Web linked service.
WebTableDataset	The dataset points to a HTML table in the web page.
WranglingDataFlow	Power Query data flow.
XeroLinkedService	Xero Service linked service.
XeroObjectDataset	Xero Service dataset.
XmlDataset	Xml dataset.
ZendeskAuthenticationType	The authentication type to use.
ZendeskLinkedService	Linked service for Zendesk.
ZohoLinkedService	Zoho server linked service.
ZohoObjectDataset	Zoho server dataset.

AddDataFlowToDebugSessionResponse

Object

Response body structure for starting data flow debug session.

Name	Type	Description
jobVersion	string	The ID of data flow debug job version.

AmazonMWSLinkedService

Object

Amazon Marketplace Web Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AmazonMWS	Type of linked service.
typeProperties.accessKeyId	object	The access key id used to access data.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.endpoint	object	The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)
typeProperties.marketplaceID	object	The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)
typeProperties.mwsAuthToken	SecretBase: AzureKeyVaultSecretReference SecureString	The Amazon MWS authentication token.
typeProperties.secretKey	SecretBase: AzureKeyVaultSecretReference SecureString	The secret key used to access data.
typeProperties.sellerID	object	The Amazon seller ID.
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
version	string	Version of the linked service.

AmazonMWSObjectDataset

Object

Amazon Marketplace Web Service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AmazonMWSObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

AmazonRdsForOracleAuthenticationType

Enumeration

Authentication type for connecting to the AmazonRdsForOracle database. Only used for Version 2.0.

Value	Description
Basic

AmazonRdsForOracleLinkedService

Object

AmazonRdsForOracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AmazonRdsForOracle	Type of linked service.
typeProperties.authenticationType	AmazonRdsForOracleAuthenticationType	Authentication type for connecting to the AmazonRdsForOracle database. Only used for Version 2.0.
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0.
typeProperties.cryptoChecksumClient	object	Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0.
typeProperties.cryptoChecksumTypesClient	object	Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0.
typeProperties.enableBulkLoad	object	Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.encryptionClient	object	Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0.
typeProperties.encryptionTypesClient	object	Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0.
typeProperties.fetchSize	object	Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0.
typeProperties.fetchTswtzAsTimestamp	object	Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0.
typeProperties.initialLobFetchSize	object	Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0.
typeProperties.initializationString	object	Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The Azure key vault secret reference of password in connection string.
typeProperties.server	object	The location of AmazonRdsForOracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0.
typeProperties.statementCacheSize	object	Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0.
typeProperties.supportV1DataTypes	object	Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0.
typeProperties.username	object	The AmazonRdsForOracle database username. Type: string. Only used for Version 2.0.
version	string	Version of the linked service.

AmazonRdsForOracleTableDataset

Object

The AmazonRdsForOracle database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AmazonRdsForOracleTable	Type of dataset.
typeProperties.schema	object	The schema name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).

AmazonRdsForSqlAuthenticationType

Enumeration

The type used for authentication. Type: string.

Value	Description
SQL
Windows

AmazonRdsForSqlServerLinkedService

Object

Amazon RDS for SQL Server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AmazonRdsForSqlServer	Type of linked service.
typeProperties.alwaysEncryptedSettings	SqlAlwaysEncryptedProperties	Sql always encrypted properties.
typeProperties.applicationIntent	object	The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string).
typeProperties.authenticationType	AmazonRdsForSqlAuthenticationType	The type used for authentication. Type: string.
typeProperties.commandTimeout	object	The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.connectRetryCount	object	The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer).
typeProperties.connectRetryInterval	object	The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer).
typeProperties.connectTimeout	object	The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.database	object	The name of the database, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.encrypt	object	Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.failoverPartner	object	The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.hostNameInCertificate	object	The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.integratedSecurity	object	Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.loadBalanceTimeout	object	The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.maxPoolSize	object	The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.minPoolSize	object	The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.multiSubnetFailover	object	If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.multipleActiveResultSets	object	When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.packetSize	object	The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The on-premises Windows authentication password.
typeProperties.pooling	object	Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.server	object	The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.trustServerCertificate	object	Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.userName	object	The on-premises Windows authentication user name. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AmazonRdsForSqlServerTableDataset

Object

The Amazon RDS for SQL Server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AmazonRdsForSqlServerTable	Type of dataset.
typeProperties.schema	object	The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

AmazonRedshiftLinkedService

Object

Linked service for Amazon Redshift.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AmazonRedshift	Type of linked service.
typeProperties.database	object	The database name of the Amazon Redshift source. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password of the Amazon Redshift source.
typeProperties.port	object	The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer).
typeProperties.server	object	The name of the Amazon Redshift server. Type: string (or Expression with resultType string).
typeProperties.username	object	The username of the Amazon Redshift source. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AmazonRedshiftTableDataset

Object

The Amazon Redshift table dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AmazonRedshiftTable	Type of dataset.
typeProperties.schema	object	The Amazon Redshift schema name. Type: string (or Expression with resultType string).
typeProperties.table	object	The Amazon Redshift table name. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

AmazonS3CompatibleLinkedService

Object

Linked service for Amazon S3 Compatible.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AmazonS3Compatible	Type of linked service.
typeProperties.accessKeyId	object	The access key identifier of the Amazon S3 Compatible Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.forcePathStyle	object	If true, use S3 path-style access instead of virtual hosted-style access. Default value is false. Type: boolean (or Expression with resultType boolean).
typeProperties.secretAccessKey	SecretBase: AzureKeyVaultSecretReference SecureString	The secret access key of the Amazon S3 Compatible Identity and Access Management (IAM) user.
typeProperties.serviceUrl	object	This value specifies the endpoint to access with the Amazon S3 Compatible Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AmazonS3Dataset

Object

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

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AmazonS3Object	Type of dataset.
typeProperties.bucketName	object	The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
typeProperties.compression	DatasetCompression	The data compression method used for the Amazon S3 object.
typeProperties.format	DatasetStorageFormat	The format of files.
typeProperties.key	object	The key of the Amazon S3 object. Type: string (or Expression with resultType string).
typeProperties.modifiedDatetimeEnd	object	The end of S3 object's modified datetime. Type: string (or Expression with resultType string).
typeProperties.modifiedDatetimeStart	object	The start of S3 object's modified datetime. Type: string (or Expression with resultType string).
typeProperties.prefix	object	The prefix filter for the S3 object name. Type: string (or Expression with resultType string).
typeProperties.version	object	The version for the S3 object. Type: string (or Expression with resultType string).

AmazonS3LinkedService

Object

Linked service for Amazon S3.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AmazonS3	Type of linked service.
typeProperties.accessKeyId	object	The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
typeProperties.authenticationType	object	The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.secretAccessKey	SecretBase: AzureKeyVaultSecretReference SecureString	The secret access key of the Amazon S3 Identity and Access Management (IAM) user.
typeProperties.serviceUrl	object	This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).
typeProperties.sessionToken	SecretBase: AzureKeyVaultSecretReference SecureString	The session token for the S3 temporary security credential.
version	string	Version of the linked service.

AppFiguresLinkedService

Object

Linked service for AppFigures.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AppFigures	Type of linked service.
typeProperties.clientKey	SecretBase: AzureKeyVaultSecretReference SecureString	The client key for the AppFigures source.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password of the AppFigures source.
typeProperties.userName	object	The username of the Appfigures source. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AsanaLinkedService

Object

Linked service for Asana.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Asana	Type of linked service.
typeProperties.apiToken	SecretBase: AzureKeyVaultSecretReference SecureString	The api token for the Asana source.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
version	string	Version of the linked service.

AvroDataset

Object

Avro dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: Avro	Type of dataset.
typeProperties.avroCompressionCodec	object	The data avroCompressionCodec. Type: string (or Expression with resultType string).
typeProperties.avroCompressionLevel	integer minimum: 1 maximum: 9
typeProperties.location	DatasetLocation	The location of the avro storage.

AzureBatchLinkedService

Object

Azure Batch linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureBatch	Type of linked service.
typeProperties.accessKey	SecretBase: AzureKeyVaultSecretReference SecureString	The Azure Batch account access key.
typeProperties.accountName	object	The Azure Batch account name. Type: string (or Expression with resultType string).
typeProperties.batchUri	object	The Azure Batch URI. Type: string (or Expression with resultType string).
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.linkedServiceName	LinkedServiceReference	The Azure Storage linked service reference.
typeProperties.poolName	object	The Azure Batch pool name. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureBlobDataset

Object

The Azure Blob storage.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureBlob	Type of dataset.
typeProperties.compression	DatasetCompression	The data compression method used for the blob storage.
typeProperties.fileName	object	The name of the Azure Blob. Type: string (or Expression with resultType string).
typeProperties.folderPath	object	The path of the Azure Blob storage. Type: string (or Expression with resultType string).
typeProperties.format	DatasetStorageFormat	The format of the Azure Blob storage.
typeProperties.modifiedDatetimeEnd	object	The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string).
typeProperties.modifiedDatetimeStart	object	The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string).
typeProperties.tableRootLocation	object	The root of blob path. Type: string (or Expression with resultType string).

AzureBlobFSDataset

Object

The Azure Data Lake Storage Gen2 storage.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureBlobFSFile	Type of dataset.
typeProperties.compression	DatasetCompression	The data compression method used for the blob storage.
typeProperties.fileName	object	The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string).
typeProperties.folderPath	object	The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string).
typeProperties.format	DatasetStorageFormat	The format of the Azure Data Lake Storage Gen2 storage.

AzureBlobFSLinkedService

Object

Azure Data Lake Storage Gen2 linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureBlobFS	Type of linked service.
typeProperties.accountKey	object	Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).
typeProperties.azureCloudType	object	Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.sasToken	SecretBase: AzureKeyVaultSecretReference SecureString	The Azure key vault secret reference of sasToken in sas uri.
typeProperties.sasUri	object	SAS URI of the Azure Data Lake Storage Gen2 service. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredential	SecretBase: AzureKeyVaultSecretReference SecureString	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account.
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
typeProperties.url	object	Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureBlobStorageLinkedService

Object

The azure blob storage linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureBlobStorage	Type of linked service.
typeProperties.accountKey	AzureKeyVaultSecretReference	The Azure key vault secret reference of accountKey in connection string.
typeProperties.accountKind	object	Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string).
typeProperties.authenticationType	AzureStorageAuthenticationType	The type used for authentication. Type: string.
typeProperties.azureCloudType	object	Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
typeProperties.connectionString	object	The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.containerUri	object	Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string).
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.sasToken	AzureKeyVaultSecretReference	The Azure key vault secret reference of sasToken in sas uri.
typeProperties.sasUri	object	SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.serviceEndpoint	object	Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property.
typeProperties.servicePrincipalId	object	The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The key of the service principal used to authenticate against Azure SQL Data Warehouse.
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureDatabricksDeltaLakeDataset

Object

Azure Databricks Delta Lake dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureDatabricksDeltaLakeDataset	Type of dataset.
typeProperties.database	object	The database name of delta table. Type: string (or Expression with resultType string).
typeProperties.table	object	The name of delta table. Type: string (or Expression with resultType string).

AzureDatabricksDeltaLakeLinkedService

Object

Azure Databricks Delta Lake linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureDatabricksDeltaLake	Type of linked service.
typeProperties.accessToken	SecretBase: AzureKeyVaultSecretReference SecureString	Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.clusterId	object	The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.domain	object	.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.workspaceResourceId	object	Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureDatabricksLinkedService

Object

Azure Databricks linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureDatabricks	Type of linked service.
typeProperties.accessToken	SecretBase: AzureKeyVaultSecretReference SecureString	Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).
typeProperties.authentication	object	Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.dataSecurityMode	object	The data security mode for the Databricks Cluster. Type: string (or Expression with resultType string).
typeProperties.domain	object	.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.existingClusterId	object	The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string).
typeProperties.instancePoolId	object	The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string).
typeProperties.newClusterCustomTags	object	Additional tags for cluster resources. This property is ignored in instance pool configurations.
typeProperties.newClusterDriverNodeType	object	The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string).
typeProperties.newClusterEnableElasticDisk	object	Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean).
typeProperties.newClusterInitScripts	object	User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings).
typeProperties.newClusterLogDestination	object	Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).
typeProperties.newClusterNodeType	object	The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string).
typeProperties.newClusterNumOfWorker	object	If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as '2'. Required if newClusterVersion is specified. Type: string (or Expression with resultType string).
typeProperties.newClusterSparkConf	object	A set of optional, user-specified Spark configuration key-value pairs.
typeProperties.newClusterSparkEnvVars	object	A set of optional, user-specified Spark environment variables key-value pairs.
typeProperties.newClusterVersion	object	If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string).
typeProperties.policyId	object	The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string).
typeProperties.workspaceResourceId	object	Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureDataExplorerLinkedService

Object

Azure Data Explorer (Kusto) linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureDataExplorer	Type of linked service.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.database	object	Database name for connection. Type: string (or Expression with resultType string).
typeProperties.endpoint	object	The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://..kusto.windows.net. Type: string (or Expression with resultType string)
typeProperties.servicePrincipalId	object	The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The key of the service principal used to authenticate against Kusto.
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureDataExplorerTableDataset

Object

The Azure Data Explorer (Kusto) dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureDataExplorerTable	Type of dataset.
typeProperties.table	object	The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string).

AzureDataLakeAnalyticsLinkedService

Object

Azure Data Lake Analytics linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureDataLakeAnalytics	Type of linked service.
typeProperties.accountName	object	The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string).
typeProperties.dataLakeAnalyticsUri	object	Azure Data Lake Analytics URI Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.resourceGroupName	object	Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The Key of the application used to authenticate against the Azure Data Lake Analytics account.
typeProperties.subscriptionId	object	Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureDataLakeStoreDataset

Object

Azure Data Lake Store dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureDataLakeStoreFile	Type of dataset.
typeProperties.compression	DatasetCompression	The data compression method used for the item(s) in the Azure Data Lake Store.
typeProperties.fileName	object	The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string).
typeProperties.folderPath	object	Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).
typeProperties.format	DatasetStorageFormat	The format of the Data Lake Store.

AzureDataLakeStoreLinkedService

Object

Azure Data Lake Store linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureDataLakeStore	Type of linked service.
typeProperties.accountName	object	Data Lake Store account name. Type: string (or Expression with resultType string).
typeProperties.azureCloudType	object	Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.dataLakeStoreUri	object	Data Lake Store service URI. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.resourceGroupName	object	Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The Key of the application used to authenticate against the Azure Data Lake Store account.
typeProperties.subscriptionId	object	Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureFileStorageLinkedService

Object

Azure File Storage linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureFileStorage	Type of linked service.
typeProperties.accountKey	AzureKeyVaultSecretReference	The Azure key vault secret reference of accountKey in connection string.
typeProperties.connectionString	object	The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.fileShare	object	The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).
typeProperties.host	object	Host name of the server. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to logon the server.
typeProperties.sasToken	AzureKeyVaultSecretReference	The Azure key vault secret reference of sasToken in sas uri.
typeProperties.sasUri	object	SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.serviceEndpoint	object	File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property.
typeProperties.snapshot	object	The azure file share snapshot version. Type: string (or Expression with resultType string).
typeProperties.userId	object	User ID to logon the server. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureFunctionLinkedService

Object

Azure Function linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureFunction	Type of linked service.
typeProperties.authentication	object	Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string).
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.functionAppUrl	object	The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net. Type: string (or Expression with resultType string).
typeProperties.functionKey	SecretBase: AzureKeyVaultSecretReference SecureString	Function or Host key for Azure Function App.
typeProperties.resourceId	object	Allowed token audiences for azure function. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureKeyVaultLinkedService

Object

Azure Key Vault linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureKeyVault	Type of linked service.
typeProperties.baseUrl	object	The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string).
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
version	string	Version of the linked service.

AzureKeyVaultSecretReference

Object

Azure Key Vault secret reference.

Name	Type	Description
secretName	object	The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
secretVersion	object	The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
store	LinkedServiceReference	The Azure Key Vault linked service reference.
type	string: AzureKeyVaultSecret	Type of the secret.

AzureMariaDBLinkedService

Object

Azure Database for MariaDB linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureMariaDB	Type of linked service.
typeProperties.connectionString	object	An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.pwd	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
version	string	Version of the linked service.

AzureMariaDBTableDataset

Object

Azure Database for MariaDB dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureMariaDBTable	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

AzureMLLinkedService

Object

Azure ML Studio Web Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureML	Type of linked service.
typeProperties.apiKey	SecretBase: AzureKeyVaultSecretReference SecureString	The API key for accessing the Azure ML model endpoint.
typeProperties.authentication	object	Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.mlEndpoint	object	The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service.
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
typeProperties.updateResourceEndpoint	object	The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureMLServiceLinkedService

Object

Azure ML Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureMLService	Type of linked service.
typeProperties.authentication	object	Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.mlWorkspaceName	object	Azure ML Service workspace name. Type: string (or Expression with resultType string).
typeProperties.resourceGroupName	object	Azure ML Service workspace resource group name. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline.
typeProperties.subscriptionId	object	Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string).
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureMySqlLinkedService

Object

Azure MySQL database linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureMySql	Type of linked service.
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
version	string	Version of the linked service.

AzureMySqlTableDataset

Object

The Azure MySQL database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureMySqlTable	Type of dataset.
typeProperties.table	object	The name of Azure MySQL database table. Type: string (or Expression with resultType string).
typeProperties.tableName	object	The Azure MySQL database table name. Type: string (or Expression with resultType string).

AzurePostgreSqlLinkedService

Object

Azure PostgreSQL linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzurePostgreSql	Type of linked service.
typeProperties.azureCloudType	object	Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
typeProperties.commandTimeout	object	The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer.
typeProperties.connectionString	object	An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.database	object	Database name for connection. Type: string.
typeProperties.encoding	object	Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
typeProperties.port	object	The port for the connection. Type: integer.
typeProperties.readBufferSize	object	Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer.
typeProperties.server	object	Server name for connection. Type: string.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalEmbeddedCert	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalEmbeddedCertPassword	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The key of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server.
typeProperties.sslMode	object	SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer.
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
typeProperties.timeout	object	The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer.
typeProperties.timezone	object	Gets or sets the session timezone. Type: string.
typeProperties.trustServerCertificate	object	Whether to trust the server certificate without validating it. Type: boolean.
typeProperties.username	object	Username for authentication. Type: string.
version	string	Version of the linked service.

AzurePostgreSqlTableDataset

Object

Azure PostgreSQL dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzurePostgreSqlTable	Type of dataset.
typeProperties.schema	object	The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).
typeProperties.tableName	object	The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string).

AzureSearchIndexDataset

Object

The Azure Search Index.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureSearchIndex	Type of dataset.
typeProperties.indexName	object	The name of the Azure Search Index. Type: string (or Expression with resultType string).

AzureSearchLinkedService

Object

Linked service for Windows Azure Search Service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureSearch	Type of linked service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.key	SecretBase: AzureKeyVaultSecretReference SecureString	Admin Key for Azure Search service
typeProperties.url	object	URL for Azure Search service. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureSqlDatabaseAuthenticationType

Enumeration

The type used for authentication. Type: string.

Value	Description
SQL
ServicePrincipal
SystemAssignedManagedIdentity
UserAssignedManagedIdentity

AzureSqlDatabaseLinkedService

Object

Microsoft Azure SQL Database linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureSqlDatabase	Type of linked service.
typeProperties.alwaysEncryptedSettings	SqlAlwaysEncryptedProperties	Sql always encrypted properties.
typeProperties.applicationIntent	object	The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string).
typeProperties.authenticationType	AzureSqlDatabaseAuthenticationType	The type used for authentication. Type: string.
typeProperties.azureCloudType	object	Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
typeProperties.commandTimeout	object	The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.connectRetryCount	object	The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer).
typeProperties.connectRetryInterval	object	The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer).
typeProperties.connectTimeout	object	The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.database	object	The name of the database, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.encrypt	object	Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.failoverPartner	object	The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.hostNameInCertificate	object	The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.integratedSecurity	object	Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.loadBalanceTimeout	object	The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.maxPoolSize	object	The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.minPoolSize	object	The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.multiSubnetFailover	object	If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.multipleActiveResultSets	object	When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.packetSize	object	The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
typeProperties.pooling	object	Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.server	object	The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalCredential	SecretBase: AzureKeyVaultSecretReference SecureString	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The key of the service principal used to authenticate against Azure SQL Database.
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
typeProperties.trustServerCertificate	object	Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.userName	object	The user name to be used when connecting to server. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureSqlDWAuthenticationType

Enumeration

The type used for authentication. Type: string.

Value	Description
SQL
ServicePrincipal
SystemAssignedManagedIdentity
UserAssignedManagedIdentity

AzureSqlDWLinkedService

Object

Azure SQL Data Warehouse linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureSqlDW	Type of linked service.
typeProperties.applicationIntent	object	The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string).
typeProperties.authenticationType	AzureSqlDWAuthenticationType	The type used for authentication. Type: string.
typeProperties.azureCloudType	object	Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
typeProperties.commandTimeout	object	The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.connectRetryCount	object	The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer).
typeProperties.connectRetryInterval	object	The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer).
typeProperties.connectTimeout	object	The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.database	object	The name of the database, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.encrypt	object	Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.failoverPartner	object	The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.hostNameInCertificate	object	The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.integratedSecurity	object	Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.loadBalanceTimeout	object	The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.maxPoolSize	object	The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.minPoolSize	object	The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.multiSubnetFailover	object	If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.multipleActiveResultSets	object	When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.packetSize	object	The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
typeProperties.pooling	object	Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.server	object	The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalCredential	SecretBase: AzureKeyVaultSecretReference SecureString	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The key of the service principal used to authenticate against Azure SQL Data Warehouse.
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
typeProperties.trustServerCertificate	object	Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.userName	object	The user name to be used when connecting to server. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureSqlDWTableDataset

Object

The Azure SQL Data Warehouse dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureSqlDWTable	Type of dataset.
typeProperties.schema	object	The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

AzureSqlMIAuthenticationType

Enumeration

The type used for authentication. Type: string.

Value	Description
SQL
ServicePrincipal
SystemAssignedManagedIdentity
UserAssignedManagedIdentity

AzureSqlMILinkedService

Object

Azure SQL Managed Instance linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureSqlMI	Type of linked service.
typeProperties.alwaysEncryptedSettings	SqlAlwaysEncryptedProperties	Sql always encrypted properties.
typeProperties.applicationIntent	object	The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string).
typeProperties.authenticationType	AzureSqlMIAuthenticationType	The type used for authentication. Type: string.
typeProperties.azureCloudType	object	Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
typeProperties.commandTimeout	object	The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.connectRetryCount	object	The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer).
typeProperties.connectRetryInterval	object	The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer).
typeProperties.connectTimeout	object	The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.database	object	The name of the database, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.encrypt	object	Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.failoverPartner	object	The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.hostNameInCertificate	object	The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.integratedSecurity	object	Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.loadBalanceTimeout	object	The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.maxPoolSize	object	The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.minPoolSize	object	The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.multiSubnetFailover	object	If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.multipleActiveResultSets	object	When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.packetSize	object	The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
typeProperties.pooling	object	Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.server	object	The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalCredential	SecretBase: AzureKeyVaultSecretReference SecureString	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The key of the service principal used to authenticate against Azure SQL Managed Instance.
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
typeProperties.trustServerCertificate	object	Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.userName	object	The user name to be used when connecting to server. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureSqlMITableDataset

Object

The Azure SQL Managed Instance dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureSqlMITable	Type of dataset.
typeProperties.schema	object	The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

AzureSqlTableDataset

Object

The Azure SQL Server database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureSqlTable	Type of dataset.
typeProperties.schema	object	The schema name of the Azure SQL database. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Azure SQL database. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

AzureStorageAuthenticationType

Enumeration

The type used for authentication. Type: string.

Value	Description
AccountKey
Anonymous
Msi
SasUri
ServicePrincipal

AzureStorageLinkedService

Object

The storage account linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureStorage	Type of linked service.
typeProperties.accountKey	AzureKeyVaultSecretReference	The Azure key vault secret reference of accountKey in connection string.
typeProperties.connectionString	object	The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.sasToken	AzureKeyVaultSecretReference	The Azure key vault secret reference of sasToken in sas uri.
typeProperties.sasUri	object	SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
version	string	Version of the linked service.

AzureSynapseArtifactsLinkedService

Object

Azure Synapse Analytics (Artifacts) linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureSynapseArtifacts	Type of linked service.
typeProperties.authentication	object	Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string).
typeProperties.endpoint	object	https://.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string).
typeProperties.workspaceResourceId	object	The resource ID of the Synapse workspace. The format should be: /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/providers/Microsoft.Synapse/workspaces/{workspaceName}. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

AzureTableDataset

Object

The Azure Table storage dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: AzureTable	Type of dataset.
typeProperties.tableName	object	The table name of the Azure Table storage. Type: string (or Expression with resultType string).

AzureTableStorageLinkedService

Object

The azure table storage linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: AzureTableStorage	Type of linked service.
typeProperties.accountKey	AzureKeyVaultSecretReference	The Azure key vault secret reference of accountKey in connection string.
typeProperties.connectionString	object	The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.sasToken	AzureKeyVaultSecretReference	The Azure key vault secret reference of sasToken in sas uri.
typeProperties.sasUri	object	SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.serviceEndpoint	object	Table service endpoint of the Azure Table Storage resource. It is mutually exclusive with connectionString, sasUri property.
version	string	Version of the linked service.

BinaryDataset

Object

Binary dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: Binary	Type of dataset.
typeProperties.compression	DatasetCompression	The data compression method used for the binary dataset.
typeProperties.location	DatasetLocation	The location of the Binary storage.

CassandraLinkedService

Object

Linked service for Cassandra data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Cassandra	Type of linked service.
typeProperties.authenticationType	object	AuthenticationType to be used for connection. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	Host name for connection. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for authentication.
typeProperties.port	object	The port for the connection. Type: integer (or Expression with resultType integer).
typeProperties.username	object	Username for authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

CassandraTableDataset

Object

The Cassandra database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: CassandraTable	Type of dataset.
typeProperties.keyspace	object	The keyspace of the Cassandra database. Type: string (or Expression with resultType string).
typeProperties.tableName	object	The table name of the Cassandra database. Type: string (or Expression with resultType string).

CloudError

Object

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

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

CommonDataServiceForAppsEntityDataset

Object

The Common Data Service for Apps entity dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: CommonDataServiceForAppsEntity	Type of dataset.
typeProperties.entityName	object	The logical name of the entity. Type: string (or Expression with resultType string).

CommonDataServiceForAppsLinkedService

Object

Common Data Service for Apps linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: CommonDataServiceForApps	Type of linked service.
typeProperties.authenticationType	object	The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string).
typeProperties.deploymentType	object	The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string).
typeProperties.domain	object	The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.hostName	object	The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
typeProperties.organizationName	object	The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to access the Common Data Service for Apps instance.
typeProperties.port	object	The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.
typeProperties.servicePrincipalCredential	SecretBase: AzureKeyVaultSecretReference SecureString	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
typeProperties.serviceUri	object	The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).
typeProperties.username	object	User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

ConcurLinkedService

Object

Concur Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Concur	Type of linked service.
typeProperties.clientId	object	Application client_id supplied by Concur App Management.
typeProperties.connectionProperties	object	Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name that you provided in the username field.
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
typeProperties.username	object	The user name that you use to access Concur Service.
version	string	Version of the linked service.

ConcurObjectDataset

Object

Concur Service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: ConcurObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

CosmosDbConnectionMode

Enumeration

The connection mode used to access CosmosDB account. Type: string.

Value	Description
Direct
Gateway

CosmosDbLinkedService

Object

Microsoft Azure Cosmos Database (CosmosDB) linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: CosmosDb	Type of linked service.
typeProperties.accountEndpoint	object	The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string)
typeProperties.accountKey	SecretBase: AzureKeyVaultSecretReference SecureString	The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.
typeProperties.azureCloudType	object	Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
typeProperties.connectionMode	CosmosDbConnectionMode	The connection mode used to access CosmosDB account. Type: string.
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.database	object	The name of the database. Type: string (or Expression with resultType string)
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.servicePrincipalCredential	SecretBase: AzureKeyVaultSecretReference SecureString	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string.
typeProperties.servicePrincipalId	object	The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

CosmosDbMongoDbApiCollectionDataset

Object

The CosmosDB (MongoDB API) database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: CosmosDbMongoDbApiCollection	Type of dataset.
typeProperties.collection	object	The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).

CosmosDbMongoDbApiLinkedService

Object

Linked service for CosmosDB (MongoDB API) data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: CosmosDbMongoDbApi	Type of linked service.
typeProperties.connectionString	object	The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.database	object	The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).
typeProperties.isServerVersionAbove32	object	Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean).
version	string	Version of the linked service.

CosmosDbSqlApiCollectionDataset

Object

Microsoft Azure CosmosDB (SQL API) Collection dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: CosmosDbSqlApiCollection	Type of dataset.
typeProperties.collectionName	object	CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string).

CouchbaseLinkedService

Object

Couchbase server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Couchbase	Type of linked service.
typeProperties.connectionString	object	An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.credString	AzureKeyVaultSecretReference	The Azure key vault secret reference of credString in connection string.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
version	string	Version of the linked service.

CouchbaseTableDataset

Object

Couchbase server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: CouchbaseTable	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

CredentialReference

Object

Credential reference type.

Name	Type	Description
referenceName	string	Reference credential name.
type	CredentialReferenceType	Credential reference type.

CredentialReferenceType

Enumeration

Credential reference type.

Value	Description
CredentialReference

CustomDataSourceLinkedService

Object

Custom linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: CustomDataSource	Type of linked service.
version	string	Version of the linked service.

DataFlow.Folder

Object

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

Name	Type	Description
name	string	The name of the folder that this data flow is in.

DataFlowDebugPackage

Object

Request body structure for starting data flow debug session.

Name	Type	Description
dataFlow	DataFlowDebugResource	Data flow instance.
dataFlows	DataFlowDebugResource[]	List of Data flows
datasets	DatasetDebugResource[]	List of datasets.
debugSettings	DebugSettings	Data flow debug settings.
linkedServices	LinkedServiceDebugResource[]	List of linked services.
sessionId	string	The ID of data flow debug session.
staging	DataFlowStagingInfo	Staging info for debug session.

DataFlowDebugResource

Object

Data flow debug resource.

Name	Type	Description
name	string	The resource name.
properties	DataFlow: Flowlet MappingDataFlow WranglingDataFlow	Data flow properties.

DataFlowReference

Object

Data flow reference type.

Name	Type	Description
datasetParameters	object	Reference data flow parameters from dataset.
parameters	object	Data flow parameters
referenceName	string	Reference data flow name.
type	DataFlowReferenceType	Data flow reference type.

DataFlowReferenceType

Enumeration

Data flow reference type.

Value	Description
DataFlowReference

DataFlowSink

Object

Transformation for data flow sink.

Name	Type	Description
dataset	DatasetReference	Dataset reference.
description	string	Transformation description.
flowlet	DataFlowReference	Flowlet Reference
linkedService	LinkedServiceReference	Linked service reference.
name	string	Transformation name.
rejectedDataLinkedService	LinkedServiceReference	Rejected data linked service reference.
schemaLinkedService	LinkedServiceReference	Schema linked service reference.

DataFlowSource

Object

Transformation for data flow source.

Name	Type	Description
dataset	DatasetReference	Dataset reference.
description	string	Transformation description.
flowlet	DataFlowReference	Flowlet Reference
linkedService	LinkedServiceReference	Linked service reference.
name	string	Transformation name.
schemaLinkedService	LinkedServiceReference	Schema linked service reference.

DataFlowSourceSetting

Object

Definition of data flow source setting for debug.

Name	Type	Description
rowLimit	integer	Defines the row limit of data flow source in debug.
sourceName	string	The data flow source name.

DataFlowStagingInfo

Object

Staging info for execute data flow activity.

Name	Type	Description
folderPath	object	Folder path for staging blob. Type: string (or Expression with resultType string)
linkedService	LinkedServiceReference	Staging linked service reference.

DatasetCompression

Object

The compression method used on a dataset.

Name	Type	Description
level	object	The dataset compression level. Type: string (or Expression with resultType string).
type	object	Type of dataset compression. Type: string (or Expression with resultType string).

DatasetDebugResource

Object

Dataset debug resource.

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

DatasetReference

Object

Dataset reference type.

Name	Type	Description
parameters	object	Arguments for dataset.
referenceName	string	Reference dataset name.
type	enum: DatasetReference	Dataset reference type.

DataworldLinkedService

Object

Linked service for Dataworld.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Dataworld	Type of linked service.
typeProperties.apiToken	SecretBase: AzureKeyVaultSecretReference SecureString	The api token for the Dataworld source.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
version	string	Version of the linked service.

Db2AuthenticationType

Enumeration

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

Value	Description
Basic

Db2LinkedService

Object

Linked service for DB2 data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Db2	Type of linked service.
typeProperties.authenticationType	Db2AuthenticationType	AuthenticationType to be used for connection. It is mutually exclusive with connectionString property.
typeProperties.certificateCommonName	object	Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
typeProperties.connectionString	object	The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.database	object	Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string.
typeProperties.packageCollection	object	Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for authentication.
typeProperties.server	object	Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
typeProperties.username	object	Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

Db2TableDataset

Object

The Db2 table dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: Db2Table	Type of dataset.
typeProperties.schema	object	The Db2 schema name. Type: string (or Expression with resultType string).
typeProperties.table	object	The Db2 table name. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

DebugSettings

Object

Data flow debug settings.

Name	Type	Description
datasetParameters	object	Parameters for dataset.
parameters	object	Data flow parameters.
sourceSettings	DataFlowSourceSetting[]	Source setting for data flow debug.

DelimitedTextDataset

Object

Delimited text dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: DelimitedText	Type of dataset.
typeProperties.columnDelimiter	object	The column delimiter. Type: string (or Expression with resultType string).
typeProperties.compressionCodec	object	The data compressionCodec. Type: string (or Expression with resultType string).
typeProperties.compressionLevel	object	The data compression method used for DelimitedText.
typeProperties.encodingName	object	The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
typeProperties.escapeChar	object	The escape character. Type: string (or Expression with resultType string).
typeProperties.firstRowAsHeader	object	When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
typeProperties.location	DatasetLocation	The location of the delimited text storage.
typeProperties.nullValue	object	The null value string. Type: string (or Expression with resultType string).
typeProperties.quoteChar	object	The quote character. Type: string (or Expression with resultType string).
typeProperties.rowDelimiter	object	The row delimiter. Type: string (or Expression with resultType string).

DocumentDbCollectionDataset

Object

Microsoft Azure Document Database Collection dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: DocumentDbCollection	Type of dataset.
typeProperties.collectionName	object	Document Database collection name. Type: string (or Expression with resultType string).

DrillLinkedService

Object

Drill server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Drill	Type of linked service.
typeProperties.connectionString	object	An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.pwd	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
version	string	Version of the linked service.

DrillTableDataset

Object

Drill server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: DrillTable	Type of dataset.
typeProperties.schema	object	The schema name of the Drill. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Drill. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

DynamicsAXLinkedService

Object

Dynamics AX linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: DynamicsAX	Type of linked service.
typeProperties.aadResourceId	object	Specify the resource you are requesting authorization. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.servicePrincipalId	object	Specify the application's client ID. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the application's key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string).
typeProperties.tenant	object	Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).
typeProperties.url	object	The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint.
version	string	Version of the linked service.

DynamicsAXResourceDataset

Object

The path of the Dynamics AX OData entity.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: DynamicsAXResource	Type of dataset.
typeProperties.path	object	The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string).

DynamicsCrmEntityDataset

Object

The Dynamics CRM entity dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: DynamicsCrmEntity	Type of dataset.
typeProperties.entityName	object	The logical name of the entity. Type: string (or Expression with resultType string).

DynamicsCrmLinkedService

Object

Dynamics CRM linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: DynamicsCrm	Type of linked service.
typeProperties.authenticationType	object	The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string).
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.deploymentType	object	The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string).
typeProperties.domain	object	The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.hostName	object	The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
typeProperties.organizationName	object	The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to access the Dynamics CRM instance.
typeProperties.port	object	The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.
typeProperties.servicePrincipalCredential	SecretBase: AzureKeyVaultSecretReference SecureString	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
typeProperties.serviceUri	object	The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).
typeProperties.username	object	User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

DynamicsEntityDataset

Object

The Dynamics entity dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: DynamicsEntity	Type of dataset.
typeProperties.entityName	object	The logical name of the entity. Type: string (or Expression with resultType string).

DynamicsLinkedService

Object

Dynamics linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Dynamics	Type of linked service.
typeProperties.authenticationType	object	The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string).
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.deploymentType	object	The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string).
typeProperties.domain	object	The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.hostName	object	The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
typeProperties.organizationName	object	The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to access the Dynamics instance.
typeProperties.port	object	The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.
typeProperties.servicePrincipalCredential	SecretBase: AzureKeyVaultSecretReference SecureString	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
typeProperties.serviceUri	object	The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).
typeProperties.username	object	User name to access the Dynamics instance. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

EloquaLinkedService

Object

Eloqua server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Eloqua	Type of linked service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.endpoint	object	The endpoint of the Eloqua server. (i.e. eloqua.example.com)
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name.
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
typeProperties.username	object	The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)
version	string	Version of the linked service.

EloquaObjectDataset

Object

Eloqua server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: EloquaObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

ExcelDataset

Object

Excel dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: Excel	Type of dataset.
typeProperties.compression	DatasetCompression	The data compression method used for the json dataset.
typeProperties.firstRowAsHeader	object	When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
typeProperties.location	DatasetLocation	The location of the excel storage.
typeProperties.nullValue	object	The null value string. Type: string (or Expression with resultType string).
typeProperties.range	object	The partial data of one sheet. Type: string (or Expression with resultType string).
typeProperties.sheetIndex	object	The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer)
typeProperties.sheetName	object	The sheet name of excel file. Type: string (or Expression with resultType string).

FileServerLinkedService

Object

File system linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: FileServer	Type of linked service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	Host name of the server. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to logon the server.
typeProperties.userId	object	User ID to logon the server. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

FileShareDataset

Object

An on-premises file system dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: FileShare	Type of dataset.
typeProperties.compression	DatasetCompression	The data compression method used for the file system.
typeProperties.fileFilter	object	Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).
typeProperties.fileName	object	The name of the on-premises file system. Type: string (or Expression with resultType string).
typeProperties.folderPath	object	The path of the on-premises file system. Type: string (or Expression with resultType string).
typeProperties.format	DatasetStorageFormat	The format of the files.
typeProperties.modifiedDatetimeEnd	object	The end of file's modified datetime. Type: string (or Expression with resultType string).
typeProperties.modifiedDatetimeStart	object	The start of file's modified datetime. Type: string (or Expression with resultType string).

Flowlet

Object

Data flow flowlet

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the data flow.
description	string	The description of the data flow.
folder	DataFlow.Folder	The folder that this data flow is in. If not specified, Data flow will appear at the root level.
type	string: Flowlet	Type of data flow.
typeProperties.script	string	Flowlet script.
typeProperties.scriptLines	string[]	Flowlet script lines.
typeProperties.sinks	DataFlowSink[]	List of sinks in Flowlet.
typeProperties.sources	DataFlowSource[]	List of sources in Flowlet.
typeProperties.transformations	Transformation[]	List of transformations in Flowlet.

Folder

Object

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

Name	Type	Description
name	string	The name of the folder that this Dataset is in.

FtpAuthenticationType

Enumeration

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

Value	Description
Anonymous
Basic

FtpServerLinkedService

Object

A FTP server Linked Service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: FtpServer	Type of linked service.
typeProperties.authenticationType	FtpAuthenticationType	The authentication type to be used to connect to the FTP server.
typeProperties.enableServerCertificateValidation	object	If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.enableSsl	object	If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	Host name of the FTP server. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to logon the FTP server.
typeProperties.port	object	The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0.
typeProperties.userName	object	Username to logon the FTP server. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

GoogleAdWordsAuthenticationType

Enumeration

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

Value	Description
ServiceAuthentication
UserAuthentication

GoogleAdWordsLinkedService

Object

Google AdWords service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: GoogleAdWords	Type of linked service.
typeProperties.authenticationType	GoogleAdWordsAuthenticationType	The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.
typeProperties.clientCustomerID	object	The Client customer ID of the AdWords account that you want to fetch report data for. Type: string (or Expression with resultType string).
typeProperties.clientId	object	The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret of the google application used to acquire the refresh token.
typeProperties.connectionProperties	object	(Deprecated) Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object.
typeProperties.developerToken	SecretBase: AzureKeyVaultSecretReference SecureString	The developer token associated with the manager account that you use to grant access to the AdWords API.
typeProperties.email	object	The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.googleAdsApiVersion	object	The Google Ads API major version such as v14. The supported major versions could be found on https://developers.google.com/google-ads/api/docs/release-notes. Type: string (or Expression with resultType string).
typeProperties.keyFilePath	object	(Deprecated) The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string).
typeProperties.loginCustomerID	object	The customer ID of the Google Ads Manager account through which you want to fetch report data of specific Customer. Type: string (or Expression with resultType string).
typeProperties.privateKey	SecretBase: AzureKeyVaultSecretReference SecureString	The private key that is used to authenticate the service account email address and can only be used on self-hosted IR.
typeProperties.refreshToken	SecretBase: AzureKeyVaultSecretReference SecureString	The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.
typeProperties.supportLegacyDataTypes	object	Specifies whether to use the legacy data type mappings, which maps float, int32 and int64 from Google to string. Do not set this to true unless you want to keep backward compatibility with legacy driver's data type mappings. Type: boolean (or Expression with resultType boolean).
typeProperties.trustedCertPath	object	(Deprecated) The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string).
typeProperties.useSystemTrustStore	object	(Deprecated) Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. Type: boolean (or Expression with resultType boolean).
version	string	Version of the linked service.

GoogleAdWordsObjectDataset

Object

Google AdWords service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: GoogleAdWordsObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

GoogleBigQueryAuthenticationType

Enumeration

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

Value	Description
ServiceAuthentication
UserAuthentication

GoogleBigQueryLinkedService

Object

Google BigQuery service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: GoogleBigQuery	Type of linked service.
typeProperties.additionalProjects	object	A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string).
typeProperties.authenticationType	GoogleBigQueryAuthenticationType	The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.
typeProperties.clientId	object	The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret of the google application used to acquire the refresh token.
typeProperties.email	object	The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.keyFilePath	object	The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string).
typeProperties.project	object	The default BigQuery project to query against. Type: string (or Expression with resultType string).
typeProperties.refreshToken	SecretBase: AzureKeyVaultSecretReference SecureString	The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.
typeProperties.requestGoogleDriveScope	object	Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false. Type: string (or Expression with resultType string).
typeProperties.trustedCertPath	object	The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string).
typeProperties.useSystemTrustStore	object	Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.Type: boolean (or Expression with resultType boolean).
version	string	Version of the linked service.

GoogleBigQueryObjectDataset

Object

Google BigQuery service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: GoogleBigQueryObject	Type of dataset.
typeProperties.dataset	object	The database name of the Google BigQuery. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Google BigQuery. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using database + table properties instead.

GoogleBigQueryV2AuthenticationType

Enumeration

The OAuth 2.0 authentication mechanism used for authentication.

Value	Description
ServiceAuthentication
UserAuthentication

GoogleBigQueryV2LinkedService

Object

Google BigQuery service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: GoogleBigQueryV2	Type of linked service.
typeProperties.authenticationType	GoogleBigQueryV2AuthenticationType	The OAuth 2.0 authentication mechanism used for authentication.
typeProperties.clientId	object	The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret of the google application used to acquire the refresh token.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.keyFileContent	SecretBase: AzureKeyVaultSecretReference SecureString	The content of the .json key file that is used to authenticate the service account. Type: string (or Expression with resultType string).
typeProperties.projectId	object	The default BigQuery project id to query against. Type: string (or Expression with resultType string).
typeProperties.refreshToken	SecretBase: AzureKeyVaultSecretReference SecureString	The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.
version	string	Version of the linked service.

GoogleBigQueryV2ObjectDataset

Object

Google BigQuery service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: GoogleBigQueryV2Object	Type of dataset.
typeProperties.dataset	object	The database name of the Google BigQuery. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Google BigQuery. Type: string (or Expression with resultType string).

GoogleCloudStorageLinkedService

Object

Linked service for Google Cloud Storage.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: GoogleCloudStorage	Type of linked service.
typeProperties.accessKeyId	object	The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.secretAccessKey	SecretBase: AzureKeyVaultSecretReference SecureString	The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user.
typeProperties.serviceUrl	object	This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

GoogleSheetsLinkedService

Object

Linked service for GoogleSheets.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: GoogleSheets	Type of linked service.
typeProperties.apiToken	SecretBase: AzureKeyVaultSecretReference SecureString	The api token for the GoogleSheets source.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
version	string	Version of the linked service.

GreenplumAuthenticationType

Enumeration

The authentication type to use. Type: string. Only used for V2.

Value	Description
Basic

GreenplumLinkedService

Object

Greenplum Database linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Greenplum	Type of linked service.
typeProperties.authenticationType	GreenplumAuthenticationType	The authentication type to use. Type: string. Only used for V2.
typeProperties.commandTimeout	object	The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer. Only used for V2.
typeProperties.connectionString	object	An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.connectionTimeout	object	The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. Only used for V2.
typeProperties.database	object	Database name for connection. Type: string. Only used for V2.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	Host name for connection. Type: string. Only used for V2.
typeProperties.port	object	The port for the connection. Type: integer. Only used for V2.
typeProperties.pwd	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
typeProperties.sslMode	object	SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. Only used for V2.
typeProperties.username	object	Username for authentication. Type: string. Only used for V2.
version	string	Version of the linked service.

GreenplumTableDataset

Object

Greenplum Database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: GreenplumTable	Type of dataset.
typeProperties.schema	object	The schema name of Greenplum. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of Greenplum. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

HBaseAuthenticationType

Enumeration

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

Value	Description
Anonymous
Basic

HBaseLinkedService

Object

HBase server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: HBase	Type of linked service.
typeProperties.allowHostNameCNMismatch	object	Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
typeProperties.allowSelfSignedServerCert	object	Specifies whether to allow self-signed certificates from the server. The default value is false.
typeProperties.authenticationType	HBaseAuthenticationType	The authentication mechanism to use to connect to the HBase server.
typeProperties.enableSsl	object	Specifies whether the connections to the server are encrypted using SSL. The default value is false.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The IP address or host name of the HBase server. (i.e. 192.168.222.160)
typeProperties.httpPath	object	The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name.
typeProperties.port	object	The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.
typeProperties.trustedCertPath	object	The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
typeProperties.username	object	The user name used to connect to the HBase instance.
version	string	Version of the linked service.

HBaseObjectDataset

Object

HBase server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: HBaseObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

HdfsLinkedService

Object

Hadoop Distributed File System (HDFS) linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Hdfs	Type of linked service.
typeProperties.authenticationType	object	Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for Windows authentication.
typeProperties.url	object	The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string).
typeProperties.userName	object	User name for Windows authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

HDInsightLinkedService

Object

HDInsight linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: HDInsight	Type of linked service.
typeProperties.clusterUri	object	HDInsight cluster URI. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.fileSystem	object	Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string).
typeProperties.hcatalogLinkedServiceName	LinkedServiceReference	A reference to the Azure SQL linked service that points to the HCatalog database.
typeProperties.isEspEnabled	object	Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean.
typeProperties.linkedServiceName	LinkedServiceReference	The Azure Storage linked service reference.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	HDInsight cluster password.
typeProperties.userName	object	HDInsight cluster user name. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

HDInsightOnDemandLinkedService

Object

HDInsight ondemand linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: HDInsightOnDemand	Type of linked service.
typeProperties.additionalLinkedServiceNames	LinkedServiceReference[]	Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.
typeProperties.clusterNamePrefix	object	The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).
typeProperties.clusterPassword	SecretBase: AzureKeyVaultSecretReference SecureString	The password to access the cluster.
typeProperties.clusterResourceGroup	object	The resource group where the cluster belongs. Type: string (or Expression with resultType string).
typeProperties.clusterSize	object	Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int).
typeProperties.clusterSshPassword	SecretBase: AzureKeyVaultSecretReference SecureString	The password to SSH remotely connect cluster’s node (for Linux).
typeProperties.clusterSshUserName	object	The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string).
typeProperties.clusterType	object	The cluster type. Type: string (or Expression with resultType string).
typeProperties.clusterUserName	object	The username to access the cluster. Type: string (or Expression with resultType string).
typeProperties.coreConfiguration	object	Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.dataNodeSize	object	Specifies the size of the data node for the HDInsight cluster.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.hBaseConfiguration	object	Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
typeProperties.hcatalogLinkedServiceName	LinkedServiceReference	The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.
typeProperties.hdfsConfiguration	object	Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.
typeProperties.headNodeSize	object	Specifies the size of the head node for the HDInsight cluster.
typeProperties.hiveConfiguration	object	Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
typeProperties.hostSubscriptionId	object	The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).
typeProperties.linkedServiceName	LinkedServiceReference	Azure Storage linked service to be used by the on-demand cluster for storing and processing data.
typeProperties.mapReduceConfiguration	object	Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.
typeProperties.oozieConfiguration	object	Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
typeProperties.scriptActions	ScriptAction[]	Custom script actions to run on HDI ondemand cluster once it's up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.
typeProperties.servicePrincipalId	object	The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The key for the service principal id.
typeProperties.sparkVersion	object	The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).
typeProperties.stormConfiguration	object	Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
typeProperties.subnetName	object	The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string).
typeProperties.tenant	object	The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
typeProperties.timeToLive	object	The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string).
typeProperties.version	object	Version of the HDInsight cluster. Type: string (or Expression with resultType string).
typeProperties.virtualNetworkId	object	The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).
typeProperties.yarnConfiguration	object	Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
typeProperties.zookeeperNodeSize	object	Specifies the size of the Zoo Keeper node for the HDInsight cluster.
version	string	Version of the linked service.

HiveAuthenticationType

Enumeration

The authentication method used to access the Hive server.

Value	Description
Anonymous
Username
UsernameAndPassword
WindowsAzureHDInsightService

HiveLinkedService

Object

Hive Server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Hive	Type of linked service.
typeProperties.allowHostNameCNMismatch	object	Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
typeProperties.allowSelfSignedServerCert	object	Specifies whether to allow self-signed certificates from the server. The default value is false.
typeProperties.authenticationType	HiveAuthenticationType	The authentication method used to access the Hive server.
typeProperties.enableServerCertificateValidation	object	Specifies whether the connections to the server will validate server certificate, the default value is True. Only used for Version 2.0
typeProperties.enableSsl	object	Specifies whether the connections to the server are encrypted using SSL. The default value is false.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).
typeProperties.httpPath	object	The partial URL corresponding to the Hive server.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name that you provided in the Username field
typeProperties.port	object	The TCP port that the Hive server uses to listen for client connections.
typeProperties.serverType	HiveServerType	The type of Hive server.
typeProperties.serviceDiscoveryMode	object	true to indicate using the ZooKeeper service, false not.
typeProperties.thriftTransportProtocol	HiveThriftTransportProtocol	The transport protocol to use in the Thrift layer.
typeProperties.trustedCertPath	object	The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
typeProperties.useNativeQuery	object	Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.
typeProperties.useSystemTrustStore	object	Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
typeProperties.username	object	The user name that you use to access Hive Server.
typeProperties.zooKeeperNameSpace	object	The namespace on ZooKeeper under which Hive Server 2 nodes are added.
version	string	Version of the linked service.

HiveObjectDataset

Object

Hive Server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: HiveObject	Type of dataset.
typeProperties.schema	object	The schema name of the Hive. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Hive. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

HiveServerType

Enumeration

The type of Hive server.

Value	Description
HiveServer1
HiveServer2
HiveThriftServer

HiveThriftTransportProtocol

Enumeration

The transport protocol to use in the Thrift layer.

Value	Description
Binary
HTTP
SASL

HttpAuthenticationType

Enumeration

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

Value	Description
Anonymous
Basic
ClientCertificate
Digest
Windows

HttpDataset

Object

A file in an HTTP web server.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: HttpFile	Type of dataset.
typeProperties.additionalHeaders	object	The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 ... request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).
typeProperties.compression	DatasetCompression	The data compression method used on files.
typeProperties.format	DatasetStorageFormat	The format of files.
typeProperties.relativeUrl	object	The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).
typeProperties.requestBody	object	The body for the HTTP request. Type: string (or Expression with resultType string).
typeProperties.requestMethod	object	The HTTP method for the HTTP request. Type: string (or Expression with resultType string).

HttpLinkedService

Object

Linked service for an HTTP source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: HttpServer	Type of linked service.
typeProperties.authHeaders	object	The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).
typeProperties.authenticationType	HttpAuthenticationType	The authentication type to be used to connect to the HTTP server.
typeProperties.certThumbprint	object	Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).
typeProperties.embeddedCertData	object	Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).
typeProperties.enableServerCertificateValidation	object	If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.
typeProperties.url	object	The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string).
typeProperties.userName	object	User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

HubspotLinkedService

Object

Hubspot Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Hubspot	Type of linked service.
typeProperties.accessToken	SecretBase: AzureKeyVaultSecretReference SecureString	The access token obtained when initially authenticating your OAuth integration.
typeProperties.clientId	object	The client ID associated with your Hubspot application.
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret associated with your Hubspot application.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.refreshToken	SecretBase: AzureKeyVaultSecretReference SecureString	The refresh token obtained when initially authenticating your OAuth integration.
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
version	string	Version of the linked service.

HubspotObjectDataset

Object

Hubspot Service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: HubspotObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

IcebergDataset

Object

Iceberg dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: Iceberg	Type of dataset.
typeProperties.location	DatasetLocation	The location of the iceberg storage. Setting a file name is not allowed for iceberg format.

ImpalaAuthenticationType

Enumeration

The authentication type to use.

Value	Description
Anonymous
SASLUsername
UsernameAndPassword

ImpalaLinkedService

Object

Impala server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Impala	Type of linked service.
typeProperties.allowHostNameCNMismatch	object	Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
typeProperties.allowSelfSignedServerCert	object	Specifies whether to allow self-signed certificates from the server. The default value is false.
typeProperties.authenticationType	ImpalaAuthenticationType	The authentication type to use.
typeProperties.enableServerCertificateValidation	object	Specify whether to enable server SSL certificate validation when you connect.Always use System Trust Store (for V2 only). The default value is true.
typeProperties.enableSsl	object	Specifies whether the connections to the server are encrypted using SSL. The default value is false.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The IP address or host name of the Impala server. (i.e. 192.168.222.160)
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name when using UsernameAndPassword.
typeProperties.port	object	The TCP port that the Impala server uses to listen for client connections. The default value is 21050.
typeProperties.thriftTransportProtocol	ImpalaThriftTransportProtocol	The transport protocol to use in the Thrift layer (for V2 only). Default value is Binary.
typeProperties.trustedCertPath	object	The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
typeProperties.useSystemTrustStore	object	Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
typeProperties.username	object	The user name used to access the Impala server. The default value is anonymous when using SASLUsername.
version	string	Version of the linked service.

ImpalaObjectDataset

Object

Impala server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: ImpalaObject	Type of dataset.
typeProperties.schema	object	The schema name of the Impala. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Impala. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

ImpalaThriftTransportProtocol

Enumeration

The transport protocol to use in the Thrift layer (for V2 only). Default value is Binary.

Value	Description
Binary
HTTP

InformixLinkedService

Object

Informix linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Informix	Type of linked service.
typeProperties.authenticationType	object	Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
typeProperties.connectionString	object	The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string.
typeProperties.credential	SecretBase: AzureKeyVaultSecretReference SecureString	The access credential portion of the connection string specified in driver-specific property-value format.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for Basic authentication.
typeProperties.userName	object	User name for Basic authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

InformixTableDataset

Object

The Informix table dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: InformixTable	Type of dataset.
typeProperties.tableName	object	The Informix table name. Type: string (or Expression with resultType string).

IntegrationRuntimeReference

Object

Integration runtime reference type.

Name	Type	Description
parameters	object	Arguments for integration runtime.
referenceName	string	Reference integration runtime name.
type	enum: IntegrationRuntimeReference	Type of integration runtime.

JiraLinkedService

Object

Jira Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Jira	Type of linked service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The IP address or host name of the Jira service. (e.g. jira.example.com)
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name that you provided in the username field.
typeProperties.port	object	The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
typeProperties.username	object	The user name that you use to access Jira Service.
version	string	Version of the linked service.

JiraObjectDataset

Object

Jira Service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: JiraObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

JsonDataset

Object

Json dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: Json	Type of dataset.
typeProperties.compression	DatasetCompression	The data compression method used for the json dataset.
typeProperties.encodingName	object	The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
typeProperties.location	DatasetLocation	The location of the json data storage.

LakeHouseLinkedService

Object

Microsoft Fabric Lakehouse linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Lakehouse	Type of linked service.
typeProperties.artifactId	object	The ID of Microsoft Fabric Lakehouse artifact. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.servicePrincipalCredential	SecretBase: AzureKeyVaultSecretReference SecureString	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the application used to authenticate against Microsoft Fabric Lakehouse. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The Key of the application used to authenticate against Microsoft Fabric Lakehouse.
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
typeProperties.workspaceId	object	The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

LakeHouseTableDataset

Object

Microsoft Fabric Lakehouse Table.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: LakehouseTable	Type of dataset.
typeProperties.schema	object	The schema name of Microsoft Fabric Lakehouse Table. Type: string (or Expression with resultType string).
typeProperties.table	object	The name of Microsoft Fabric Lakehouse Table. Type: string (or Expression with resultType string).

LinkedServiceDebugResource

Object

Linked service debug resource.

Name	Type	Description
name	string	The resource name.
properties	LinkedService: AmazonMWSLinkedService AmazonRdsForOracleLinkedService AmazonRdsForSqlServerLinkedService AmazonRedshiftLinkedService AmazonS3CompatibleLinkedService AmazonS3LinkedService AppFiguresLinkedService AsanaLinkedService AzureBatchLinkedService AzureBlobFSLinkedService AzureBlobStorageLinkedService AzureDataExplorerLinkedService AzureDataLakeAnalyticsLinkedService AzureDataLakeStoreLinkedService AzureDatabricksDeltaLakeLinkedService AzureDatabricksLinkedService AzureFileStorageLinkedService AzureFunctionLinkedService AzureKeyVaultLinkedService AzureMLLinkedService AzureMLServiceLinkedService AzureMariaDBLinkedService AzureMySqlLinkedService AzurePostgreSqlLinkedService AzureSearchLinkedService AzureSqlDWLinkedService AzureSqlDatabaseLinkedService AzureSqlMILinkedService AzureStorageLinkedService AzureSynapseArtifactsLinkedService AzureTableStorageLinkedService CassandraLinkedService CommonDataServiceForAppsLinkedService ConcurLinkedService CosmosDbLinkedService CosmosDbMongoDbApiLinkedService CouchbaseLinkedService CustomDataSourceLinkedService DataworldLinkedService Db2LinkedService DrillLinkedService DynamicsAXLinkedService DynamicsCrmLinkedService DynamicsLinkedService EloquaLinkedService FileServerLinkedService FtpServerLinkedService GoogleAdWordsLinkedService GoogleBigQueryLinkedService GoogleBigQueryV2LinkedService GoogleCloudStorageLinkedService GoogleSheetsLinkedService GreenplumLinkedService HBaseLinkedService HDInsightLinkedService HDInsightOnDemandLinkedService HdfsLinkedService HiveLinkedService HttpLinkedService HubspotLinkedService ImpalaLinkedService InformixLinkedService JiraLinkedService LakeHouseLinkedService MagentoLinkedService MariaDBLinkedService MarketoLinkedService MicrosoftAccessLinkedService MongoDbAtlasLinkedService MongoDbLinkedService MongoDbV2LinkedService MySqlLinkedService NetezzaLinkedService ODataLinkedService OdbcLinkedService Office365LinkedService OracleCloudStorageLinkedService OracleLinkedService OracleServiceCloudLinkedService PaypalLinkedService PhoenixLinkedService PostgreSqlLinkedService PostgreSqlV2LinkedService PrestoLinkedService QuickBooksLinkedService QuickbaseLinkedService ResponsysLinkedService RestServiceLinkedService SalesforceLinkedService SalesforceMarketingCloudLinkedService SalesforceServiceCloudLinkedService SalesforceServiceCloudV2LinkedService SalesforceV2LinkedService SapBWLinkedService SapCloudForCustomerLinkedService SapEccLinkedService SapHanaLinkedService SapOdpLinkedService SapOpenHubLinkedService SapTableLinkedService ServiceNowLinkedService ServiceNowV2LinkedService SftpServerLinkedService SharePointOnlineListLinkedService ShopifyLinkedService SmartsheetLinkedService SnowflakeLinkedService SnowflakeV2LinkedService SparkLinkedService SqlServerLinkedService SquareLinkedService SybaseLinkedService TeamDeskLinkedService TeradataLinkedService TwilioLinkedService VerticaLinkedService WarehouseLinkedService WebLinkedService XeroLinkedService ZendeskLinkedService ZohoLinkedService	Properties of linked service.

LinkedServiceReference

Object

Linked service reference type.

Name	Type	Description
parameters	object	Arguments for LinkedService.
referenceName	string	Reference LinkedService name.
type	Type	Linked service reference type.

MagentoLinkedService

Object

Magento server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Magento	Type of linked service.
typeProperties.accessToken	SecretBase: AzureKeyVaultSecretReference SecureString	The access token from Magento.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The URL of the Magento instance. (i.e. 192.168.222.110/magento3)
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
version	string	Version of the linked service.

MagentoObjectDataset

Object

Magento server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: MagentoObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

MappingDataFlow

Object

Mapping data flow.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the data flow.
description	string	The description of the data flow.
folder	DataFlow.Folder	The folder that this data flow is in. If not specified, Data flow will appear at the root level.
type	string: MappingDataFlow	Type of data flow.
typeProperties.script	string	DataFlow script.
typeProperties.scriptLines	string[]	Data flow script lines.
typeProperties.sinks	DataFlowSink[]	List of sinks in data flow.
typeProperties.sources	DataFlowSource[]	List of sources in data flow.
typeProperties.transformations	Transformation[]	List of transformations in data flow.

MariaDBLinkedService

Object

MariaDB server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: MariaDB	Type of linked service.
typeProperties.connectionString	object	An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.database	object	Database name for connection. Type: string.
typeProperties.driverVersion	object	The version of the MariaDB driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string. The legacy driver is scheduled for deprecation by October 2024.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
typeProperties.port	object	The port for the connection. Type: integer.
typeProperties.server	object	Server name for connection. Type: string.
typeProperties.sslMode	object	This option specifies whether the driver uses TLS encryption and verification when connecting to MariaDB. E.g., SSLMode=<0/1/2/3/4>. Options: DISABLED (0) / PREFERRED (1) (Default) / REQUIRED (2) / VERIFY_CA (3) / VERIFY_IDENTITY (4), REQUIRED (2) is recommended to only allow connections encrypted with SSL/TLS.
typeProperties.useSystemTrustStore	object	This option specifies whether to use a CA certificate from the system trust store, or from a specified PEM file. E.g. UseSystemTrustStore=<0/1>; Options: Enabled (1) / Disabled (0) (Default)
typeProperties.username	object	Username for authentication. Type: string.
version	string	Version of the linked service.

MariaDBTableDataset

Object

MariaDB server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: MariaDBTable	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

MarketoLinkedService

Object

Marketo server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Marketo	Type of linked service.
typeProperties.clientId	object	The client Id of your Marketo service.
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret of your Marketo service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.endpoint	object	The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
version	string	Version of the linked service.

MarketoObjectDataset

Object

Marketo server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: MarketoObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

MicrosoftAccessLinkedService

Object

Microsoft Access linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: MicrosoftAccess	Type of linked service.
typeProperties.authenticationType	object	Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
typeProperties.connectionString	object	The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string.
typeProperties.credential	SecretBase: AzureKeyVaultSecretReference SecureString	The access credential portion of the connection string specified in driver-specific property-value format.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for Basic authentication.
typeProperties.userName	object	User name for Basic authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

MicrosoftAccessTableDataset

Object

The Microsoft Access table dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: MicrosoftAccessTable	Type of dataset.
typeProperties.tableName	object	The Microsoft Access table name. Type: string (or Expression with resultType string).

MongoDbAtlasCollectionDataset

Object

The MongoDB Atlas database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: MongoDbAtlasCollection	Type of dataset.
typeProperties.collection	object	The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string).

MongoDbAtlasLinkedService

Object

Linked service for MongoDB Atlas data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: MongoDbAtlas	Type of linked service.
typeProperties.connectionString	object	The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.database	object	The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string).
typeProperties.driverVersion	object	The driver version that you want to choose. Allowed value are v1 and v2. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

MongoDbAuthenticationType

Enumeration

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

Value	Description
Anonymous
Basic

MongoDbCollectionDataset

Object

The MongoDB database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: MongoDbCollection	Type of dataset.
typeProperties.collectionName	object	The table name of the MongoDB database. Type: string (or Expression with resultType string).

MongoDbLinkedService

Object

Linked service for MongoDb data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: MongoDb	Type of linked service.
typeProperties.allowSelfSignedServerCert	object	Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).
typeProperties.authSource	object	Database to verify the username and password. Type: string (or Expression with resultType string).
typeProperties.authenticationType	MongoDbAuthenticationType	The authentication type to be used to connect to the MongoDB database.
typeProperties.databaseName	object	The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).
typeProperties.enableSsl	object	Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for authentication.
typeProperties.port	object	The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.
typeProperties.server	object	The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).
typeProperties.username	object	Username for authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

MongoDbV2CollectionDataset

Object

The MongoDB database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: MongoDbV2Collection	Type of dataset.
typeProperties.collection	object	The collection name of the MongoDB database. Type: string (or Expression with resultType string).

MongoDbV2LinkedService

Object

Linked service for MongoDB data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: MongoDbV2	Type of linked service.
typeProperties.connectionString	object	The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.database	object	The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

MySqlLinkedService

Object

Linked service for MySQL data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: MySql	Type of linked service.
typeProperties.allowZeroDateTime	object	This allows the special “zero” date value 0000-00-00 to be retrieved from the database. Type: boolean.
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.connectionTimeout	object	The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Type: integer.
typeProperties.convertZeroDateTime	object	True to return DateTime.MinValue for date or datetime columns that have disallowed values. Type: boolean.
typeProperties.database	object	Database name for connection. Type: string.
typeProperties.driverVersion	object	The version of the MySQL driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.guidFormat	object	Determines which column type (if any) should be read as a GUID. Type: string. None: No column types are automatically read as a Guid; Char36: All CHAR(36) columns are read/written as a Guid using lowercase hex with hyphens, which matches UUID.
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
typeProperties.port	object	The port for the connection. Type: integer.
typeProperties.server	object	Server name for connection. Type: string.
typeProperties.sslCert	object	The path to the client’s SSL certificate file in PEM format. SslKey must also be specified. Type: string.
typeProperties.sslKey	object	The path to the client’s SSL private key in PEM format. SslCert must also be specified. Type: string.
typeProperties.sslMode	object	SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full.
typeProperties.treatTinyAsBoolean	object	When set to true, TINYINT(1) values are returned as booleans. Type: bool.
typeProperties.useSystemTrustStore	object	Use system trust store for connection. Type: integer. 0: enable, 1: disable.
typeProperties.username	object	Username for authentication. Type: string.
version	string	Version of the linked service.

MySqlTableDataset

Object

The MySQL table dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: MySqlTable	Type of dataset.
typeProperties.tableName	object	The MySQL table name. Type: string (or Expression with resultType string).

NetezzaLinkedService

Object

Netezza linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Netezza	Type of linked service.
typeProperties.connectionString	object	An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.pwd	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
version	string	Version of the linked service.

NetezzaTableDataset

Object

Netezza dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: NetezzaTable	Type of dataset.
typeProperties.schema	object	The schema name of the Netezza. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Netezza. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

ODataAadServicePrincipalCredentialType

Enumeration

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

Value	Description
ServicePrincipalCert
ServicePrincipalKey

ODataAuthenticationType

Enumeration

Type of authentication used to connect to the OData service.

Value	Description
AadServicePrincipal
Anonymous
Basic
ManagedServiceIdentity
Windows

ODataLinkedService

Object

Open Data Protocol (OData) linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: OData	Type of linked service.
typeProperties.aadResourceId	object	Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string).
typeProperties.aadServicePrincipalCredentialType	ODataAadServicePrincipalCredentialType	Specify the credential type (key or cert) is used for service principal.
typeProperties.authHeaders	object	The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).
typeProperties.authenticationType	ODataAuthenticationType	Type of authentication used to connect to the OData service.
typeProperties.azureCloudType	object	Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password of the OData service.
typeProperties.servicePrincipalEmbeddedCert	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalEmbeddedCertPassword	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
typeProperties.tenant	object	Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).
typeProperties.url	object	The URL of the OData service endpoint. Type: string (or Expression with resultType string).
typeProperties.userName	object	User name of the OData service. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

ODataResourceDataset

Object

The Open Data Protocol (OData) resource dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: ODataResource	Type of dataset.
typeProperties.path	object	The OData resource path. Type: string (or Expression with resultType string).

OdbcLinkedService

Object

Open Database Connectivity (ODBC) linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Odbc	Type of linked service.
typeProperties.authenticationType	object	Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
typeProperties.connectionString	object	The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string.
typeProperties.credential	SecretBase: AzureKeyVaultSecretReference SecureString	The access credential portion of the connection string specified in driver-specific property-value format.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for Basic authentication.
typeProperties.userName	object	User name for Basic authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

OdbcTableDataset

Object

The ODBC table dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: OdbcTable	Type of dataset.
typeProperties.tableName	object	The ODBC table name. Type: string (or Expression with resultType string).

Office365Dataset

Object

The Office365 account.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: Office365Table	Type of dataset.
typeProperties.predicate	object	A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string).
typeProperties.tableName	object	Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string).

Office365LinkedService

Object

Office365 linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Office365	Type of linked service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.office365TenantId	object	Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalCredentialType	object	The service principal credential type for authentication.'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. If not specified, 'ServicePrincipalKey' is in use. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalEmbeddedCert	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalEmbeddedCertPassword	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	Specify the application's client ID. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the application's key.
typeProperties.servicePrincipalTenantId	object	Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

OracleAuthenticationType

Enumeration

Authentication type for connecting to the Oracle database. Only used for Version 2.0.

Value	Description
Basic

OracleCloudStorageLinkedService

Object

Linked service for Oracle Cloud Storage.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: OracleCloudStorage	Type of linked service.
typeProperties.accessKeyId	object	The access key identifier of the Oracle Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.secretAccessKey	SecretBase: AzureKeyVaultSecretReference SecureString	The secret access key of the Oracle Cloud Storage Identity and Access Management (IAM) user.
typeProperties.serviceUrl	object	This value specifies the endpoint to access with the Oracle Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

OracleLinkedService

Object

Oracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Oracle	Type of linked service.
typeProperties.authenticationType	OracleAuthenticationType	Authentication type for connecting to the Oracle database. Only used for Version 2.0.
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0.
typeProperties.cryptoChecksumClient	object	Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0.
typeProperties.cryptoChecksumTypesClient	object	Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0.
typeProperties.enableBulkLoad	object	Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.encryptionClient	object	Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0.
typeProperties.encryptionTypesClient	object	Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0.
typeProperties.fetchSize	object	Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0.
typeProperties.fetchTswtzAsTimestamp	object	Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0.
typeProperties.initialLobFetchSize	object	Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0.
typeProperties.initializationString	object	Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0.
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
typeProperties.server	object	The location of Oracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0.
typeProperties.statementCacheSize	object	Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0.
typeProperties.supportV1DataTypes	object	Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0.
typeProperties.username	object	The Oracle database username. Type: string. Only used for Version 2.0.
version	string	Version of the linked service.

OracleServiceCloudLinkedService

Object

Oracle Service Cloud linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: OracleServiceCloud	Type of linked service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The URL of the Oracle Service Cloud instance.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name that you provided in the username key.
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.username	object	The user name that you use to access Oracle Service Cloud server.
version	string	Version of the linked service.

OracleServiceCloudObjectDataset

Object

Oracle Service Cloud dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: OracleServiceCloudObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

OracleTableDataset

Object

The on-premises Oracle database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: OracleTable	Type of dataset.
typeProperties.schema	object	The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

OrcDataset

Object

ORC dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: Orc	Type of dataset.
typeProperties.location	DatasetLocation	The location of the ORC data storage.
typeProperties.orcCompressionCodec	object	The data orcCompressionCodec. Type: string (or Expression with resultType string).

ParameterSpecification

Object

Definition of a single parameter for an entity.

Name	Type	Description
defaultValue	object	Default value of parameter.
type	ParameterType	Parameter type.

ParameterType

Enumeration

Parameter type.

Value	Description
Array
Bool
Float
Int
Object
SecureString
String

ParquetDataset

Object

Parquet dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: Parquet	Type of dataset.
typeProperties.compressionCodec	object	The data compressionCodec. Type: string (or Expression with resultType string).
typeProperties.location	DatasetLocation	The location of the parquet storage.

PaypalLinkedService

Object

Paypal Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Paypal	Type of linked service.
typeProperties.clientId	object	The client ID associated with your PayPal application.
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret associated with your PayPal application.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
version	string	Version of the linked service.

PaypalObjectDataset

Object

Paypal Service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: PaypalObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

PhoenixAuthenticationType

Enumeration

The authentication mechanism used to connect to the Phoenix server.

Value	Description
Anonymous
UsernameAndPassword
WindowsAzureHDInsightService

PhoenixLinkedService

Object

Phoenix server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Phoenix	Type of linked service.
typeProperties.allowHostNameCNMismatch	object	Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
typeProperties.allowSelfSignedServerCert	object	Specifies whether to allow self-signed certificates from the server. The default value is false.
typeProperties.authenticationType	PhoenixAuthenticationType	The authentication mechanism used to connect to the Phoenix server.
typeProperties.enableSsl	object	Specifies whether the connections to the server are encrypted using SSL. The default value is false.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)
typeProperties.httpPath	object	The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name.
typeProperties.port	object	The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.
typeProperties.trustedCertPath	object	The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
typeProperties.useSystemTrustStore	object	Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
typeProperties.username	object	The user name used to connect to the Phoenix server.
version	string	Version of the linked service.

PhoenixObjectDataset

Object

Phoenix server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: PhoenixObject	Type of dataset.
typeProperties.schema	object	The schema name of the Phoenix. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Phoenix. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

PostgreSqlLinkedService

Object

Linked service for PostgreSQL data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: PostgreSql	Type of linked service.
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
version	string	Version of the linked service.

PostgreSqlTableDataset

Object

The PostgreSQL table dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: PostgreSqlTable	Type of dataset.
typeProperties.schema	object	The PostgreSQL schema name. Type: string (or Expression with resultType string).
typeProperties.table	object	The PostgreSQL table name. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

PostgreSqlV2LinkedService

Object

Linked service for PostgreSQLV2 data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: PostgreSqlV2	Type of linked service.
typeProperties.authenticationType	object	The authentication type to use. Type: string.
typeProperties.commandTimeout	object	The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer.
typeProperties.connectionTimeout	object	The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer.
typeProperties.database	object	Database name for connection. Type: string.
typeProperties.encoding	object	Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.logParameters	object	When enabled, parameter values are logged when commands are executed. Type: boolean.
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string. Type: string.
typeProperties.pooling	object	Whether connection pooling should be used. Type: boolean.
typeProperties.port	object	The port for the connection. Type: integer.
typeProperties.readBufferSize	object	Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer.
typeProperties.schema	object	Sets the schema search path. Type: string.
typeProperties.server	object	Server name for connection. Type: string.
typeProperties.sslCertificate	object	Location of a client certificate to be sent to the server. Type: string.
typeProperties.sslKey	object	Location of a client key for a client certificate to be sent to the server. Type: string.
typeProperties.sslMode	object	SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer.
typeProperties.sslPassword	object	Password for a key for a client certificate. Type: string.
typeProperties.timezone	object	Gets or sets the session timezone. Type: string.
typeProperties.trustServerCertificate	object	Whether to trust the server certificate without validating it. Type: boolean.
typeProperties.username	object	Username for authentication. Type: string.
version	string	Version of the linked service.

PostgreSqlV2TableDataset

Object

The PostgreSQLV2 table dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: PostgreSqlV2Table	Type of dataset.
typeProperties.schema	object	The PostgreSQL schema name. Type: string (or Expression with resultType string).
typeProperties.table	object	The PostgreSQL table name. Type: string (or Expression with resultType string).

PowerQuerySource

Object

Power query source.

Name	Type	Description
dataset	DatasetReference	Dataset reference.
description	string	Transformation description.
flowlet	DataFlowReference	Flowlet Reference
linkedService	LinkedServiceReference	Linked service reference.
name	string	Transformation name.
schemaLinkedService	LinkedServiceReference	Schema linked service reference.
script	string	source script.

PrestoAuthenticationType

Enumeration

The authentication mechanism used to connect to the Presto server.

Value	Description
Anonymous
LDAP

PrestoLinkedService

Object

Presto server linked service. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Presto	Type of linked service.
typeProperties.allowHostNameCNMismatch	object	Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. Only used for Version 1.0.
typeProperties.allowSelfSignedServerCert	object	Specifies whether to allow self-signed certificates from the server. The default value is false. Only used for Version 1.0.
typeProperties.authenticationType	PrestoAuthenticationType	The authentication mechanism used to connect to the Presto server.
typeProperties.catalog	object	The catalog context for all request against the server.
typeProperties.enableServerCertificateValidation	object	Specifies whether the connections to the server will validate server certificate, the default value is True. Only used for Version 2.0
typeProperties.enableSsl	object	Specifies whether the connections to the server are encrypted using SSL. The default value for legacy version is False. The default value for version 2.0 is True.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The IP address or host name of the Presto server. (i.e. 192.168.222.160)
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name.
typeProperties.port	object	The TCP port that the Presto server uses to listen for client connections. The default value is 8080 when disable SSL, default value is 443 when enable SSL.
typeProperties.serverVersion	object	The version of the Presto server. (i.e. 0.148-t) Only used for Version 1.0.
typeProperties.timeZoneID	object	The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value for Version 1.0 is the client system time zone. The default value for Version 2.0 is server system timeZone
typeProperties.trustedCertPath	object	The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Only used for Version 1.0.
typeProperties.useSystemTrustStore	object	Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. Only used for Version 1.0.
typeProperties.username	object	The user name used to connect to the Presto server.
version	string	Version of the linked service.

PrestoObjectDataset

Object

Presto server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: PrestoObject	Type of dataset.
typeProperties.schema	object	The schema name of the Presto. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Presto. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

QuickbaseLinkedService

Object

Linked service for Quickbase.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Quickbase	Type of linked service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.url	object	The url to connect Quickbase source. Type: string (or Expression with resultType string).
typeProperties.userToken	SecretBase: AzureKeyVaultSecretReference SecureString	The user token for the Quickbase source.
version	string	Version of the linked service.

QuickBooksLinkedService

Object

QuickBooks server linked service. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: QuickBooks	Type of linked service.
typeProperties.accessToken	SecretBase: AzureKeyVaultSecretReference SecureString	The access token for OAuth 2.0 authentication.
typeProperties.accessTokenSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The access token secret is deprecated for OAuth 1.0 authentication. Only used for version 1.0.
typeProperties.companyId	object	The company ID of the QuickBooks company to authorize.
typeProperties.connectionProperties	object	Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.
typeProperties.consumerKey	object	The consumer key for OAuth 2.0 authentication.
typeProperties.consumerSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The consumer secret for OAuth 2.0 authentication.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.endpoint	object	The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)
typeProperties.refreshToken	SecretBase: AzureKeyVaultSecretReference SecureString	The refresh token for OAuth 2.0 authentication.
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Only used for version 1.0.
version	string	Version of the linked service.

QuickBooksObjectDataset

Object

QuickBooks server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: QuickBooksObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

RelationalTableDataset

Object

The relational table dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: RelationalTable	Type of dataset.
typeProperties.tableName	object	The relational table name. Type: string (or Expression with resultType string).

ResponsysLinkedService

Object

Responsys linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Responsys	Type of linked service.
typeProperties.clientId	object	The client ID associated with the Responsys application. Type: string (or Expression with resultType string).
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret associated with the Responsys application. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.endpoint	object	The endpoint of the Responsys server.
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).
version	string	Version of the linked service.

ResponsysObjectDataset

Object

Responsys dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: ResponsysObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

RestResourceDataset

Object

A Rest service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: RestResource	Type of dataset.
typeProperties.additionalHeaders	object	The additional HTTP headers in the request to the RESTful API.
typeProperties.paginationRules	object	The pagination rules to compose next page requests.
typeProperties.relativeUrl	object	The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
typeProperties.requestBody	object	The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
typeProperties.requestMethod	object	The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

RestServiceAuthenticationType

Enumeration

Type of authentication used to connect to the REST service.

Value	Description
AadServicePrincipal
Anonymous
Basic
ManagedServiceIdentity
OAuth2ClientCredential

RestServiceLinkedService

Object

Rest Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: RestService	Type of linked service.
typeProperties.aadResourceId	object	The resource you are requesting authorization to use. Type: string (or Expression with resultType string).
typeProperties.authHeaders	object	The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
typeProperties.authenticationType	RestServiceAuthenticationType	Type of authentication used to connect to the REST service.
typeProperties.azureCloudType	object	Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
typeProperties.clientId	object	The client ID associated with your application. Type: string (or Expression with resultType string).
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret associated with your application.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.enableServerCertificateValidation	object	Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password used in Basic authentication type.
typeProperties.resource	object	The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).
typeProperties.scope	object	The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalEmbeddedCert	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalEmbeddedCertPassword	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The application's key used in AadServicePrincipal authentication type.
typeProperties.tenant	object	The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string).
typeProperties.tokenEndpoint	object	The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).
typeProperties.url	object	The base URL of the REST service. Type: string (or Expression with resultType string).
typeProperties.userName	object	The user name used in Basic authentication type. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SalesforceLinkedService

Object

Linked service for Salesforce.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Salesforce	Type of linked service.
typeProperties.apiVersion	object	The Salesforce API version used in ADF. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.environmentUrl	object	The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password for Basic authentication of the Salesforce instance.
typeProperties.securityToken	SecretBase: AzureKeyVaultSecretReference SecureString	The security token is optional to remotely access Salesforce instance.
typeProperties.username	object	The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SalesforceMarketingCloudLinkedService

Object

Salesforce Marketing Cloud linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SalesforceMarketingCloud	Type of linked service.
typeProperties.clientId	object	The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).
typeProperties.connectionProperties	object	Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).
version	string	Version of the linked service.

SalesforceMarketingCloudObjectDataset

Object

Salesforce Marketing Cloud dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SalesforceMarketingCloudObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

SalesforceObjectDataset

Object

The Salesforce object dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SalesforceObject	Type of dataset.
typeProperties.objectApiName	object	The Salesforce object API name. Type: string (or Expression with resultType string).

SalesforceServiceCloudLinkedService

Object

Linked service for Salesforce Service Cloud.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SalesforceServiceCloud	Type of linked service.
typeProperties.apiVersion	object	The Salesforce API version used in ADF. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.environmentUrl	object	The URL of Salesforce Service Cloud instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).
typeProperties.extendedProperties	object	Extended properties appended to the connection string. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password for Basic authentication of the Salesforce instance.
typeProperties.securityToken	SecretBase: AzureKeyVaultSecretReference SecureString	The security token is optional to remotely access Salesforce instance.
typeProperties.username	object	The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SalesforceServiceCloudObjectDataset

Object

The Salesforce Service Cloud object dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SalesforceServiceCloudObject	Type of dataset.
typeProperties.objectApiName	object	The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string).

SalesforceServiceCloudV2LinkedService

Object

Linked service for Salesforce Service Cloud V2.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SalesforceServiceCloudV2	Type of linked service.
typeProperties.apiVersion	object	The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string).
typeProperties.authenticationType	object	The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value
typeProperties.clientId	object	The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string).
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.environmentUrl	object	The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SalesforceServiceCloudV2ObjectDataset

Object

The Salesforce Service Cloud V2 object dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SalesforceServiceCloudV2Object	Type of dataset.
typeProperties.objectApiName	object	The Salesforce Service Cloud V2 object API name. Type: string (or Expression with resultType string).
typeProperties.reportId	object	The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string).

SalesforceV2LinkedService

Object

Linked service for Salesforce V2.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SalesforceV2	Type of linked service.
typeProperties.apiVersion	object	The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string).
typeProperties.authenticationType	object	The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value
typeProperties.clientId	object	The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string).
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.environmentUrl	object	The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SalesforceV2ObjectDataset

Object

The Salesforce V2 object dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SalesforceV2Object	Type of dataset.
typeProperties.objectApiName	object	The Salesforce V2 object API name. Type: string (or Expression with resultType string).
typeProperties.reportId	object	The Salesforce V2 report Id. Type: string (or Expression with resultType string).

SapBwCubeDataset

Object

The SAP BW cube dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SapBwCube	Type of dataset.

SapBWLinkedService

Object

SAP Business Warehouse Linked Service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SapBW	Type of linked service.
typeProperties.clientId	object	Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to access the SAP BW server.
typeProperties.server	object	Host name of the SAP BW instance. Type: string (or Expression with resultType string).
typeProperties.systemNumber	object	System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
typeProperties.userName	object	Username to access the SAP BW server. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SapCloudForCustomerLinkedService

Object

Linked service for SAP Cloud for Customer.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SapCloudForCustomer	Type of linked service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password for Basic authentication.
typeProperties.url	object	The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string).
typeProperties.username	object	The username for Basic authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SapCloudForCustomerResourceDataset

Object

The path of the SAP Cloud for Customer OData entity.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SapCloudForCustomerResource	Type of dataset.
typeProperties.path	object	The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string).

SapEccLinkedService

Object

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

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SapEcc	Type of linked service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password for Basic authentication.
typeProperties.url	object	The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string).
typeProperties.username	object	The username for Basic authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SapEccResourceDataset

Object

The path of the SAP ECC OData entity.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SapEccResource	Type of dataset.
typeProperties.path	object	The path of the SAP ECC OData entity. Type: string (or Expression with resultType string).

SapHanaAuthenticationType

Enumeration

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

Value	Description
Basic
Windows

SapHanaLinkedService

Object

SAP HANA Linked Service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SapHana	Type of linked service.
typeProperties.authenticationType	SapHanaAuthenticationType	The authentication type to be used to connect to the SAP HANA server.
typeProperties.connectionString	object	SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to access the SAP HANA server.
typeProperties.server	object	Host name of the SAP HANA server. Type: string (or Expression with resultType string).
typeProperties.userName	object	Username to access the SAP HANA server. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SapHanaTableDataset

Object

SAP HANA Table properties.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SapHanaTable	Type of dataset.
typeProperties.schema	object	The schema name of SAP HANA. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of SAP HANA. Type: string (or Expression with resultType string).

SapOdpLinkedService

Object

SAP ODP Linked Service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SapOdp	Type of linked service.
typeProperties.clientId	object	Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.language	object	Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).
typeProperties.logonGroup	object	The Logon Group for the SAP System. Type: string (or Expression with resultType string).
typeProperties.messageServer	object	The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
typeProperties.messageServerService	object	The service name or port number of the Message Server. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to access the SAP server where the table is located.
typeProperties.server	object	Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).
typeProperties.sncLibraryPath	object	External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string).
typeProperties.sncMode	object	SNC activation flag (Boolean) to access the SAP server where the table is located. Type: boolean (or Expression with resultType boolean).
typeProperties.sncMyName	object	Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
typeProperties.sncPartnerName	object	Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
typeProperties.sncQop	object	SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).
typeProperties.subscriberName	object	The subscriber name. Type: string (or Expression with resultType string).
typeProperties.systemId	object	SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
typeProperties.systemNumber	object	System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
typeProperties.userName	object	Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).
typeProperties.x509CertificatePath	object	SNC X509 certificate file path. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SapOdpResourceDataset

Object

SAP ODP Resource properties.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SapOdpResource	Type of dataset.
typeProperties.context	object	The context of the SAP ODP Object. Type: string (or Expression with resultType string).
typeProperties.objectName	object	The name of the SAP ODP Object. Type: string (or Expression with resultType string).

SapOpenHubLinkedService

Object

SAP Business Warehouse Open Hub Destination Linked Service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SapOpenHub	Type of linked service.
typeProperties.clientId	object	Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.language	object	Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string).
typeProperties.logonGroup	object	The Logon Group for the SAP System. Type: string (or Expression with resultType string).
typeProperties.messageServer	object	The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
typeProperties.messageServerService	object	The service name or port number of the Message Server. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to access the SAP BW server where the open hub destination is located.
typeProperties.server	object	Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string).
typeProperties.systemId	object	SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
typeProperties.systemNumber	object	System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
typeProperties.userName	object	Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SapOpenHubTableDataset

Object

Sap Business Warehouse Open Hub Destination Table properties.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SapOpenHubTable	Type of dataset.
typeProperties.baseRequestId	object	The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).
typeProperties.excludeLastRequest	object	Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.openHubDestinationName	object	The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string).

SapTableLinkedService

Object

SAP Table Linked Service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SapTable	Type of linked service.
typeProperties.clientId	object	Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.language	object	Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).
typeProperties.logonGroup	object	The Logon Group for the SAP System. Type: string (or Expression with resultType string).
typeProperties.messageServer	object	The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
typeProperties.messageServerService	object	The service name or port number of the Message Server. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to access the SAP server where the table is located.
typeProperties.server	object	Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).
typeProperties.sncLibraryPath	object	External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string).
typeProperties.sncMode	object	SNC activation flag (Boolean) to access the SAP server where the table is located. Type: boolean (or Expression with resultType boolean).
typeProperties.sncMyName	object	Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
typeProperties.sncPartnerName	object	Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
typeProperties.sncQop	object	SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).
typeProperties.systemId	object	SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
typeProperties.systemNumber	object	System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
typeProperties.userName	object	Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SapTableResourceDataset

Object

SAP Table Resource properties.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SapTableResource	Type of dataset.
typeProperties.tableName	object	The name of the SAP Table. Type: string (or Expression with resultType string).

ScriptAction

Object

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

Name	Type	Description
name	string	The user provided name of the script action.
parameters	string	The parameters for the script action.
roles	object	The node types on which the script action should be executed.
uri	string	The URI for the script action.

SecureString

Object

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

Name	Type	Description
type	string: SecureString	Type of the secret.
value	string	Value of secure string.

ServiceNowAuthenticationType

Enumeration

The authentication type to use.

Value	Description
Basic
OAuth2

ServiceNowLinkedService

Object

ServiceNow server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: ServiceNow	Type of linked service.
typeProperties.authenticationType	ServiceNowAuthenticationType	The authentication type to use.
typeProperties.clientId	object	The client id for OAuth2 authentication.
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret for OAuth2 authentication.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.endpoint	object	The endpoint of the ServiceNow server. (i.e. .service-now.com)
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name for Basic and OAuth2 authentication.
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
typeProperties.username	object	The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.
version	string	Version of the linked service.

ServiceNowObjectDataset

Object

ServiceNow server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: ServiceNowObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

ServiceNowV2AuthenticationType

Enumeration

The authentication type to use.

Value	Description
Basic
OAuth2

ServiceNowV2LinkedService

Object

ServiceNowV2 server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: ServiceNowV2	Type of linked service.
typeProperties.authenticationType	ServiceNowV2AuthenticationType	The authentication type to use.
typeProperties.clientId	object	The client id for OAuth2 authentication.
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret for OAuth2 authentication.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.endpoint	object	The endpoint of the ServiceNowV2 server. (i.e. .service-now.com)
typeProperties.grantType	object	GrantType for OAuth2 authentication. Default value is password.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name for Basic and OAuth2 authentication.
typeProperties.username	object	The user name used to connect to the ServiceNowV2 server for Basic and OAuth2 authentication.
version	string	Version of the linked service.

ServiceNowV2ObjectDataset

Object

ServiceNowV2 server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: ServiceNowV2Object	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).
typeProperties.valueType	ValueType	Type of value copied from source.

SftpAuthenticationType

Enumeration

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

Value	Description
Basic
MultiFactor
SshPublicKey

SftpServerLinkedService

Object

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

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Sftp	Type of linked service.
typeProperties.authenticationType	SftpAuthenticationType	The authentication type to be used to connect to the FTP server.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The SFTP server host name. Type: string (or Expression with resultType string).
typeProperties.hostKeyFingerprint	object	The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).
typeProperties.passPhrase	SecretBase: AzureKeyVaultSecretReference SecureString	The password to decrypt the SSH private key if the SSH private key is encrypted.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password to logon the SFTP server for Basic authentication.
typeProperties.port	object	The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.
typeProperties.privateKeyContent	SecretBase: AzureKeyVaultSecretReference SecureString	Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.
typeProperties.privateKeyPath	object	The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).
typeProperties.skipHostKeyValidation	object	If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
typeProperties.userName	object	The username used to log on to the SFTP server. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SharePointOnlineListLinkedService

Object

SharePoint Online List linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SharePointOnlineList	Type of linked service.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalEmbeddedCert	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalEmbeddedCertPassword	SecretBase: AzureKeyVaultSecretReference SecureString	Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
typeProperties.siteUrl	object	The URL of the SharePoint Online site. For example, `https://contoso.sharepoint.com/sites/siteName`. Type: string (or Expression with resultType string).
typeProperties.tenantId	object	The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SharePointOnlineListResourceDataset

Object

The sharepoint online list resource dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SharePointOnlineListResource	Type of dataset.
typeProperties.listName	object	The name of the SharePoint Online list. Type: string (or Expression with resultType string).

ShopifyLinkedService

Object

Shopify Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Shopify	Type of linked service.
typeProperties.accessToken	SecretBase: AzureKeyVaultSecretReference SecureString	The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The endpoint of the Shopify server. (i.e. mystore.myshopify.com)
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
version	string	Version of the linked service.

ShopifyObjectDataset

Object

Shopify Service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: ShopifyObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

SmartsheetLinkedService

Object

Linked service for Smartsheet.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Smartsheet	Type of linked service.
typeProperties.apiToken	SecretBase: AzureKeyVaultSecretReference SecureString	The api token for the Smartsheet source.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
version	string	Version of the linked service.

SnowflakeAuthenticationType

Enumeration

The type used for authentication. Type: string.

Value	Description
AADServicePrincipal
Basic
KeyPair

SnowflakeDataset

Object

The snowflake dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SnowflakeTable	Type of dataset.
typeProperties.schema	object	The schema name of the Snowflake database. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Snowflake database. Type: string (or Expression with resultType string).

SnowflakeLinkedService

Object

Snowflake linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Snowflake	Type of linked service.
typeProperties.connectionString	object	The connection string of snowflake. Type: string, SecureString.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
version	string	Version of the linked service.

SnowflakeV2Dataset

Object

The snowflake dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SnowflakeV2Table	Type of dataset.
typeProperties.schema	object	The schema name of the Snowflake database. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Snowflake database. Type: string (or Expression with resultType string).

SnowflakeV2LinkedService

Object

Snowflake linked service.

Name	Type	Default value	Description
annotations	object[]		List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference		The integration runtime reference.
description	string		Linked service description.
parameters	<string, ParameterSpecification>		Parameters for linked service.
type	string: SnowflakeV2		Type of linked service.
typeProperties.accountIdentifier	object		The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure
typeProperties.authenticationType	SnowflakeAuthenticationType	Basic	The type used for authentication. Type: string.
typeProperties.clientId	object		The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString		The Azure key vault secret reference of client secret for AADServicePrincipal authentication.
typeProperties.database	object		The name of the Snowflake database.
typeProperties.encryptedCredential	string		The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object		The host name of the Snowflake account. Type: string (or Expression with resultType string).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString		The Azure key vault secret reference of password in connection string.
typeProperties.privateKey	SecretBase: AzureKeyVaultSecretReference SecureString		The Azure key vault secret reference of privateKey for KeyPair auth.
typeProperties.privateKeyPassphrase	SecretBase: AzureKeyVaultSecretReference SecureString		The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key.
typeProperties.role	object		The default access control role to use in the Snowflake session. Type: string (or Expression with resultType string).
typeProperties.schema	object		Schema name for connection. Type: string (or Expression with resultType string).
typeProperties.scope	object		The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication.
typeProperties.tenantId	object		The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.
typeProperties.user	object		The name of the Snowflake user.
typeProperties.warehouse	object		The name of the Snowflake warehouse.
version	string		Version of the linked service.

SparkAuthenticationType

Enumeration

The authentication method used to access the Spark server.

Value	Description
Anonymous
Username
UsernameAndPassword
WindowsAzureHDInsightService

SparkLinkedService

Object

Spark Server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Spark	Type of linked service.
typeProperties.allowHostNameCNMismatch	object	Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
typeProperties.allowSelfSignedServerCert	object	Specifies whether to allow self-signed certificates from the server. The default value is false.
typeProperties.authenticationType	SparkAuthenticationType	The authentication method used to access the Spark server.
typeProperties.enableServerCertificateValidation	object	Specifies whether the connections to the server will validate server certificate, the default value is True. Only used for Version 2.0
typeProperties.enableSsl	object	Specifies whether the connections to the server are encrypted using SSL. The default value is false.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	IP address or host name of the Spark server
typeProperties.httpPath	object	The partial URL corresponding to the Spark server.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password corresponding to the user name that you provided in the Username field
typeProperties.port	object	The TCP port that the Spark server uses to listen for client connections.
typeProperties.serverType	SparkServerType	The type of Spark server.
typeProperties.thriftTransportProtocol	SparkThriftTransportProtocol	The transport protocol to use in the Thrift layer.
typeProperties.trustedCertPath	object	The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
typeProperties.useSystemTrustStore	object	Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
typeProperties.username	object	The user name that you use to access Spark Server.
version	string	Version of the linked service.

SparkObjectDataset

Object

Spark Server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SparkObject	Type of dataset.
typeProperties.schema	object	The schema name of the Spark. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Spark. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

SparkServerType

Enumeration

The type of Spark server.

Value	Description
SharkServer
SharkServer2
SparkThriftServer

SparkThriftTransportProtocol

Enumeration

The transport protocol to use in the Thrift layer.

Value	Description
Binary
HTTP
SASL

SqlAlwaysEncryptedAkvAuthType

Enumeration

Sql always encrypted AKV authentication type. Type: string.

Value	Description
ManagedIdentity
ServicePrincipal
UserAssignedManagedIdentity

SqlAlwaysEncryptedProperties

Object

Sql always encrypted properties.

Name	Type	Description
alwaysEncryptedAkvAuthType	SqlAlwaysEncryptedAkvAuthType	Sql always encrypted AKV authentication type. Type: string.
credential	CredentialReference	The credential reference containing authentication information.
servicePrincipalId	object	The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string).
servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The key of the service principal used to authenticate against Azure Key Vault.

SqlServerAuthenticationType

Enumeration

The type used for authentication. Type: string.

Value	Description
SQL
UserAssignedManagedIdentity
Windows

SqlServerLinkedService

Object

SQL Server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: SqlServer	Type of linked service.
typeProperties.alwaysEncryptedSettings	SqlAlwaysEncryptedProperties	Sql always encrypted properties.
typeProperties.applicationIntent	object	The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string).
typeProperties.authenticationType	SqlServerAuthenticationType	The type used for authentication. Type: string.
typeProperties.commandTimeout	object	The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.connectRetryCount	object	The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer).
typeProperties.connectRetryInterval	object	The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer).
typeProperties.connectTimeout	object	The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.credential	CredentialReference	The credential reference containing authentication information.
typeProperties.database	object	The name of the database, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.encrypt	object	Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.failoverPartner	object	The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.hostNameInCertificate	object	The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.integratedSecurity	object	Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.loadBalanceTimeout	object	The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.maxPoolSize	object	The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.minPoolSize	object	The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.multiSubnetFailover	object	If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.multipleActiveResultSets	object	When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.packetSize	object	The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer).
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The on-premises Windows authentication password.
typeProperties.pooling	object	Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.server	object	The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string).
typeProperties.trustServerCertificate	object	Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean).
typeProperties.userName	object	The on-premises Windows authentication user name. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SqlServerTableDataset

Object

The on-premises SQL Server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SqlServerTable	Type of dataset.
typeProperties.schema	object	The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the SQL Server dataset. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

SquareLinkedService

Object

Square Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Square	Type of linked service.
typeProperties.clientId	object	The client ID associated with your Square application.
typeProperties.clientSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The client secret associated with your Square application.
typeProperties.connectionProperties	object	Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The URL of the Square instance. (i.e. mystore.mysquare.com)
typeProperties.redirectUri	object	The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
version	string	Version of the linked service.

SquareObjectDataset

Object

Square Service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SquareObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

SybaseAuthenticationType

Enumeration

AuthenticationType to be used for connection.

Value	Description
Basic
Windows

SybaseLinkedService

Object

Linked service for Sybase data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Sybase	Type of linked service.
typeProperties.authenticationType	SybaseAuthenticationType	AuthenticationType to be used for connection.
typeProperties.database	object	Database name for connection. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for authentication.
typeProperties.schema	object	Schema name for connection. Type: string (or Expression with resultType string).
typeProperties.server	object	Server name for connection. Type: string (or Expression with resultType string).
typeProperties.username	object	Username for authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

SybaseTableDataset

Object

The Sybase table dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: SybaseTable	Type of dataset.
typeProperties.tableName	object	The Sybase table name. Type: string (or Expression with resultType string).

TeamDeskAuthenticationType

Enumeration

The authentication type to use.

Value	Description
Basic
Token

TeamDeskLinkedService

Object

Linked service for TeamDesk.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: TeamDesk	Type of linked service.
typeProperties.apiToken	SecretBase: AzureKeyVaultSecretReference SecureString	The api token for the TeamDesk source.
typeProperties.authenticationType	TeamDeskAuthenticationType	The authentication type to use.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password of the TeamDesk source.
typeProperties.url	object	The url to connect TeamDesk source. Type: string (or Expression with resultType string).
typeProperties.userName	object	The username of the TeamDesk source. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

TeradataAuthenticationType

Enumeration

AuthenticationType to be used for connection.

Value	Description
Basic
Windows

TeradataLinkedService

Object

Linked service for Teradata data source.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Teradata	Type of linked service.
typeProperties.authenticationType	TeradataAuthenticationType	AuthenticationType to be used for connection.
typeProperties.characterSet	object	The character set to use for the connection. Type: string (or Expression with resultType string). Only applied for version 2.0.
typeProperties.connectionString	object	Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only applied for version 1.0.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.httpsPortNumber	object	The port numbers when connecting to server through HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0.
typeProperties.maxRespSize	object	The maximum size of the response buffer for SQL requests, in bytes. Type: integer. Only applied for version 2.0.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for authentication.
typeProperties.portNumber	object	The port numbers when connecting to server through non HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only used for V2. Only applied for version 2.0.
typeProperties.server	object	Server name for connection. Type: string (or Expression with resultType string).
typeProperties.sslMode	object	SSL mode for connection. Valid values including: “Disable”, “Allow”, “Prefer”, “Require”, “Verify-CA”, “Verify-Full”. Default value is “Verify-Full”. Type: string (or Expression with resultType string). Only applied for version 2.0.
typeProperties.useDataEncryption	object	Specifies whether to encrypt all communication with the Teradata database. Allowed values are 0 or 1. This setting will be ignored for HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0.
typeProperties.username	object	Username for authentication. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

TeradataTableDataset

Object

The Teradata database dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: TeradataTable	Type of dataset.
typeProperties.database	object	The database name of Teradata. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of Teradata. Type: string (or Expression with resultType string).

Transformation

Object

A data flow transformation.

Name	Type	Description
dataset	DatasetReference	Dataset reference.
description	string	Transformation description.
flowlet	DataFlowReference	Flowlet Reference
linkedService	LinkedServiceReference	Linked service reference.
name	string	Transformation name.

TwilioLinkedService

Object

Linked service for Twilio.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Twilio	Type of linked service.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The auth token of Twilio service.
typeProperties.userName	object	The Account SID of Twilio service. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

Type

Enumeration

Linked service reference type.

Value	Description
LinkedServiceReference

ValueType

Enumeration

Type of value copied from source.

Value	Description
actual
display

VerticaLinkedService

Object

Vertica linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Vertica	Type of linked service.
typeProperties.connectionString	object	An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
typeProperties.database	object	Database name for connection. Type: string.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.port	object	The port for the connection. Type: integer.
typeProperties.pwd	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.
typeProperties.server	object	Server name for connection. Type: string.
typeProperties.uid	object	Username for authentication. Type: string.
version	string	Version of the linked service.

VerticaTableDataset

Object

Vertica dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: VerticaTable	Type of dataset.
typeProperties.schema	object	The schema name of the Vertica. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Vertica. Type: string (or Expression with resultType string).
typeProperties.tableName	object	This property will be retired. Please consider using schema + table properties instead.

WarehouseLinkedService

Object

Microsoft Fabric Warehouse linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Warehouse	Type of linked service.
typeProperties.artifactId	object	The ID of Microsoft Fabric Warehouse artifact. Type: string (or Expression with resultType string).
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.endpoint	object	The endpoint of Microsoft Fabric Warehouse server. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalCredential	SecretBase: AzureKeyVaultSecretReference SecureString	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
typeProperties.servicePrincipalCredentialType	object	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalId	object	The ID of the application used to authenticate against Microsoft Fabric Warehouse. Type: string (or Expression with resultType string).
typeProperties.servicePrincipalKey	SecretBase: AzureKeyVaultSecretReference SecureString	The Key of the application used to authenticate against Microsoft Fabric Warehouse.
typeProperties.tenant	object	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
typeProperties.workspaceId	object	The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

WarehouseTableDataset

Object

Microsoft Fabric Warehouse dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: WarehouseTable	Type of dataset.
typeProperties.schema	object	The schema name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string).
typeProperties.table	object	The table name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string).

WebAnonymousAuthentication

Object

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

Name	Type	Description
authenticationType	string: Anonymous	Type of authentication used to connect to the web table source.
url	object	The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string).

WebBasicAuthentication

Object

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

Name	Type	Description
authenticationType	string: Basic	Type of authentication used to connect to the web table source.
password	SecretBase: AzureKeyVaultSecretReference SecureString	The password for Basic authentication.
url	object	The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string).
username	object	User name for Basic authentication. Type: string (or Expression with resultType string).

WebClientCertificateAuthentication

Object

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

Name	Type	Description
authenticationType	string: ClientCertificate	Type of authentication used to connect to the web table source.
password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for the PFX file.
pfx	SecretBase: AzureKeyVaultSecretReference SecureString	Base64-encoded contents of a PFX file.
url	object	The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string).

WebLinkedService

Object

Web linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Web	Type of linked service.
typeProperties	WebLinkedServiceTypeProperties: WebAnonymousAuthentication WebBasicAuthentication WebClientCertificateAuthentication	Web linked service properties.
version	string	Version of the linked service.

WebTableDataset

Object

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

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: WebTable	Type of dataset.
typeProperties.index	object	The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0.
typeProperties.path	object	The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string).

WranglingDataFlow

Object

Power Query data flow.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the data flow.
description	string	The description of the data flow.
folder	DataFlow.Folder	The folder that this data flow is in. If not specified, Data flow will appear at the root level.
type	string: WranglingDataFlow	Type of data flow.
typeProperties.documentLocale	string	Locale of the Power query mashup document.
typeProperties.script	string	Power query mashup script.
typeProperties.sources	PowerQuerySource[]	List of sources in Power Query.

XeroLinkedService

Object

Xero Service linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Xero	Type of linked service.
typeProperties.connectionProperties	object	Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object.
typeProperties.consumerKey	SecretBase: AzureKeyVaultSecretReference SecureString	The consumer key associated with the Xero application.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.host	object	The endpoint of the Xero server. (i.e. api.xero.com)
typeProperties.privateKey	SecretBase: AzureKeyVaultSecretReference SecureString	The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings( ).
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
version	string	Version of the linked service.

XeroObjectDataset

Object

Xero Service dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: XeroObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

XmlDataset

Object

Xml dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: Xml	Type of dataset.
typeProperties.compression	DatasetCompression	The data compression method used for the json dataset.
typeProperties.encodingName	object	The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
typeProperties.location	DatasetLocation	The location of the json data storage.
typeProperties.nullValue	object	The null value string. Type: string (or Expression with resultType string).

ZendeskAuthenticationType

Enumeration

The authentication type to use.

Value	Description
Basic
Token

ZendeskLinkedService

Object

Linked service for Zendesk.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Zendesk	Type of linked service.
typeProperties.apiToken	SecretBase: AzureKeyVaultSecretReference SecureString	The api token for the Zendesk source.
typeProperties.authenticationType	ZendeskAuthenticationType	The authentication type to use.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.password	SecretBase: AzureKeyVaultSecretReference SecureString	The password of the Zendesk source.
typeProperties.url	object	The url to connect Zendesk source. Type: string (or Expression with resultType string).
typeProperties.userName	object	The username of the Zendesk source. Type: string (or Expression with resultType string).
version	string	Version of the linked service.

ZohoLinkedService

Object

Zoho server linked service.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the linked service.
connectVia	IntegrationRuntimeReference	The integration runtime reference.
description	string	Linked service description.
parameters	<string, ParameterSpecification>	Parameters for linked service.
type	string: Zoho	Type of linked service.
typeProperties.accessToken	SecretBase: AzureKeyVaultSecretReference SecureString	The access token for Zoho authentication.
typeProperties.connectionProperties	object	Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object.
typeProperties.encryptedCredential	string	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
typeProperties.endpoint	object	The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)
typeProperties.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.
typeProperties.useHostVerification	object	Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.
typeProperties.usePeerVerification	object	Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.
version	string	Version of the linked service.

ZohoObjectDataset

Object

Zoho server dataset.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
folder	Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	LinkedServiceReference	Linked service reference.
parameters	<string, ParameterSpecification>	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string: ZohoObject	Type of dataset.
typeProperties.tableName	object	The table name. Type: string (or Expression with resultType string).

Share via

Data Flow Debug Session - Add Data Flow

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

DataFlowDebugSession_AddDataFlow

Sample request

Sample response

Definitions

AddDataFlowToDebugSessionResponse

AmazonMWSLinkedService

AmazonMWSObjectDataset

AmazonRdsForOracleAuthenticationType

AmazonRdsForOracleLinkedService

AmazonRdsForOracleTableDataset

AmazonRdsForSqlAuthenticationType

AmazonRdsForSqlServerLinkedService

AmazonRdsForSqlServerTableDataset

AmazonRedshiftLinkedService

AmazonRedshiftTableDataset

AmazonS3CompatibleLinkedService

AmazonS3Dataset

AmazonS3LinkedService

AppFiguresLinkedService

AsanaLinkedService

AvroDataset

AzureBatchLinkedService

AzureBlobDataset

AzureBlobFSDataset

AzureBlobFSLinkedService

AzureBlobStorageLinkedService

AzureDatabricksDeltaLakeDataset

AzureDatabricksDeltaLakeLinkedService

AzureDatabricksLinkedService

AzureDataExplorerLinkedService

AzureDataExplorerTableDataset

AzureDataLakeAnalyticsLinkedService

AzureDataLakeStoreDataset

AzureDataLakeStoreLinkedService

AzureFileStorageLinkedService

AzureFunctionLinkedService

AzureKeyVaultLinkedService

AzureKeyVaultSecretReference

AzureMariaDBLinkedService

AzureMariaDBTableDataset

AzureMLLinkedService

AzureMLServiceLinkedService

AzureMySqlLinkedService

AzureMySqlTableDataset

AzurePostgreSqlLinkedService

AzurePostgreSqlTableDataset

AzureSearchIndexDataset

AzureSearchLinkedService

AzureSqlDatabaseAuthenticationType

AzureSqlDatabaseLinkedService

AzureSqlDWAuthenticationType

AzureSqlDWLinkedService

AzureSqlDWTableDataset

AzureSqlMIAuthenticationType

AzureSqlMILinkedService

AzureSqlMITableDataset

AzureSqlTableDataset

AzureStorageAuthenticationType

AzureStorageLinkedService

AzureSynapseArtifactsLinkedService

AzureTableDataset

AzureTableStorageLinkedService

BinaryDataset

CassandraLinkedService

CassandraTableDataset

CloudError

CommonDataServiceForAppsEntityDataset

CommonDataServiceForAppsLinkedService

ConcurLinkedService

ConcurObjectDataset

CosmosDbConnectionMode