Linked Services - Create Or Update

Service:

Data Factory

API Version:

2018-06-01

Creates or updates a linked service.

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

URI Parameters

Name	In	Required	Type	Description
factoryName	path	True	string	The factory name. Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
linkedServiceName	path	True	string	The linked service name. Regex pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$
resourceGroupName	path	True	string	The resource group name. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The API version.

Request Header

Name	Required	Type	Description
If-Match		string	ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Request Body

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

Responses

Name	Type	Description
200 OK	LinkedServiceResource	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

LinkedServices_Create

LinkedServices_Update

LinkedServices_Create

Sample Request

HTTP

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

{
  "properties": {
    "type": "AzureStorage",
    "typeProperties": {
      "connectionString": {
        "type": "SecureString",
        "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>"
      }
    }
  }
}

Java

import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.datafactory.models.AzureStorageLinkedService;
import java.io.IOException;

/**
 * Samples for LinkedServices CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Create
     * .json
     */
    /**
     * Sample code: LinkedServices_Create.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void linkedServicesCreate(com.azure.resourcemanager.datafactory.DataFactoryManager manager)
        throws IOException {
        manager.linkedServices().define("exampleLinkedService")
            .withExistingFactory("exampleResourceGroup", "exampleFactoryName")
            .withProperties(new AzureStorageLinkedService()
                .withConnectionString(SerializerFactory.createDefaultManagementSerializerAdapter().deserialize(
                    "{\"type\":\"SecureString\",\"value\":\"DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>\"}",
                    Object.class, SerializerEncoding.JSON)))
            .create();
    }
}

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

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python linked_services_create.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.linked_services.create_or_update(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        linked_service_name="exampleLinkedService",
        linked_service={
            "properties": {
                "type": "AzureStorage",
                "typeProperties": {
                    "connectionString": {
                        "type": "SecureString",
                        "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>",
                    }
                },
            }
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Create.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

Go

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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Create.json
func ExampleLinkedServicesClient_CreateOrUpdate_linkedServicesCreate() {
	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.NewLinkedServicesClient().CreateOrUpdate(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleLinkedService", armdatafactory.LinkedServiceResource{
		Properties: &armdatafactory.AzureStorageLinkedService{
			Type: to.Ptr("AzureStorage"),
			TypeProperties: &armdatafactory.AzureStorageLinkedServiceTypeProperties{
				ConnectionString: map[string]any{
					"type":  "SecureString",
					"value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>",
				},
			},
		},
	}, &armdatafactory.LinkedServicesClientCreateOrUpdateOptions{IfMatch: 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.LinkedServiceResource = armdatafactory.LinkedServiceResource{
	// 	Name: to.Ptr("exampleLinkedService"),
	// 	Type: to.Ptr("Microsoft.DataFactory/factories/linkedservices"),
	// 	Etag: to.Ptr("0a0062d4-0000-0000-0000-5b245bcf0000"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService"),
	// 	Properties: &armdatafactory.AzureStorageLinkedService{
	// 		Type: to.Ptr("AzureStorage"),
	// 		TypeProperties: &armdatafactory.AzureStorageLinkedServiceTypeProperties{
	// 			ConnectionString: map[string]any{
	// 				"type": "SecureString",
	// 				"value": "**********",
	// 			},
	// 			EncryptedCredential: to.Ptr("ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfM2FiMTk0NjYtNWUxNi00NzU1LWJlNzktMjI2ZTVmZWU3YzY0Ig0KfQ=="),
	// 		},
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Creates or updates a linked service.
 *
 * @summary Creates or updates a linked service.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Create.json
 */
async function linkedServicesCreate() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const linkedServiceName = "exampleLinkedService";
  const linkedService = {
    properties: {
      type: "AzureStorage",
      connectionString: {
        type: "SecureString",
        value:
          "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.linkedServices.createOrUpdate(
    resourceGroupName,
    factoryName,
    linkedServiceName,
    linkedService,
  );
  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

dotnet

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

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Create.json
// this example is just showing the usage of "LinkedServices_CreateOrUpdate" 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);

// get the collection of this DataFactoryLinkedServiceResource
DataFactoryLinkedServiceCollection collection = dataFactory.GetDataFactoryLinkedServices();

// invoke the operation
string linkedServiceName = "exampleLinkedService";
DataFactoryLinkedServiceData data = new DataFactoryLinkedServiceData(new AzureStorageLinkedService()
{
    ConnectionString = DataFactoryElement<string>.FromSecretString("DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>"),
});
ArmOperation<DataFactoryLinkedServiceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, linkedServiceName, data);
DataFactoryLinkedServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataFactoryLinkedServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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:37:34 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1196
x-ms-request-id: b3b336b3-b203-4654-9cb6-a3a8d3a4b5de
x-ms-correlation-request-id: b3b336b3-b203-4654-9cb6-a3a8d3a4b5de

Response Body

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService",
  "name": "exampleLinkedService",
  "type": "Microsoft.DataFactory/factories/linkedservices",
  "properties": {
    "type": "AzureStorage",
    "typeProperties": {
      "connectionString": {
        "type": "SecureString",
        "value": "**********"
      },
      "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfM2FiMTk0NjYtNWUxNi00NzU1LWJlNzktMjI2ZTVmZWU3YzY0Ig0KfQ=="
    }
  },
  "etag": "0a0062d4-0000-0000-0000-5b245bcf0000"
}

LinkedServices_Update

Sample Request

HTTP

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

{
  "properties": {
    "type": "AzureStorage",
    "typeProperties": {
      "connectionString": {
        "type": "SecureString",
        "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>"
      }
    },
    "description": "Example description"
  }
}

Java

import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.datafactory.models.AzureStorageLinkedService;
import com.azure.resourcemanager.datafactory.models.LinkedServiceResource;
import java.io.IOException;

/**
 * Samples for LinkedServices CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Update
     * .json
     */
    /**
     * Sample code: LinkedServices_Update.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void linkedServicesUpdate(com.azure.resourcemanager.datafactory.DataFactoryManager manager)
        throws IOException {
        LinkedServiceResource resource = manager.linkedServices().getWithResponse("exampleResourceGroup",
            "exampleFactoryName", "exampleLinkedService", null, com.azure.core.util.Context.NONE).getValue();
        resource.update().withProperties(new AzureStorageLinkedService().withDescription("Example description")
            .withConnectionString(SerializerFactory.createDefaultManagementSerializerAdapter().deserialize(
                "{\"type\":\"SecureString\",\"value\":\"DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>\"}",
                Object.class, SerializerEncoding.JSON)))
            .apply();
    }
}

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

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python linked_services_update.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.linked_services.create_or_update(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        linked_service_name="exampleLinkedService",
        linked_service={
            "properties": {
                "description": "Example description",
                "type": "AzureStorage",
                "typeProperties": {
                    "connectionString": {
                        "type": "SecureString",
                        "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>",
                    }
                },
            }
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Update.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

Go

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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Update.json
func ExampleLinkedServicesClient_CreateOrUpdate_linkedServicesUpdate() {
	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.NewLinkedServicesClient().CreateOrUpdate(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleLinkedService", armdatafactory.LinkedServiceResource{
		Properties: &armdatafactory.AzureStorageLinkedService{
			Type:        to.Ptr("AzureStorage"),
			Description: to.Ptr("Example description"),
			TypeProperties: &armdatafactory.AzureStorageLinkedServiceTypeProperties{
				ConnectionString: map[string]any{
					"type":  "SecureString",
					"value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>",
				},
			},
		},
	}, &armdatafactory.LinkedServicesClientCreateOrUpdateOptions{IfMatch: 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.LinkedServiceResource = armdatafactory.LinkedServiceResource{
	// 	Name: to.Ptr("exampleLinkedService"),
	// 	Type: to.Ptr("Microsoft.DataFactory/factories/linkedservices"),
	// 	Etag: to.Ptr("0a0064d4-0000-0000-0000-5b245bd00000"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService"),
	// 	Properties: &armdatafactory.AzureStorageLinkedService{
	// 		Type: to.Ptr("AzureStorage"),
	// 		Description: to.Ptr("Example description"),
	// 		TypeProperties: &armdatafactory.AzureStorageLinkedServiceTypeProperties{
	// 			ConnectionString: map[string]any{
	// 				"type": "SecureString",
	// 				"value": "**********",
	// 			},
	// 			EncryptedCredential: to.Ptr("ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfMGI2M2EyMmYtMGEzNC00NDg2LWIzMDktNzM0NTlkODUyY2Q1Ig0KfQ=="),
	// 		},
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Creates or updates a linked service.
 *
 * @summary Creates or updates a linked service.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Update.json
 */
async function linkedServicesUpdate() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const linkedServiceName = "exampleLinkedService";
  const linkedService = {
    properties: {
      type: "AzureStorage",
      description: "Example description",
      connectionString: {
        type: "SecureString",
        value:
          "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.linkedServices.createOrUpdate(
    resourceGroupName,
    factoryName,
    linkedServiceName,
    linkedService,
  );
  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

dotnet

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

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Update.json
// this example is just showing the usage of "LinkedServices_CreateOrUpdate" 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);

// get the collection of this DataFactoryLinkedServiceResource
DataFactoryLinkedServiceCollection collection = dataFactory.GetDataFactoryLinkedServices();

// invoke the operation
string linkedServiceName = "exampleLinkedService";
DataFactoryLinkedServiceData data = new DataFactoryLinkedServiceData(new AzureStorageLinkedService()
{
    ConnectionString = DataFactoryElement<string>.FromSecretString("DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>"),
    Description = "Example description",
});
ArmOperation<DataFactoryLinkedServiceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, linkedServiceName, data);
DataFactoryLinkedServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataFactoryLinkedServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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:37:36 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1195
x-ms-request-id: 53ad9761-ecdf-43ed-916f-878a5fb92cb0
x-ms-correlation-request-id: 53ad9761-ecdf-43ed-916f-878a5fb92cb0

Response Body

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService",
  "name": "exampleLinkedService",
  "type": "Microsoft.DataFactory/factories/linkedservices",
  "properties": {
    "type": "AzureStorage",
    "typeProperties": {
      "connectionString": {
        "type": "SecureString",
        "value": "**********"
      },
      "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfMGI2M2EyMmYtMGEzNC00NDg2LWIzMDktNzM0NTlkODUyY2Q1Ig0KfQ=="
    },
    "description": "Example description"
  },
  "etag": "0a0064d4-0000-0000-0000-5b245bd00000"
}

Definitions

Name	Description
AmazonMWSLinkedService	Amazon Marketplace Web Service linked service.
AmazonRdsForOracleLinkedService	AmazonRdsForOracle database.
AmazonRdsForSqlAuthenticationType	The type used for authentication. Type: string.
AmazonRdsForSqlServerLinkedService	Amazon RDS for SQL Server linked service.
AmazonRedshiftLinkedService	Linked service for Amazon Redshift.
AmazonS3CompatibleLinkedService	Linked service for Amazon S3 Compatible.
AmazonS3LinkedService	Linked service for Amazon S3.
AppFiguresLinkedService	Linked service for AppFigures.
AsanaLinkedService	Linked service for Asana.
AzureBatchLinkedService	Azure Batch linked service.
AzureBlobFSLinkedService	Azure Data Lake Storage Gen2 linked service.
AzureBlobStorageLinkedService	The azure blob storage linked service.
AzureDatabricksDeltaLakeLinkedService	Azure Databricks Delta Lake linked service.
AzureDatabricksLinkedService	Azure Databricks linked service.
AzureDataExplorerLinkedService	Azure Data Explorer (Kusto) linked service.
AzureDataLakeAnalyticsLinkedService	Azure Data Lake Analytics linked service.
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.
AzureMLLinkedService	Azure ML Studio Web Service linked service.
AzureMLServiceLinkedService	Azure ML Service linked service.
AzureMySqlLinkedService	Azure MySQL database linked service.
AzurePostgreSqlLinkedService	Azure PostgreSQL linked service.
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.
AzureSqlMIAuthenticationType	The type used for authentication. Type: string.
AzureSqlMILinkedService	Azure SQL Managed Instance linked service.
AzureStorageAuthenticationType	The type used for authentication. Type: string.
AzureStorageLinkedService	The storage account linked service.
AzureSynapseArtifactsLinkedService	Azure Synapse Analytics (Artifacts) linked service.
AzureTableStorageLinkedService	The azure table storage linked service.
CassandraLinkedService	Linked service for Cassandra data source.
CloudError	The object that defines the structure of an Azure Data Factory error response.
CommonDataServiceForAppsLinkedService	Common Data Service for Apps linked service.
ConcurLinkedService	Concur Service linked service.
CosmosDbConnectionMode	The connection mode used to access CosmosDB account. Type: string.
CosmosDbLinkedService	Microsoft Azure Cosmos Database (CosmosDB) linked service.
CosmosDbMongoDbApiLinkedService	Linked service for CosmosDB (MongoDB API) data source.
CouchbaseLinkedService	Couchbase server linked service.
CredentialReference	Credential reference type.
CredentialReferenceType	Credential reference type.
CustomDataSourceLinkedService	Custom linked service.
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.
DrillLinkedService	Drill server linked service.
DynamicsAXLinkedService	Dynamics AX linked service.
DynamicsCrmLinkedService	Dynamics CRM linked service.
DynamicsLinkedService	Dynamics linked service.
EloquaLinkedService	Eloqua server linked service.
FileServerLinkedService	File system linked service.
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.
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.
GoogleBigQueryV2AuthenticationType	The OAuth 2.0 authentication mechanism used for authentication.
GoogleBigQueryV2LinkedService	Google BigQuery service linked service.
GoogleCloudStorageLinkedService	Linked service for Google Cloud Storage.
GoogleSheetsLinkedService	Linked service for GoogleSheets.
GreenplumLinkedService	Greenplum Database linked service.
HBaseAuthenticationType	The authentication mechanism to use to connect to the HBase server.
HBaseLinkedService	HBase server linked service.
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.
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.
HttpLinkedService	Linked service for an HTTP source.
HubspotLinkedService	Hubspot Service linked service.
ImpalaAuthenticationType	The authentication type to use.
ImpalaLinkedService	Impala server linked service.
InformixLinkedService	Informix linked service.
IntegrationRuntimeReference	Integration runtime reference type.
JiraLinkedService	Jira Service linked service.
LakeHouseLinkedService	Microsoft Fabric LakeHouse linked service.
LinkedServiceReference	Linked service reference type.
LinkedServiceResource	Linked service resource type.
MagentoLinkedService	Magento server linked service.
MariaDBLinkedService	MariaDB server linked service.
MarketoLinkedService	Marketo server linked service.
MicrosoftAccessLinkedService	Microsoft Access linked service.
MongoDbAtlasLinkedService	Linked service for MongoDB Atlas data source.
MongoDbAuthenticationType	The authentication type to be used to connect to the MongoDB database.
MongoDbLinkedService	Linked service for MongoDb data source.
MongoDbV2LinkedService	Linked service for MongoDB data source.
MySqlLinkedService	Linked service for MySQL data source.
NetezzaLinkedService	Netezza linked service.
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.
OdbcLinkedService	Open Database Connectivity (ODBC) linked service.
Office365LinkedService	Office365 linked service.
OracleCloudStorageLinkedService	Linked service for Oracle Cloud Storage.
OracleLinkedService	Oracle database.
OracleServiceCloudLinkedService	Oracle Service Cloud linked service.
ParameterSpecification	Definition of a single parameter for an entity.
ParameterType	Parameter type.
PaypalLinkedService	Paypal Service linked service.
PhoenixAuthenticationType	The authentication mechanism used to connect to the Phoenix server.
PhoenixLinkedService	Phoenix server linked service.
PostgreSqlLinkedService	Linked service for PostgreSQL data source.
PostgreSqlV2LinkedService	Linked service for PostgreSQLV2 data source.
PrestoAuthenticationType	The authentication mechanism used to connect to the Presto server.
PrestoLinkedService	Presto server linked service.
QuickbaseLinkedService	Linked service for Quickbase.
QuickBooksLinkedService	QuickBooks server linked service.
ResponsysLinkedService	Responsys linked service.
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.
SalesforceServiceCloudLinkedService	Linked service for Salesforce Service Cloud.
SalesforceServiceCloudV2LinkedService	Linked service for Salesforce Service Cloud V2.
SalesforceV2LinkedService	Linked service for Salesforce V2.
SapBWLinkedService	SAP Business Warehouse Linked Service.
SapCloudForCustomerLinkedService	Linked service for SAP Cloud for Customer.
SapEccLinkedService	Linked service for SAP ERP Central Component(SAP ECC).
SapHanaAuthenticationType	The authentication type to be used to connect to the SAP HANA server.
SapHanaLinkedService	SAP HANA Linked Service.
SapOdpLinkedService	SAP ODP Linked Service.
SapOpenHubLinkedService	SAP Business Warehouse Open Hub Destination Linked Service.
SapTableLinkedService	SAP Table Linked Service.
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.
ServiceNowV2AuthenticationType	The authentication type to use.
ServiceNowV2LinkedService	ServiceNowV2 server linked service.
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.
ShopifyLinkedService	Shopify Service linked service.
SmartsheetLinkedService	Linked service for Smartsheet.
SnowflakeAuthenticationType	The type used for authentication. Type: string.
SnowflakeLinkedService	Snowflake linked service.
SnowflakeV2LinkedService	Snowflake linked service.
SparkAuthenticationType	The authentication method used to access the Spark server.
SparkLinkedService	Spark Server linked service.
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.
SquareLinkedService	Square Service linked service.
SybaseAuthenticationType	AuthenticationType to be used for connection.
SybaseLinkedService	Linked service for Sybase data source.
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.
TwilioLinkedService	Linked service for Twilio.
Type	Linked service reference type.
VerticaLinkedService	Vertica linked service.
WarehouseLinkedService	Microsoft Fabric Warehouse linked service.
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.
XeroLinkedService	Xero Service linked service.
ZendeskAuthenticationType	The authentication type to use.
ZendeskLinkedService	Linked service for Zendesk.
ZohoLinkedService	Zoho server linked service.

AmazonMWSLinkedService

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.

AmazonRdsForOracleLinkedService

AmazonRdsForOracle database.

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.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	SecretBase: AzureKeyVaultSecretReference SecureString	The Azure key vault secret reference of password in connection string.

AmazonRdsForSqlAuthenticationType

The type used for authentication. Type: string.

Name	Type	Description
SQL	string
Windows	string

AmazonRdsForSqlServerLinkedService

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).

AmazonRedshiftLinkedService

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).

AmazonS3CompatibleLinkedService

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).

AmazonS3LinkedService

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.

AppFiguresLinkedService

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).

AsanaLinkedService

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.

AzureBatchLinkedService

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).

AzureBlobFSLinkedService

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).

AzureBlobStorageLinkedService

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).

AzureDatabricksDeltaLakeLinkedService

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).

AzureDatabricksLinkedService

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.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).

AzureDataExplorerLinkedService

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).

AzureDataLakeAnalyticsLinkedService

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).

AzureDataLakeStoreLinkedService

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).

AzureFileStorageLinkedService

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.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.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).

AzureFunctionLinkedService

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).

AzureKeyVaultLinkedService

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.

AzureKeyVaultSecretReference

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

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.

AzureMLLinkedService

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).

AzureMLServiceLinkedService

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).

AzureMySqlLinkedService

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.

AzurePostgreSqlLinkedService

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.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.password	AzureKeyVaultSecretReference	The Azure key vault secret reference of password in connection string.

AzureSearchLinkedService

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).

AzureSqlDatabaseAuthenticationType

The type used for authentication. Type: string.

Name	Type	Description
SQL	string
ServicePrincipal	string
SystemAssignedManagedIdentity	string
UserAssignedManagedIdentity	string

AzureSqlDatabaseLinkedService

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).

AzureSqlDWAuthenticationType

The type used for authentication. Type: string.

Name	Type	Description
SQL	string
ServicePrincipal	string
SystemAssignedManagedIdentity	string
UserAssignedManagedIdentity	string

AzureSqlDWLinkedService

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).

AzureSqlMIAuthenticationType

The type used for authentication. Type: string.

Name	Type	Description
SQL	string
ServicePrincipal	string
SystemAssignedManagedIdentity	string
UserAssignedManagedIdentity	string

AzureSqlMILinkedService

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).

AzureStorageAuthenticationType

The type used for authentication. Type: string.

Name	Type	Description
AccountKey	string
Anonymous	string
Msi	string
SasUri	string
ServicePrincipal	string

AzureStorageLinkedService

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.

AzureSynapseArtifactsLinkedService

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).

AzureTableStorageLinkedService

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.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.

CassandraLinkedService

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).

CloudError

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.

CommonDataServiceForAppsLinkedService

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. 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.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).

ConcurLinkedService

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.

CosmosDbConnectionMode

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

Name	Type	Description
Direct	string
Gateway	string

CosmosDbLinkedService

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).

CosmosDbMongoDbApiLinkedService

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).

CouchbaseLinkedService

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.

CredentialReference

Credential reference type.

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

CredentialReferenceType

Credential reference type.

Name	Type	Description
CredentialReference	string

CustomDataSourceLinkedService

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.

DataworldLinkedService

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.

Db2AuthenticationType

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

Name	Type	Description
Basic	string

Db2LinkedService

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).

DrillLinkedService

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.

DynamicsAXLinkedService

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.

DynamicsCrmLinkedService

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. Type: string (or Expression with resultType string).
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.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).

DynamicsLinkedService

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. 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.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).

EloquaLinkedService

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)

FileServerLinkedService

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).

FtpAuthenticationType

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

Name	Type	Description
Anonymous	string
Basic	string

FtpServerLinkedService

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).

GoogleAdWordsAuthenticationType

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

Name	Type	Description
ServiceAuthentication	string
UserAuthentication	string

GoogleAdWordsLinkedService

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).

GoogleBigQueryAuthenticationType

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

Name	Type	Description
ServiceAuthentication	string
UserAuthentication	string

GoogleBigQueryLinkedService

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).

GoogleBigQueryV2AuthenticationType

The OAuth 2.0 authentication mechanism used for authentication.

Name	Type	Description
ServiceAuthentication	string
UserAuthentication	string

GoogleBigQueryV2LinkedService

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.

GoogleCloudStorageLinkedService

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).

GoogleSheetsLinkedService

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.

GreenplumLinkedService

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.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.

HBaseAuthenticationType

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

Name	Type	Description
Anonymous	string
Basic	string

HBaseLinkedService

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.

HdfsLinkedService

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).

HDInsightLinkedService

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).

HDInsightOnDemandLinkedService

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.

HiveAuthenticationType

The authentication method used to access the Hive server.

Name	Type	Description
Anonymous	string
Username	string
UsernameAndPassword	string
WindowsAzureHDInsightService	string

HiveLinkedService

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.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.

HiveServerType

The type of Hive server.

Name	Type	Description
HiveServer1	string
HiveServer2	string
HiveThriftServer	string

HiveThriftTransportProtocol

The transport protocol to use in the Thrift layer.

Name	Type	Description
Binary	string
HTTP	string
SASL	string

HttpAuthenticationType

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

Name	Type	Description
Anonymous	string
Basic	string
ClientCertificate	string
Digest	string
Windows	string

HttpLinkedService

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).

HubspotLinkedService

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.

ImpalaAuthenticationType

The authentication type to use.

Name	Type	Description
Anonymous	string
SASLUsername	string
UsernameAndPassword	string

ImpalaLinkedService

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.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.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.

InformixLinkedService

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).

IntegrationRuntimeReference

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

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.

LakeHouseLinkedService

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).

LinkedServiceReference

Linked service reference type.

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

LinkedServiceResource

Linked service resource type.

Name	Type	Description
etag	string	Etag identifies change in the resource.
id	string	The resource identifier.
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.
type	string	The resource type.

MagentoLinkedService

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.

MariaDBLinkedService

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.
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.username	object	Username for authentication. Type: string.

MarketoLinkedService

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.

MicrosoftAccessLinkedService

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).

MongoDbAtlasLinkedService

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).

MongoDbAuthenticationType

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

Name	Type	Description
Anonymous	string
Basic	string

MongoDbLinkedService

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).

MongoDbV2LinkedService

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).

MySqlLinkedService

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.connectionString	object	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
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.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	SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full.
typeProperties.useSystemTrustStore	object	Use system trust store for connection. Type: integer. 0: enable, 1: disable.
typeProperties.username	object	Username for authentication. Type: string.

NetezzaLinkedService

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.

ODataAadServicePrincipalCredentialType

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

Name	Type	Description
ServicePrincipalCert	string
ServicePrincipalKey	string

ODataAuthenticationType

Type of authentication used to connect to the OData service.

Name	Type	Description
AadServicePrincipal	string
Anonymous	string
Basic	string
ManagedServiceIdentity	string
Windows	string

ODataLinkedService

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).

OdbcLinkedService

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).

Office365LinkedService

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.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).

OracleCloudStorageLinkedService

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).

OracleLinkedService

Oracle database.

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.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.

OracleServiceCloudLinkedService

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.

ParameterSpecification

Definition of a single parameter for an entity.

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

ParameterType

Parameter type.

Name	Type	Description
Array	string
Bool	string
Float	string
Int	string
Object	string
SecureString	string
String	string

PaypalLinkedService

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.

PhoenixAuthenticationType

The authentication mechanism used to connect to the Phoenix server.

Name	Type	Description
Anonymous	string
UsernameAndPassword	string
WindowsAzureHDInsightService	string

PhoenixLinkedService

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.

PostgreSqlLinkedService

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.

PostgreSqlV2LinkedService

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.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.

PrestoAuthenticationType

The authentication mechanism used to connect to the Presto server.

Name	Type	Description
Anonymous	string
LDAP	string

PrestoLinkedService

Presto 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: 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.
typeProperties.allowSelfSignedServerCert	object	Specifies whether to allow self-signed certificates from the server. The default value is false.
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.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 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.
typeProperties.serverVersion	object	The version of the Presto server. (i.e. 0.148-t)
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 is the system time zone.
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 Presto server.

QuickbaseLinkedService

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.

QuickBooksLinkedService

QuickBooks 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: QuickBooks	Type of linked service.
typeProperties.accessToken	SecretBase: AzureKeyVaultSecretReference SecureString	The access token for OAuth 1.0 authentication.
typeProperties.accessTokenSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The access token secret for OAuth 1.0 authentication.
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 1.0 authentication.
typeProperties.consumerSecret	SecretBase: AzureKeyVaultSecretReference SecureString	The consumer secret for OAuth 1.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.useEncryptedEndpoints	object	Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

ResponsysLinkedService

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).

RestServiceAuthenticationType

Type of authentication used to connect to the REST service.

Name	Type	Description
AadServicePrincipal	string
Anonymous	string
Basic	string
ManagedServiceIdentity	string
OAuth2ClientCredential	string

RestServiceLinkedService

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.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).

SalesforceLinkedService

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).

SalesforceMarketingCloudLinkedService

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).

SalesforceServiceCloudLinkedService

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).

SalesforceServiceCloudV2LinkedService

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).

SalesforceV2LinkedService

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).

SapBWLinkedService

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).

SapCloudForCustomerLinkedService

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).

SapEccLinkedService

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).

SapHanaAuthenticationType

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

Name	Type	Description
Basic	string
Windows	string

SapHanaLinkedService

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).

SapOdpLinkedService

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 indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).
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).

SapOpenHubLinkedService

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).

SapTableLinkedService

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 indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).
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).

ScriptAction

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

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

The authentication type to use.

Name	Type	Description
Basic	string
OAuth2	string

ServiceNowLinkedService

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.

ServiceNowV2AuthenticationType

The authentication type to use.

Name	Type	Description
Basic	string
OAuth2	string

ServiceNowV2LinkedService

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.

SftpAuthenticationType

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

Name	Type	Description
Basic	string
MultiFactor	string
SshPublicKey	string

SftpServerLinkedService

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).

SharePointOnlineListLinkedService

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.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).

ShopifyLinkedService

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.

SmartsheetLinkedService

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.

SnowflakeAuthenticationType

The type used for authentication. Type: string.

Name	Type	Description
AADServicePrincipal	string
Basic	string
KeyPair	string

SnowflakeLinkedService

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.

SnowflakeV2LinkedService

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.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.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.

SparkAuthenticationType

The authentication method used to access the Spark server.

Name	Type	Description
Anonymous	string
Username	string
UsernameAndPassword	string
WindowsAzureHDInsightService	string

SparkLinkedService

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.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.

SparkServerType

The type of Spark server.

Name	Type	Description
SharkServer	string
SharkServer2	string
SparkThriftServer	string

SparkThriftTransportProtocol

The transport protocol to use in the Thrift layer.

Name	Type	Description
Binary	string
HTTP	string
SASL	string

SqlAlwaysEncryptedAkvAuthType

Sql always encrypted AKV authentication type. Type: string.

Name	Type	Description
ManagedIdentity	string
ServicePrincipal	string
UserAssignedManagedIdentity	string

SqlAlwaysEncryptedProperties

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

The type used for authentication. Type: string.

Name	Type	Description
SQL	string
Windows	string

SqlServerLinkedService

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.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).

SquareLinkedService

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.

SybaseAuthenticationType

AuthenticationType to be used for connection.

Name	Type	Description
Basic	string
Windows	string

SybaseLinkedService

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).

TeamDeskAuthenticationType

The authentication type to use.

Name	Type	Description
Basic	string
Token	string

TeamDeskLinkedService

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).

TeradataAuthenticationType

AuthenticationType to be used for connection.

Name	Type	Description
Basic	string
Windows	string

TeradataLinkedService

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.connectionString	object	Teradata 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 for authentication.
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).

TwilioLinkedService

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).

Type

Linked service reference type.

Name	Type	Description
LinkedServiceReference	string

VerticaLinkedService

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.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.

WarehouseLinkedService

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).

WebAnonymousAuthentication

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

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

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

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.

XeroLinkedService

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.

ZendeskAuthenticationType

The authentication type to use.

Name	Type	Description
Basic	string
Token	string

ZendeskLinkedService

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).

ZohoLinkedService

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.